EMAN::ConvolutionProcessor Class Reference

This processor performs fast convolution in Fourier space. More...

#include <processor.h>

Inheritance diagram for EMAN::ConvolutionProcessor:

Collaboration diagram for EMAN::ConvolutionProcessor:

Public Member Functions
	ConvolutionProcessor ()
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.convolution"

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

This processor performs fast convolution in Fourier space.

Author

David Woolford

Date

2007/12/04

Parameters

with	The image that will convolute the other image

Definition at line 639 of file processor.h.

Constructor & Destructor Documentation

ConvolutionProcessor()

EMAN::ConvolutionProcessor::ConvolutionProcessor ( )

inline

Definition at line 642 of file processor.h.

{}

Referenced by NEW().

Member Function Documentation

get_desc()

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

                        {
                                return "Performs Fourier space convolution. Maintains the space that the image is in - i.e. if image is real, the result is real and vice versa.";
                        }

get_name()

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

                        {
                                return NAME;
                        }

References NAME.

get_param_types()

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

                        {
                                TypeDict d;
                                d.put("with", EMObject::EMDATA, "The image that will convolute the other image");
                                return d;
                        }

References EMAN::EMObject::EMDATA, and EMAN::TypeDict::put().

NEW()

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

inlinestatic

Definition at line 651 of file processor.h.

                        {
                                return new ConvolutionProcessor();
                        }

References ConvolutionProcessor().

process_inplace()

void ConvolutionProcessor::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 12676 of file processor.cpp.

{
        //bool complexflag = false;
        EMData* null = 0;
        EMData* with = params.set_default("with", null);
        if ( with == NULL ) throw InvalidParameterException("Error - the image required for the convolution is null");
 
        EMData* newimage = fourierproduct(image, with, CIRCULANT, CONVOLUTION, false);
 
        float* orig = image->get_data();
        float* work = newimage->get_data();
        int nx  = image->get_xsize();
        int ny  = image->get_ysize();
        int nz  = image->get_zsize();
        memcpy(orig,work,nx*ny*nz*sizeof(float));
        image->update();
 
        delete newimage;
}

References InvalidParameterException, EMAN::Processor::params, and EMAN::Dict::set_default().

Member Data Documentation

NAME

const string ConvolutionProcessor::NAME = "math.convolution"

static

Definition at line 668 of file processor.h.

Referenced by get_name().

---

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

• processor.h
• processor.cpp