EMAN2
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes
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

static ProcessorNEW ()

Static Public Attributes

static 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_toInverted zero values are set to this value, default is 0

Definition at line 1346 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 1371 of file processor.h.

                        {
                                return "if f(x) != 0: f(x) = 1/f(x) else: f(x) = zero_to";
                        }
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 1349 of file processor.h.

References NAME.

                        {
                                return NAME;
                        }
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 1364 of file processor.h.

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

                        {
                                TypeDict d;
                                d.put("zero_to", EMObject::FLOAT, "Inverted zero values are set to this value, default is 0.");
                                return d;
                        }
static Processor* EMAN::RecipCarefullyProcessor::NEW ( ) [inline, static]

Definition at line 1353 of file processor.h.

                        {
                                return new RecipCarefullyProcessor();
                        }
void EMAN::RecipCarefullyProcessor::process_pixel ( float *  x) const [inline, protected, virtual]

Implements EMAN::RealPixelProcessor.

Definition at line 1379 of file processor.h.

References zero_to.

                        {
                                if (*x == 0.0) *x = zero_to;
                                else *x = 1.0f/(*x);
                        }
void EMAN::RecipCarefullyProcessor::set_params ( const Dict new_params) [inline, virtual]

Set the processor parameters using a key/value dictionary.

Parameters:
new_paramsA dictionary containing the new parameters.

Reimplemented from EMAN::RealPixelProcessor.

Definition at line 1358 of file processor.h.

References EMAN::Processor::params, EMAN::Dict::set_default(), and zero_to.

                        {
                                params = new_params;
                                zero_to = params.set_default("zero_to",0.0f);
                        }

Member Data Documentation

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

Definition at line 1376 of file processor.h.

Referenced by get_name().

Definition at line 1385 of file processor.h.

Referenced by process_pixel(), and set_params().


The documentation for this class was generated from the following files: