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

EMAN::RecipCarefullyProcessor Class Reference

Reciprocal image as if f(x) != 0: f(x) = 1/f(x) else: f(x) = zero_to. More...

#include <processor.h>

Inheritance diagram for EMAN::RecipCarefullyProcessor:

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

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

ProcessorNEW ()

Static Public Attributes

const string NAME = "math.reciprocal"

Protected Member Functions

void process_pixel (float *x) const

Private Attributes

float zero_to

Detailed Description

Reciprocal image as if f(x) != 0: f(x) = 1/f(x) else: f(x) = zero_to.

Parameters:
zero_to Inverted zero values are set to this value, default is 0

Definition at line 1294 of file processor.h.


Member Function Documentation

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

01320                         {
01321                                 return "if f(x) != 0: f(x) = 1/f(x) else: f(x) = zero_to";
01322                         }

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

01298                         {
01299                                 return NAME;
01300                         }

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

References EMAN::TypeDict::put().

01313                         {
01314                                 TypeDict d;
01315                                 d.put("zero_to", EMObject::FLOAT, "Inverted zero values are set to this value, default is 0.");
01316                                 return d;
01317                         }

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

Definition at line 1301 of file processor.h.

01302                         {
01303                                 return new RecipCarefullyProcessor();
01304                         }

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

Implements EMAN::RealPixelProcessor.

Definition at line 1327 of file processor.h.

References x.

01328                         {
01329                                 if (*x == 0.0) *x = zero_to;
01330                                 else *x = 1.0f/(*x);
01331                         }

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

References EMAN::Dict::set_default().

01307                         {
01308                                 params = new_params;
01309                                 zero_to = params.set_default("zero_to",0.0f);
01310                         }


Member Data Documentation

const string RecipCarefullyProcessor::NAME = "math.reciprocal" [static]
 

Definition at line 80 of file processor.cpp.

float EMAN::RecipCarefullyProcessor::zero_to [private]
 

Definition at line 1333 of file processor.h.


The documentation for this class was generated from the following files:
Generated on Tue Jun 11 13:42:16 2013 for EMAN2 by  doxygen 1.3.9.1