EMAN2
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes
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:
powEach pixel is raised to this power

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

                {
                        return "f(x) = x ^ pow;";
                }
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 1394 of file processor.h.

References NAME.

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

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

                {
                        TypeDict d;
                        d.put("pow", EMObject::FLOAT, "Each pixel is raised to this power");
                        return d;
                }
static Processor* EMAN::ValuePowProcessor::NEW ( ) [inline, static]

Definition at line 1398 of file processor.h.

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

Implements EMAN::RealPixelProcessor.

Definition at line 1424 of file processor.h.

References pwr.

                {
                        if (*x<0 && pwr!=(int)pwr) *x=0;
                        else (*x) = pow(*x,pwr);
                }
void EMAN::ValuePowProcessor::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 1403 of file processor.h.

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

                {
                        params = new_params;
                        pwr = params["pow"];
                }

Member Data Documentation

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

Definition at line 1421 of file processor.h.

Referenced by get_name().

Definition at line 1430 of file processor.h.

Referenced by process_pixel(), and set_params().


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