EMAN::LinearRampProcessor Class Reference

processor radial function: f(x) = slope * x + intercept More...

#include <processor.h>

Inheritance diagram for EMAN::LinearRampProcessor:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 LinearRampProcessor ()
string get_name () const
 Get the processor's name.
string get_desc () const
 Get the descrition of this specific processor.
void set_params (const Dict &new_params)
 Set the processor parameters using a key/value dictionary.
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 = "eman1.filter.ramp"

Protected Member Functions

void create_radial_func (vector< float > &radial_mask) const

Private Attributes

float intercept
float slope

Detailed Description

processor radial function: f(x) = slope * x + intercept

Parameters:
intercept intercept in 'f(x) = slope * x + intercept
slope slope in 'f(x) = slope * x + intercept

Definition at line 1022 of file processor.h.


Constructor & Destructor Documentation

EMAN::LinearRampProcessor::LinearRampProcessor (  )  [inline]

Definition at line 1025 of file processor.h.

Referenced by NEW().

01025                                      :intercept(0), slope(0)
01026                 {
01027                 }


Member Function Documentation

void LinearRampProcessor::create_radial_func ( vector< float > &  radial_mask  )  const [protected, virtual]

Implements EMAN::FourierProcessor.

Definition at line 1258 of file processor.cpp.

References Assert, intercept, slope, and x.

01259 {
01260         Assert(radial_mask.size() > 0);
01261         float x = 0.0f , step = 0.5f/radial_mask.size();
01262         size_t size=radial_mask.size();
01263         for (size_t i = 0; i < size; i++) {
01264                 radial_mask[i] = intercept + ((slope - intercept) * i) / (size - 1.0f);
01265                 x += step;
01266         }
01267 }

string EMAN::LinearRampProcessor::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 1038 of file processor.h.

01039                 {
01040                         return "processor radial function: f(x) = slope * x + intercept;";
01041                 }

string EMAN::LinearRampProcessor::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 1029 of file processor.h.

References NAME.

01030                 {
01031                         return NAME;
01032                 }

TypeDict EMAN::LinearRampProcessor::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::FourierProcessor.

Definition at line 1050 of file processor.h.

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

01051                 {
01052                         TypeDict d;
01053                         d.put("intercept", EMObject::FLOAT, "intercept in 'f(x) = slope * x + intercept'");
01054                         d.put("slope", EMObject::FLOAT, "slope in 'f(x) = slope * x + intercept'");
01055                         return d;
01056                 }

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

Definition at line 1033 of file processor.h.

References LinearRampProcessor().

01034                 {
01035                         return new LinearRampProcessor();
01036                 }

void EMAN::LinearRampProcessor::set_params ( const Dict new_params  )  [inline, virtual]

Set the processor parameters using a key/value dictionary.

Parameters:
new_params A dictionary containing the new parameters.

Reimplemented from EMAN::Processor.

Definition at line 1043 of file processor.h.

References intercept, EMAN::Processor::params, and slope.

01044                 {
01045                         params = new_params;
01046                         intercept = params["intercept"];
01047                         slope = params["slope"];
01048                 }


Member Data Documentation

float EMAN::LinearRampProcessor::intercept [private]

Definition at line 1064 of file processor.h.

Referenced by create_radial_func(), and set_params().

const string LinearRampProcessor::NAME = "eman1.filter.ramp" [static]

Definition at line 1058 of file processor.h.

Referenced by get_name().

float EMAN::LinearRampProcessor::slope [private]

Definition at line 1065 of file processor.h.

Referenced by create_radial_func(), and set_params().


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