EMAN2
Public Member Functions | Static Public Member Functions | Static Public Attributes
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

static ProcessorNEW ()

Static Public Attributes

static const string NAME = "filter.CTF_"

Detailed Description

Definition at line 791 of file processor_sparx.h.


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.

                {
                        return "CTF_ is applied in Fourier image.";
                }
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.

References NAME.

                { 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::EMObject::FLOAT, and EMAN::TypeDict::put().

                {
                        TypeDict d = NewFourierProcessor::get_param_types();
                        d.put("defocus", EMObject::FLOAT, "defocus value in Angstrom.");
                        d.put("cs", EMObject::FLOAT, "cs in CM.");
                        d.put("voltage", EMObject::FLOAT, "voltage in Kv.");
                        d.put("ps", EMObject::FLOAT, "pixel size.");
                        d.put("b_factor", EMObject::FLOAT, "Gaussian like evelope function (b_factor).");
                        d.put("wgh", EMObject::FLOAT, "Amplitude contrast ratio.");
                        d.put("sign", EMObject::FLOAT, "Sign of Contrast transfer function,and use -1 to compensate.");
                        d.put("npow", EMObject::FLOAT, "power of transfer function.");
                        return d;
                }
static Processor* EMAN::CTF_Processor::NEW ( ) [inline, static]

Definition at line 796 of file processor_sparx.h.

                { 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:
imageThe image to be processed.

Implements EMAN::Processor.

Definition at line 802 of file processor_sparx.h.

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

                                                    {
                        params["filter_type"] = CTF_;
                        EMFourierFilterInPlace(image, params);
                }

Member Data Documentation

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

Definition at line 820 of file processor_sparx.h.

Referenced by get_name().


The documentation for this class was generated from the following files: