EMAN2
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes
EMAN::ExpProcessor Class Reference

f(x) = exp( x / low - high) More...

#include <processor.h>

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

List of all members.

Public Member Functions

 ExpProcessor ()
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.exp"

Protected Member Functions

void process_pixel (float *x) const
 '40' is used to avoid floating number overflow.

Private Attributes

float low
float high

Detailed Description

f(x) = exp( x / low - high)

Parameters:
lowPixels are divided by (low - high) prior to the exponential operation
highPixels are divided by (low - high) prior to the exponential operation

Definition at line 2184 of file processor.h.


Constructor & Destructor Documentation

EMAN::ExpProcessor::ExpProcessor ( ) [inline]

Definition at line 2187 of file processor.h.

Referenced by NEW().

                              :low(0), high(0)
                {
                }

Member Function Documentation

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

                {
                        return "f(x) = exp( x / low - high)";
                }
string EMAN::ExpProcessor::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 2191 of file processor.h.

References NAME.

                {
                        return NAME;
                }
TypeDict EMAN::ExpProcessor::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 2208 of file processor.h.

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

                {
                        TypeDict d;
                        d.put("low", EMObject::FLOAT, "Pixels are divided by (low - high) prior to the exponential operation");
                        d.put("high", EMObject::FLOAT, "Pixels are divided by (low - high) prior to the exponential operation");
                        return d;
                }
static Processor* EMAN::ExpProcessor::NEW ( ) [inline, static]

Definition at line 2196 of file processor.h.

References ExpProcessor().

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

'40' is used to avoid floating number overflow.

Implements EMAN::RealPixelProcessor.

Definition at line 2227 of file processor.h.

References high, low, and v.

                {
                        float v = *x / low - high;
                        if (v > 40) {
                                v = 40;
                        }
                        *x = exp(v);
                }
void EMAN::ExpProcessor::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 2201 of file processor.h.

References EMAN::Dict::get(), high, low, and EMAN::Processor::params.

                {
                        params = new_params;
                        low = params.get("low");
                        high = params.get("high");
                }

Member Data Documentation

float EMAN::ExpProcessor::high [private]

Definition at line 2238 of file processor.h.

Referenced by process_pixel(), and set_params().

float EMAN::ExpProcessor::low [private]

Definition at line 2237 of file processor.h.

Referenced by process_pixel(), and set_params().

const string ExpProcessor::NAME = "math.exp" [static]

Definition at line 2221 of file processor.h.

Referenced by get_name().


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