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

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

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

References NAME.

06872                 {
06873                         return NAME;
06874                 }

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

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

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

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

Definition at line 6876 of file processor.h.

06877                 {
06878                         return new FFTProcessor();
06879                 }

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

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

08321 {
08322         if( params.has_key("dir") ) {
08323                 if ((int)params["dir"]==-1) {
08324                         image->do_ift_inplace();
08325                 }
08326                 else {
08327                         image->do_fft_inplace();
08328                 }
08329         }
08330 }


Member Data Documentation

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

Definition at line 6893 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Tue Jun 11 12:44:48 2013 for EMAN2 by  doxygen 1.4.7