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

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

ProcessorNEW ()

Static Public Attributes

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 2064 of file processor.h.


Constructor & Destructor Documentation

EMAN::FiniteProcessor::FiniteProcessor  )  [inline]
 

Definition at line 2067 of file processor.h.

02067                                          :to(0)
02068                         {
02069                         }


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 2094 of file processor.h.

02095                         {
02096                                 return "f(x) = f(x) if f(x) is finite | to if f(x) is not finite";
02097                         }

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 2071 of file processor.h.

02072                         {
02073                                 return NAME;
02074                         }

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 2087 of file processor.h.

References EMAN::TypeDict::put().

02088                         {
02089                                 TypeDict d;
02090                                 d.put("to", EMObject::FLOAT, "Pixels which are not finite will be set to this value");
02091                                 return d;
02092                         }

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

Definition at line 2076 of file processor.h.

02077                         {
02078                                 return new FiniteProcessor();
02079                         }

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

Implements EMAN::RealPixelProcessor.

Definition at line 482 of file processor.cpp.

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

00483 {
00484         if ( !Util::goodf(x) ) {
00485                 *x = to;
00486         }
00487 }

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 2081 of file processor.h.

References EMAN::Dict::has_key().

02082                         {
02083                                 if (new_params.has_key("to") )
02084                                         to = params["to"];
02085                         }


Member Data Documentation

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

Definition at line 100 of file processor.cpp.

float EMAN::FiniteProcessor::to [private]
 

Definition at line 2107 of file processor.h.


The documentation for this class was generated from the following files:
Generated on Thu Nov 17 12:46:00 2011 for EMAN2 by  doxygen 1.3.9.1