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

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


Constructor & Destructor Documentation

EMAN::ExpProcessor::ExpProcessor  )  [inline]
 

Definition at line 2008 of file processor.h.

Referenced by NEW().

02008                               :low(0), high(0)
02009                 {
02010                 }


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

02038                 {
02039                         return "f(x) = exp( x / low - high)";
02040                 }

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

References NAME.

02013                 {
02014                         return NAME;
02015                 }

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

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

02030                 {
02031                         TypeDict d;
02032                         d.put("low", EMObject::FLOAT, "Pixels are divided by (low - high) prior to the exponential operation");
02033                         d.put("high", EMObject::FLOAT, "Pixels are divided by (low - high) prior to the exponential operation");
02034                         return d;
02035                 }

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

Definition at line 2017 of file processor.h.

References ExpProcessor().

02018                 {
02019                         return new ExpProcessor();
02020                 }

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

References high, low, and v.

02049                 {
02050                         float v = *x / low - high;
02051                         if (v > 40) {
02052                                 v = 40;
02053                         }
02054                         *x = exp(v);
02055                 }

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

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

02023                 {
02024                         params = new_params;
02025                         low = params.get("low");
02026                         high = params.get("high");
02027                 }


Member Data Documentation

float EMAN::ExpProcessor::high [private]
 

Definition at line 2059 of file processor.h.

Referenced by process_pixel(), and set_params().

float EMAN::ExpProcessor::low [private]
 

Definition at line 2058 of file processor.h.

Referenced by process_pixel(), and set_params().

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

Definition at line 2042 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Tue May 25 17:37:04 2010 for EMAN2 by  doxygen 1.4.4