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:

Inheritance graph
[legend]
Collaboration diagram for EMAN::FFTProcessor:

Collaboration graph
[legend]
List of all members.

Public Member Functions

void process_inplace (EMData *image)
 To process an image in-place.
string get_name () const
 Get the processor's name.
TypeDict get_param_types () const
 Get processor parameter information in a dictionary.
string get_desc () const
 Get the descrition of this specific processor.

Static Public Member Functions

static ProcessorNEW ()

Static Public Attributes

static const string NAME = "basis.fft"

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 6780 of file processor.h.


Member Function Documentation

string EMAN::FFTProcessor::get_desc (  )  const [inline, virtual]

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 6802 of file processor.h.

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

string EMAN::FFTProcessor::get_name (  )  const [inline, virtual]

Get the processor's name.

Each processor is identified by a unique name.

Returns:
The processor's name.

Implements EMAN::Processor.

Definition at line 6785 of file processor.h.

References NAME.

06786                 {
06787                         return NAME;
06788                 }

TypeDict EMAN::FFTProcessor::get_param_types (  )  const [inline, virtual]

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 6795 of file processor.h.

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

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

static Processor* EMAN::FFTProcessor::NEW (  )  [inline, static]

Definition at line 6790 of file processor.h.

06791                 {
06792                         return new FFTProcessor();
06793                 }

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 8168 of file processor.cpp.

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

08169 {
08170         if( params.has_key("dir") ) {
08171                 if ((int)params["dir"]==-1) {
08172                         image->do_ift_inplace();
08173                 }
08174                 else {
08175                         image->do_fft_inplace();
08176                 }
08177         }
08178 }


Member Data Documentation

const string FFTProcessor::NAME = "basis.fft" [static]

Definition at line 6807 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Thu Nov 17 12:47:04 2011 for EMAN2 by  doxygen 1.4.7