EMAN::LinearXformProcessor Class Reference

linear transform processor: f(x) = x * scale + shift More...

#include <processor.h>

Inheritance diagram for EMAN::LinearXformProcessor:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 LinearXformProcessor ()
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.linear"

Protected Member Functions

void process_pixel (float *x) const

Private Attributes

float shift
float scale

Detailed Description

linear transform processor: f(x) = x * scale + shift

Parameters:
shift The amount to shift pixel values by before scaling
scale The scaling factor to be applied to pixel values

Definition at line 1861 of file processor.h.


Constructor & Destructor Documentation

EMAN::LinearXformProcessor::LinearXformProcessor (  )  [inline]

Definition at line 1864 of file processor.h.

Referenced by NEW().

01864                                       :shift(0), scale(0)
01865                 {
01866                 }


Member Function Documentation

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

01893                 {
01894                         return "linear transform processor: f(x) = x * scale + shift. This is equivalent to a regular contrast stretching operation";
01895                 }

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

References NAME.

01869                 {
01870                         return NAME;
01871                 }

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

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

01885                 {
01886                         TypeDict d;
01887                         d.put("shift", EMObject::FLOAT, "The amount to shift pixel values by before scaling");
01888                         d.put("scale", EMObject::FLOAT, "The scaling factor to be applied to pixel values");
01889                         return d;
01890                 }

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

Definition at line 1872 of file processor.h.

References LinearXformProcessor().

01873                 {
01874                         return new LinearXformProcessor();
01875                 }

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

Implements EMAN::RealPixelProcessor.

Definition at line 1900 of file processor.h.

References scale, and shift.

01901                 {
01902                         *x = (*x) * scale + shift;
01903                 }

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

References EMAN::Dict::get(), EMAN::Processor::params, scale, and shift.

01878                 {
01879                         params = new_params;
01880                         shift = params.get("shift");
01881                         scale = params.get("scale");
01882                 }


Member Data Documentation

const string LinearXformProcessor::NAME = "math.linear" [static]

Definition at line 1897 of file processor.h.

Referenced by get_name().

float EMAN::LinearXformProcessor::scale [private]

Definition at line 1907 of file processor.h.

Referenced by process_pixel(), and set_params().

float EMAN::LinearXformProcessor::shift [private]

Definition at line 1906 of file processor.h.

Referenced by process_pixel(), and set_params().


The documentation for this class was generated from the following files:
Generated on Mon Mar 7 18:02:24 2011 for EMAN2 by  doxygen 1.4.7