Determines the partial derivatives in the x direction Does this by constructing edge kernels in real space but convoluting in Fourier space. More...

#include <processor.h>

Inheritance diagram for EMAN::XGradientProcessor:

[legend]

Collaboration diagram for EMAN::XGradientProcessor:

[legend]

Public Member Functions
	XGradientProcessor ()

string	get_name () const
	Get the processor's name. More...

void	process_inplace (EMData *image)
	To process an image in-place. More...

string	get_desc () const
	Get the descrition of this specific processor. More...

TypeDict	get_param_types () const
	Get processor parameter information in a dictionary. More...

Public Member Functions inherited from EMAN::Processor
virtual	~Processor ()

virtual EMData *	process (const EMData *const image)
	To proccess an image out-of-place. More...

virtual void	process_list_inplace (vector< EMData * > &images)
	To process multiple images using the same algorithm. More...

virtual Dict	get_params () const
	Get the processor parameters in a key/value dictionary. More...

virtual void	set_params (const Dict &new_params)
	Set the processor parameters using a key/value dictionary. More...

Static Public Member Functions
static Processor *	NEW ()

Static Public Member Functions inherited from EMAN::Processor
static string	get_group_desc ()
	Get the description of this group of processors. More...

static void	EMFourierFilterInPlace (EMData *fimage, Dict params)
	Compute a Fourier-filter processed image in place. More...

static EMData *	EMFourierFilter (EMData *fimage, Dict params)
	Compute a Fourier-processor processed image without altering the original image. More...

Static Public Attributes
static const string	NAME = "math.edge.xgradient"

Additional Inherited Members
Public Types inherited from EMAN::Processor
enum	fourier_filter_types { TOP_HAT_LOW_PASS , TOP_HAT_HIGH_PASS , TOP_HAT_BAND_PASS , TOP_HOMOMORPHIC , GAUSS_LOW_PASS , GAUSS_HIGH_PASS , GAUSS_BAND_PASS , GAUSS_INVERSE , GAUSS_HOMOMORPHIC , BUTTERWORTH_LOW_PASS , BUTTERWORTH_HIGH_PASS , BUTTERWORTH_HOMOMORPHIC , KAISER_I0 , KAISER_SINH , KAISER_I0_INVERSE , KAISER_SINH_INVERSE , SHIFT , TANH_LOW_PASS , TANH_HIGH_PASS , TANH_HOMOMORPHIC , TANH_BAND_PASS , RADIAL_TABLE , CTF_ }
	Fourier filter Processor type enum. More...

Protected Attributes inherited from EMAN::Processor
Dict	params

Detailed Description

Determines the partial derivatives in the x direction Does this by constructing edge kernels in real space but convoluting in Fourier space.

Author: David Woolford

Date: 2007/12/04

Definition at line 877 of file processor.h.

Constructor & Destructor Documentation

◆ XGradientProcessor()

EMAN::XGradientProcessor::XGradientProcessor ( )

inline

Definition at line 880 of file processor.h.

880{}

Referenced by NEW().

Member Function Documentation

◆ get_desc()

string EMAN::XGradientProcessor::get_desc ( ) const

inlinevirtual

Get the descrition of this specific processor.

This function must be overwritten by a subclass.

Returns: The description of this processor.

Implements EMAN::Processor.

Definition at line 894 of file processor.h.

                {
                        return "Determines the image gradient in the x direction";
                }

◆ get_name()

string EMAN::XGradientProcessor::get_name ( ) const

inlinevirtual

Get the processor's name.

Each processor is identified by a unique name.

Returns: The processor's name.

Implements EMAN::Processor.

Definition at line 882 of file processor.h.

                {
                        return NAME;
                }

References NAME.

◆ get_param_types()

TypeDict EMAN::XGradientProcessor::get_param_types ( ) const

inlinevirtual

Get processor parameter information in a dictionary.

Each parameter has one record in the dictionary. Each record contains its name, data-type, and description.

Returns: A dictionary containing the parameter info.

Reimplemented from EMAN::Processor.

Definition at line 899 of file processor.h.

                {
                        TypeDict d;
                        return d;
                }

◆ NEW()

static Processor * EMAN::XGradientProcessor::NEW ( )

inlinestatic

Definition at line 889 of file processor.h.

                {
                        return new XGradientProcessor();
                }

References XGradientProcessor().

◆ process_inplace()

void XGradientProcessor::process_inplace ( EMData * image )

virtual

To process an image in-place.

For those processors which can only be processed out-of-place, override this function to just print out some error message to remind user call the out-of-place version.

Parameters

image The image to be processed.

Implements EMAN::Processor.

Definition at line 12696 of file processor.cpp.

{
        if (image->is_complex()) throw ImageFormatException("Cannot edge detect a complex image");
 
        EMData* e = new EMData();
        int nx = image->get_xsize();
        int ny = image->get_ysize();
        int nz = image->get_zsize();
 
        if ( nz == 1 && ny == 1 ) {
                if ( nx < 3 ) throw ImageDimensionException("Error - cannot edge detect an image with less than three pixels");
 
                e->set_size(3,1,1);
                e->set_value_at(0,-1);
                e->set_value_at(2, 1);
 
                Region r = Region(-nx/2+1,nx);
                e->clip_inplace(r);
        } else if ( nz == 1 ) {
                if ( nx < 3 || ny < 3 ) throw ImageDimensionException("Error - cannot edge detect an image with less than three pixels");
                e->set_size(3,3,1);
                e->set_value_at(0,0,-1);
                e->set_value_at(0,1,-2);
                e->set_value_at(0,2,-1);
 
                e->set_value_at(2,0,1);
                e->set_value_at(2,1,2);
                e->set_value_at(2,2,1);
                Region r = Region(-nx/2+1,-ny/2+1,nx,ny);
                e->clip_inplace(r);
        } else {
                if ( nx < 3 || ny < 3 || nz < 3) throw ImageDimensionException("Error - cannot edge detect an image with less than three pixels");
                e->set_size(3,3,3);
                e->set_value_at(0,0,0,-1);
                e->set_value_at(0,1,0,-1);
                e->set_value_at(0,2,0,-1);
                e->set_value_at(0,0,1,-1);
                e->set_value_at(0,1,1,-8);
                e->set_value_at(0,2,1,-1);
                e->set_value_at(0,0,2,-1);
                e->set_value_at(0,1,2,-1);
                e->set_value_at(0,2,2,-1);
 
                e->set_value_at(2,0,0,1);
                e->set_value_at(2,1,0,1);
                e->set_value_at(2,2,0,1);
                e->set_value_at(2,0,1,1);
                e->set_value_at(2,1,1,8);
                e->set_value_at(2,2,1,1);
                e->set_value_at(2,0,2,1);
                e->set_value_at(2,1,2,1);
                e->set_value_at(2,2,2,1);
 
                Region r = Region(-nx/2+1,-ny/2+1,-nz/2+1,nx,ny,nz);
                e->clip_inplace(r);
        }
 
        Dict conv_parms;
        conv_parms["with"] = e;
        image->process_inplace("math.convolution", conv_parms);
        image->process_inplace("xform.phaseorigin.tocenter");
 
        delete e;
}

References EMAN::EMData::clip_inplace(), ImageDimensionException, and ImageFormatException.

Member Data Documentation

◆ NAME

const string XGradientProcessor::NAME = "math.edge.xgradient"

static

Definition at line 905 of file processor.h.

Referenced by get_name().

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XGradientProcessor()

Member Function Documentation

◆ get_desc()

◆ get_name()

◆ get_param_types()

◆ NEW()

◆ process_inplace()

Member Data Documentation

◆ NAME