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

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

ProcessorNEW ()

Static Public Attributes

const string NAME = "filter.shift"

Detailed Description

Shift by phase multiplication in Fourier space.

Definition at line 456 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 463 of file processor_sparx.h.

00464                 {
00465                         return "Shift by phase multiplication in Fourier space.";
00466                 }

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 459 of file processor_sparx.h.

00460                 { 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 471 of file processor_sparx.h.

References EMAN::TypeDict::put().

00472                 {
00473                         TypeDict d = NewFourierProcessor::get_param_types();
00474                         d.put("x_shift", EMObject::FLOAT, "Shift x");
00475                         d.put("y_shift", EMObject::FLOAT, "Shift y");
00476                         d.put("z_shift", EMObject::FLOAT, "Shift z");
00477                         return d;
00478                 }

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

Definition at line 461 of file processor_sparx.h.

00462                 { 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 467 of file processor_sparx.h.

00467                                                     {
00468                         params["filter_type"] = SHIFT;
00469                         EMFourierFilterInPlace(image, params);
00470                 }


Member Data Documentation

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

Definition at line 232 of file processor.cpp.


The documentation for this class was generated from the following files:
Generated on Tue Jun 11 13:43:05 2013 for EMAN2 by  doxygen 1.3.9.1