EMAN::FFTProcessor Class Reference

Perform a FFT transform by calling EMData::do_fft() and EMData::do_ift() More...

#include <processor.h>

Inheritance diagram for EMAN::FFTProcessor:

Collaboration diagram for EMAN::FFTProcessor:

Public Member Functions
void	process_inplace (EMData *image)
	To process an image in-place. More...
string	get_name () const
	Get the processor's name. More...
TypeDict	get_param_types () const
	Get processor parameter information in a dictionary. More...
string	get_desc () const
	Get the descrition of this specific processor. 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 = "basis.fft"

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

Perform a FFT transform by calling EMData::do_fft() and EMData::do_ift()

Parameters

dir	1 for forward transform, -1 for inverse transform, forward transform by default

Definition at line 9105 of file processor.h.

Member Function Documentation

get_desc()

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

                {
                        return "Computes the DFFT (Discrete Fast Fourier Transform) of an image";
                }

get_name()

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

                {
                        return NAME;
                }

References NAME.

get_param_types()

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

                {
                        TypeDict d;
                        d.put("dir", EMObject::INT, "1 for forward transform, -1 for inverse transform");
                        return d;
                }

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

NEW()

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

inlinestatic

Definition at line 9115 of file processor.h.

                {
                        return new FFTProcessor();
                }

process_inplace()

void FFTProcessor::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 10437 of file processor.cpp.

{
        if( params.has_key("dir") ) {
                if ((int)params["dir"]==-1||(image->is_complex() && (int)params["dir"]==0)) {
                        image->do_ift_inplace();
                }
                else {
                        image->do_fft_inplace();
                }
        }
}

References EMAN::Dict::has_key(), and EMAN::Processor::params.

Member Data Documentation

NAME

const string FFTProcessor::NAME = "basis.fft"

static

Definition at line 9132 of file processor.h.

Referenced by get_name().

---

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

• processor.h
• processor.cpp