EMAN::NewBandpassTopHatProcessor Class Reference

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

#include <processor_sparx.h>

Inheritance diagram for EMAN::NewBandpassTopHatProcessor:

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

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

Detailed Description

Bandpass 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.

Definition at line 249 of file processor_sparx.h.


Member Function Documentation

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

00257                 {
00258                         return "Bandpass top-hat filter processor applied in Fourier space.";
00259                 }

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

References NAME.

00253                 { return NAME; }

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

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

00265                 {
00266                         TypeDict d = NewFourierProcessor::get_param_types();
00267                         d.put("low_cutoff_frequency", EMObject::FLOAT, "Absolute [0,0.5] low cut-off frequency.");
00268                         d.put("high_cutoff_frequency", EMObject::FLOAT, "Absolute [0,0.5] high cut-off frequency.");
00269                         return d;
00270                 }

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

Definition at line 254 of file processor_sparx.h.

00255                 { return new NewBandpassTopHatProcessor(); }

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

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

00260                                                     {
00261                         params["filter_type"] = TOP_HAT_BAND_PASS;
00262                         EMFourierFilterInPlace(image, params);
00263                 }


Member Data Documentation

const string NewBandpassTopHatProcessor::NAME = "filter.bandpass.tophat" [static]

Definition at line 272 of file processor_sparx.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Tue Jun 11 12:45:13 2013 for EMAN2 by  doxygen 1.4.7