EMAN::FiniteProcessor Class Reference

f(x) = f(x) if f(x) is finite | to if f(x) is not finite More...

#include <processor.h>

Inheritance diagram for EMAN::FiniteProcessor:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 FiniteProcessor ()
string get_name () const
 Get the processor's name.
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.
string get_desc () const
 Get the descrition of this specific processor.

Static Public Member Functions

static ProcessorNEW ()

Static Public Attributes

static const string NAME = "math.finite"

Protected Member Functions

void process_pixel (float *x) const

Private Attributes

float to

Detailed Description

f(x) = f(x) if f(x) is finite | to if f(x) is not finite

Parameters:
to Pixels which are not finite will be set to this value

Definition at line 2111 of file processor.h.


Constructor & Destructor Documentation

EMAN::FiniteProcessor::FiniteProcessor (  )  [inline]

Definition at line 2114 of file processor.h.

Referenced by NEW().

02114                                          :to(0)
02115                         {
02116                         }


Member Function Documentation

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

02142                         {
02143                                 return "f(x) = f(x) if f(x) is finite | to if f(x) is not finite";
02144                         }

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

References NAME.

02119                         {
02120                                 return NAME;
02121                         }

TypeDict EMAN::FiniteProcessor::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::Processor.

Definition at line 2134 of file processor.h.

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

02135                         {
02136                                 TypeDict d;
02137                                 d.put("to", EMObject::FLOAT, "Pixels which are not finite will be set to this value");
02138                                 return d;
02139                         }

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

Definition at line 2123 of file processor.h.

References FiniteProcessor().

02124                         {
02125                                 return new FiniteProcessor();
02126                         }

void FiniteProcessor::process_pixel ( float *  x  )  const [protected, virtual]

Implements EMAN::RealPixelProcessor.

Definition at line 488 of file processor.cpp.

References EMAN::Util::goodf(), and to.

00489 {
00490         if ( !Util::goodf(x) ) {
00491                 *x = to;
00492         }
00493 }

void EMAN::FiniteProcessor::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::RealPixelProcessor.

Definition at line 2128 of file processor.h.

References EMAN::Dict::has_key(), EMAN::Processor::params, and to.

02129                         {
02130                                 if (new_params.has_key("to") )
02131                                         to = params["to"];
02132                         }


Member Data Documentation

const string FiniteProcessor::NAME = "math.finite" [static]

Definition at line 2146 of file processor.h.

Referenced by get_name().

float EMAN::FiniteProcessor::to [private]

Definition at line 2154 of file processor.h.

Referenced by process_pixel(), and set_params().


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