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:
low Pixels are divided by (low - high) prior to the exponential operation
high Pixels are divided by (low - high) prior to the exponential operation

Definition at line 1914 of file processor.h.


Constructor & Destructor Documentation

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

Definition at line 1917 of file processor.h.

Referenced by NEW().

01917                               :low(0), high(0)
01918                 {
01919                 }


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

01947                 {
01948                         return "f(x) = exp( x / low - high)";
01949                 }

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

References NAME.

01922                 {
01923                         return NAME;
01924                 }

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

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

01939                 {
01940                         TypeDict d;
01941                         d.put("low", EMObject::FLOAT, "Pixels are divided by (low - high) prior to the exponential operation");
01942                         d.put("high", EMObject::FLOAT, "Pixels are divided by (low - high) prior to the exponential operation");
01943                         return d;
01944                 }

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

Definition at line 1926 of file processor.h.

References ExpProcessor().

01927                 {
01928                         return new ExpProcessor();
01929                 }

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

References high, low, and v.

01958                 {
01959                         float v = *x / low - high;
01960                         if (v > 40) {
01961                                 v = 40;
01962                         }
01963                         *x = exp(v);
01964                 }

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

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

01932                 {
01933                         params = new_params;
01934                         low = params.get("low");
01935                         high = params.get("high");
01936                 }


Member Data Documentation

float EMAN::ExpProcessor::high [private]

Definition at line 1968 of file processor.h.

Referenced by process_pixel(), and set_params().

float EMAN::ExpProcessor::low [private]

Definition at line 1967 of file processor.h.

Referenced by process_pixel(), and set_params().

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

Definition at line 1951 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Mon Mar 7 18:02:25 2011 for EMAN2 by  doxygen 1.4.7