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

Lowpass tanh filter processor applied in Fourier space. More...

#include <processor_sparx.h>

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

Detailed Description

Lowpass tanh filter processor applied in Fourier space.

Parameters:
cutoff_absAbsolute [0,0.5] cut-off frequency.
fall_offTanh decay rate.

Definition at line 664 of file processor_sparx.h.


Member Function Documentation

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

                {
                        return "Lowpass tanh filter processor applied in Fourier space. 0.5*(tanh(cnst*(S+omega))-tanh(cnst*(S-omega))). omega==cutoff_abs. cnst==pi/(2*fall_off*omega). S in terms of Nyquist=0.5.";
                }
string EMAN::NewLowpassTanhProcessor::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 667 of file processor_sparx.h.

References NAME.

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

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

                {
                        TypeDict d = NewFourierProcessor::get_param_types();
                        d.put("fall_off", EMObject::FLOAT, "Tanh decay rate. ~0 -> step function. 1 -> smooth, gaussian-like falloff. ");
                        return d;
                }
static Processor* EMAN::NewLowpassTanhProcessor::NEW ( ) [inline, static]

Definition at line 669 of file processor_sparx.h.

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

References EMAN::Processor::EMFourierFilterInPlace(), EMAN::Processor::params, EMAN::NewFourierProcessor::preprocess(), EMAN::Dict::set_default(), and EMAN::Processor::TANH_LOW_PASS.

                                                    {
                        params["filter_type"] = TANH_LOW_PASS;
                        preprocess(image);
                        params.set_default("fall_off",.5f); // Only sets it if is not already set
                        EMFourierFilterInPlace(image, params);
                }

Member Data Documentation

const string NewLowpassTanhProcessor::NAME = "filter.lowpass.tanh" [static]

Definition at line 688 of file processor_sparx.h.

Referenced by get_name().


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