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

EMAN::CTF_Processor Class Reference

#include <processor_sparx.h>

Inheritance diagram for EMAN::CTF_Processor:

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

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.CTF_"

Member Function Documentation

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

00799                 {
00800                         return "CTF_ is applied in Fourier image.";
00801                 }

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

00795                 { return NAME; }

TypeDict EMAN::CTF_Processor::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 806 of file processor_sparx.h.

References EMAN::TypeDict::put().

00807                 {
00808                         TypeDict d = NewFourierProcessor::get_param_types();
00809                         d.put("defocus", EMObject::FLOAT, "defocus value in Angstrom.");
00810                         d.put("cs", EMObject::FLOAT, "cs in CM.");
00811                         d.put("voltage", EMObject::FLOAT, "voltage in Kv.");
00812                         d.put("ps", EMObject::FLOAT, "pixel size.");
00813                         d.put("b_factor", EMObject::FLOAT, "Gaussian like evelope function (b_factor).");
00814                         d.put("wgh", EMObject::FLOAT, "Amplitude contrast ratio.");
00815                         d.put("sign", EMObject::FLOAT, "Sign of Contrast transfer function,and use -1 to compensate.");
00816                         d.put("npow", EMObject::FLOAT, "power of transfer function.");
00817                         return d;
00818                 }

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

Definition at line 796 of file processor_sparx.h.

00797                 { return new CTF_Processor(); }

void EMAN::CTF_Processor::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 802 of file processor_sparx.h.

00802                                                     {
00803                         params["filter_type"] = CTF_;
00804                         EMFourierFilterInPlace(image, params);
00805                 }


Member Data Documentation

const string CTF_Processor::NAME = "filter.CTF_" [static]
 

Definition at line 244 of file processor.cpp.


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