EMAN::SHIFTProcessor Class Reference

Shift by phase multiplication in Fourier space. More...

#include <processor_sparx.h>

Inheritance diagram for EMAN::SHIFTProcessor:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

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

Static Public Member Functions

static ProcessorNEW ()

Static Public Attributes

static const string NAME = "filter.shift"

Detailed Description

Shift by phase multiplication in Fourier space.

Definition at line 370 of file processor_sparx.h.


Member Function Documentation

string EMAN::SHIFTProcessor::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 377 of file processor_sparx.h.

00378                 {
00379                         return "Shift by phase multiplication in Fourier space.";
00380                 }

string EMAN::SHIFTProcessor::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 373 of file processor_sparx.h.

References NAME.

00374                 { return NAME; }

TypeDict EMAN::SHIFTProcessor::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::NewFourierProcessor.

Definition at line 385 of file processor_sparx.h.

References EMAN::EMObject::FLOAT, EMAN::NewFourierProcessor::get_param_types(), and EMAN::TypeDict::put().

00386                 {
00387                         TypeDict d = NewFourierProcessor::get_param_types();
00388                         d.put("x_shift", EMObject::FLOAT, "Shift x");
00389                         d.put("y_shift", EMObject::FLOAT, "Shift y");
00390                         d.put("z_shift", EMObject::FLOAT, "Shift z");
00391                         return d;
00392                 }

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

Definition at line 375 of file processor_sparx.h.

00376                 { return new SHIFTProcessor(); }

void EMAN::SHIFTProcessor::process_inplace ( EMData image  )  [inline, 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 381 of file processor_sparx.h.

References EMAN::Processor::EMFourierFilterInPlace(), EMAN::Processor::params, and EMAN::Processor::SHIFT.

00381                                                     {
00382                         params["filter_type"] = SHIFT;
00383                         EMFourierFilterInPlace(image, params);
00384                 }


Member Data Documentation

const string SHIFTProcessor::NAME = "filter.shift" [static]

Definition at line 394 of file processor_sparx.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Mon Jul 19 12:44:41 2010 for EMAN2 by  doxygen 1.4.7