EMAN::ZGradientProcessor Class Reference

#include <processor.h>

Inheritance diagram for EMAN::ZGradientProcessor:

Collaboration diagram for EMAN::ZGradientProcessor:

Public Member Functions
	ZGradientProcessor ()
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.zgradient"

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

Definition at line 940 of file processor.h.

Constructor & Destructor Documentation

ZGradientProcessor()

EMAN::ZGradientProcessor::ZGradientProcessor ( )

inline

Definition at line 943 of file processor.h.

{}

Referenced by NEW().

Member Function Documentation

get_desc()

string EMAN::ZGradientProcessor::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 957 of file processor.h.

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

get_name()

string EMAN::ZGradientProcessor::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 945 of file processor.h.

                        {
                                return NAME;
                        }

References NAME.

get_param_types()

TypeDict EMAN::ZGradientProcessor::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 962 of file processor.h.

                        {
                                TypeDict d;
                                return d;
                        }

NEW()

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

inlinestatic

Definition at line 952 of file processor.h.

                        {
                                return new ZGradientProcessor();
                        }

References ZGradientProcessor().

process_inplace()

void ZGradientProcessor::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 12948 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 ( nx < 3 || ny < 3 || nz < 3) throw ImageDimensionException("Error - cannot edge detect in the z direction with any dimension being less than three pixels");
 
        e->set_size(3,3,3);
        e->set_value_at(0,0,0,-1);
        e->set_value_at(1,0,0,-1);
        e->set_value_at(2,0,0,-1);
        e->set_value_at(0,1,0,-1);
        e->set_value_at(1,1,0,-8);
        e->set_value_at(2,1,0,-1);
        e->set_value_at(0,2,0,-1);
        e->set_value_at(1,2,0,-1);
        e->set_value_at(2,2,0,-1);
 
        e->set_value_at(0,0,2,1);
        e->set_value_at(1,0,2,1);
        e->set_value_at(2,0,2,1);
        e->set_value_at(0,1,2,1);
        e->set_value_at(1,1,2,8);
        e->set_value_at(2,1,2,1);
        e->set_value_at(0,2,2,1);
        e->set_value_at(1,2,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 ZGradientProcessor::NAME = "math.edge.zgradient"

static

Definition at line 968 of file processor.h.

Referenced by get_name().

---

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

• processor.h
• processor.cpp