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

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

ProcessorNEW ()

Static Public Attributes

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


Constructor & Destructor Documentation

EMAN::ExpProcessor::ExpProcessor  )  [inline]
 

Definition at line 1832 of file processor.h.

01832                               :low(0), high(0)
01833                 {
01834                 }


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

01862                 {
01863                         return "f(x) = exp( x / low - high)";
01864                 }

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

01837                 {
01838                         return NAME;
01839                 }

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

References EMAN::TypeDict::put().

01854                 {
01855                         TypeDict d;
01856                         d.put("low", EMObject::FLOAT, "Pixels are divided by (low - high) prior to the exponential operation");
01857                         d.put("high", EMObject::FLOAT, "Pixels are divided by (low - high) prior to the exponential operation");
01858                         return d;
01859                 }

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

Definition at line 1841 of file processor.h.

01842                 {
01843                         return new ExpProcessor();
01844                 }

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

References v, and x.

01873                 {
01874                         float v = *x / low - high;
01875                         if (v > 40) {
01876                                 v = 40;
01877                         }
01878                         *x = exp(v);
01879                 }

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

References EMAN::Dict::get().

01847                 {
01848                         params = new_params;
01849                         low = params.get("low");
01850                         high = params.get("high");
01851                 }


Member Data Documentation

float EMAN::ExpProcessor::high [private]
 

Definition at line 1883 of file processor.h.

float EMAN::ExpProcessor::low [private]
 

Definition at line 1882 of file processor.h.

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

Definition at line 94 of file processor.cpp.


The documentation for this class was generated from the following files:
Generated on Thu Dec 9 13:47:47 2010 for EMAN2 by  doxygen 1.3.9.1