EMAN::ValuePowProcessor Class Reference

Do a math power operation on image, f(x) = x ^ pow;. More...

#include <processor.h>

Inheritance diagram for EMAN::ValuePowProcessor:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

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.pow"

Protected Member Functions

void process_pixel (float *x) const

Private Attributes

float pwr

Detailed Description

Do a math power operation on image, f(x) = x ^ pow;.

Parameters:
pow Each pixel is raised to this power

Definition at line 1144 of file processor.h.


Member Function Documentation

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

01170                 {
01171                         return "f(x) = x ^ pow;";
01172                 }

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

References NAME.

01148                 {
01149                         return NAME;
01150                 }

TypeDict EMAN::ValuePowProcessor::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 1162 of file processor.h.

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

01163                 {
01164                         TypeDict d;
01165                         d.put("pow", EMObject::FLOAT, "Each pixel is raised to this power");
01166                         return d;
01167                 }

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

Definition at line 1151 of file processor.h.

01152                 {
01153                         return new ValuePowProcessor();
01154                 }

void EMAN::ValuePowProcessor::process_pixel ( float *  x  )  const [inline, protected, virtual]

Implements EMAN::RealPixelProcessor.

Definition at line 1177 of file processor.h.

References pwr.

01178                 {
01179                         if (*x<0 && pwr!=(int)pwr) *x=0;
01180                         else (*x) = pow(*x,pwr);
01181                 }

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

References EMAN::Processor::params, and pwr.

01157                 {
01158                         params = new_params;
01159                         pwr = params["pow"];
01160                 }


Member Data Documentation

const string ValuePowProcessor::NAME = "math.pow" [static]

Definition at line 1174 of file processor.h.

Referenced by get_name().

float EMAN::ValuePowProcessor::pwr [private]

Definition at line 1183 of file processor.h.

Referenced by process_pixel(), and set_params().


The documentation for this class was generated from the following files:
Generated on Thu Mar 10 23:00:00 2011 for EMAN2 by  doxygen 1.4.7