EMAN2
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes
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:
toPixels which are not finite will be set to this value

Definition at line 2244 of file processor.h.


Constructor & Destructor Documentation

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

Definition at line 2247 of file processor.h.

Referenced by NEW().

                                         :to(0)
                        {
                        }

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

                        {
                                return "f(x) = f(x) if f(x) is finite | to if f(x) is not finite";
                        }
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 2251 of file processor.h.

References NAME.

                        {
                                return NAME;
                        }
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 2267 of file processor.h.

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

                        {
                                TypeDict d;
                                d.put("to", EMObject::FLOAT, "Pixels which are not finite will be set to this value");
                                return d;
                        }
static Processor* EMAN::FiniteProcessor::NEW ( ) [inline, static]

Definition at line 2256 of file processor.h.

References FiniteProcessor().

                        {
                                return new FiniteProcessor();
                        }
void FiniteProcessor::process_pixel ( float *  x) const [protected, virtual]

Implements EMAN::RealPixelProcessor.

Definition at line 511 of file processor.cpp.

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

{
        if ( !Util::goodf(x) ) {
                *x = to;
        }
}
void EMAN::FiniteProcessor::set_params ( const Dict new_params) [inline, virtual]

Set the processor parameters using a key/value dictionary.

Parameters:
new_paramsA dictionary containing the new parameters.

Reimplemented from EMAN::RealPixelProcessor.

Definition at line 2261 of file processor.h.

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

                        {
                                if (new_params.has_key("to") )
                                        to = params["to"];
                        }

Member Data Documentation

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

Definition at line 2279 of file processor.h.

Referenced by get_name().

float EMAN::FiniteProcessor::to [private]

Definition at line 2287 of file processor.h.

Referenced by process_pixel(), and set_params().


The documentation for this class was generated from the following files: