EMAN::NewHomomorphicTopHatProcessor Class Reference

Homomorphic top-hat filter processor applied in Fourier space. More...

#include <processor_sparx.h>

Inheritance diagram for EMAN::NewHomomorphicTopHatProcessor:

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

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.homomorphic.tophat"

Detailed Description

Homomorphic top-hat filter processor applied in Fourier space.

Parameters:
low_cutoff_frequency Absolute [0,0.5] low cut-off frequency.
high_cutoff_frequency Absolute [0,0.5] high cut-off frequency.
value_at_zero_frequency Value at zero frequency.

Definition at line 212 of file processor_sparx.h.


Member Function Documentation

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

00220                 {
00221                         return "Homomorphic top-hat filter processor applied in Fourier space.";
00222                 }

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

References NAME.

00216                 { return NAME; }

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

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

00228                 {
00229                         TypeDict d = NewFourierProcessor::get_param_types();
00230                         d.put("low_cutoff_frequency", EMObject::FLOAT, "Absolute [0,0.5] low cut-off frequency.");
00231                         d.put("high_cutoff_frequency", EMObject::FLOAT, "Absolute [0,0.5] high cut-off frequency.");
00232                         d.put("value_at_zero_frequency", EMObject::FLOAT, "Value at zero frequency.");
00233                         return d;
00234                 }

static Processor* EMAN::NewHomomorphicTopHatProcessor::NEW (  )  [inline, static]

Definition at line 217 of file processor_sparx.h.

00218                 { return new NewHomomorphicTopHatProcessor(); }

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

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

00223                                                     {
00224                         params["filter_type"] = TOP_HOMOMORPHIC;
00225                         EMFourierFilterInPlace(image, params);
00226                 }


Member Data Documentation

const string NewHomomorphicTopHatProcessor::NAME = "filter.homomorphic.tophat" [static]

Definition at line 236 of file processor_sparx.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Mon Jul 19 12:44:38 2010 for EMAN2 by  doxygen 1.4.7