EMAN2
Public Member Functions | Static Public Member Functions | Static Public Attributes
EMAN::NewBandpassTanhProcessor Class Reference

Bandpass tanh processor applied in Fourier space. More...

#include <processor_sparx.h>

Inheritance diagram for EMAN::NewBandpassTanhProcessor:
Inheritance graph
[legend]
Collaboration diagram for EMAN::NewBandpassTanhProcessor:
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.bandpass.tanh"

Detailed Description

Bandpass tanh processor applied in Fourier space.

Parameters:
low_cutoff_frequencyAbsolute [0,0.5] low cut-off frequency.
Low_fall_offTanh low decay rate.
high_cutoff_frequencyAbsolute [0,0.5] high cut-off frequency.
high_fall_offTanh high decay rate.
fall_offTanh decay rate.

Definition at line 762 of file processor_sparx.h.


Member Function Documentation

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

                {
                        return "Bandpass tanh processor applied in Fourier space.";
                }
string EMAN::NewBandpassTanhProcessor::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 765 of file processor_sparx.h.

References NAME.

                { return NAME; }
TypeDict EMAN::NewBandpassTanhProcessor::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 777 of file processor_sparx.h.

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

                {
                        TypeDict d = NewFourierProcessor::get_param_types();
                        d.put("low_cutoff_frequency", EMObject::FLOAT, "Absolute [0,0.5] low cut-off frequency.");
                        d.put("Low_fall_off", EMObject::FLOAT, "Tanh low decay rate.");
                        d.put("high_cutoff_frequency", EMObject::FLOAT, "Absolute [0,0.5] high cut-off frequency.");
                        d.put("high_fall_off", EMObject::FLOAT, "Tanh high decay rate.");
                        d.put("fall_off", EMObject::FLOAT, "Tanh decay rate.");
                        return d;
                }
static Processor* EMAN::NewBandpassTanhProcessor::NEW ( ) [inline, static]

Definition at line 767 of file processor_sparx.h.

                { return new NewBandpassTanhProcessor(); }
void EMAN::NewBandpassTanhProcessor::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 773 of file processor_sparx.h.

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

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

Member Data Documentation

const string NewBandpassTanhProcessor::NAME = "filter.bandpass.tanh" [static]

Definition at line 788 of file processor_sparx.h.

Referenced by get_name().


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