Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

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

ProcessorNEW ()

Static Public Attributes

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

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

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

06661                 {
06662                         return NAME;
06663                 }

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

References EMAN::TypeDict::put().

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

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

Definition at line 6665 of file processor.h.

06666                 {
06667                         return new FFTProcessor();
06668                 }

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

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

08053 {
08054         if( params.has_key("dir") ) {
08055                 if ((int)params["dir"]==-1) {
08056                         image->do_ift_inplace();
08057                 }
08058                 else {
08059                         image->do_fft_inplace();
08060                 }
08061         }
08062 }


Member Data Documentation

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

Definition at line 212 of file processor.cpp.


The documentation for this class was generated from the following files:
Generated on Mon Mar 7 18:18:04 2011 for EMAN2 by  doxygen 1.3.9.1