Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

EMAN::NewLowpassButterworthProcessor Class Reference

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

#include <processor_sparx.h>

Inheritance diagram for EMAN::NewLowpassButterworthProcessor:

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

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

ProcessorNEW ()

Static Public Attributes

const string NAME = "filter.lowpass.butterworth"

Detailed Description

Lowpass Butterworth 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 570 of file processor_sparx.h.


Member Function Documentation

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

00578                 {
00579                         return "Lowpass Butterworth filter processor applied in Fourier space.";
00580                 }

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

00574                 { return NAME; }

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

References EMAN::TypeDict::put().

00587                 {
00588                         TypeDict d = NewFourierProcessor::get_param_types();
00589                         d.put("low_cutoff_frequency", EMObject::FLOAT, "Absolute [0,0.5] low cut-off frequency.");
00590                         d.put("high_cutoff_frequency", EMObject::FLOAT, "Absolute [0,0.5] high cut-off frequency.");
00591                         return d;
00592                 }

Processor* EMAN::NewLowpassButterworthProcessor::NEW  )  [inline, static]
 

Definition at line 575 of file processor_sparx.h.

00576                 { return new NewLowpassButterworthProcessor(); }

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

00581                                                     {
00582                         setbutterworthdefaults(image);
00583                         params["filter_type"] = BUTTERWORTH_LOW_PASS;
00584                         EMFourierFilterInPlace(image, params);
00585                 }


Member Data Documentation

const string NewLowpassButterworthProcessor::NAME = "filter.lowpass.butterworth" [static]
 

Definition at line 237 of file processor.cpp.


The documentation for this class was generated from the following files:
Generated on Tue Jun 11 13:49:40 2013 for EMAN2 by  doxygen 1.3.9.1