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 1955 of file processor.h.


Constructor & Destructor Documentation

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

Definition at line 1958 of file processor.h.

Referenced by NEW().

01958                                       :shift(0), scale(0)
01959                 {
01960                 }


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 1986 of file processor.h.

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

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 1962 of file processor.h.

References NAME.

01963                 {
01964                         return NAME;
01965                 }

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 1978 of file processor.h.

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

01979                 {
01980                         TypeDict d;
01981                         d.put("shift", EMObject::FLOAT, "The amount to shift pixel values by before scaling");
01982                         d.put("scale", EMObject::FLOAT, "The scaling factor to be applied to pixel values");
01983                         return d;
01984                 }

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

Definition at line 1966 of file processor.h.

References LinearXformProcessor().

01967                 {
01968                         return new LinearXformProcessor();
01969                 }

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

Implements EMAN::RealPixelProcessor.

Definition at line 1994 of file processor.h.

References scale, and shift.

01995                 {
01996                         *x = (*x) * scale + shift;
01997                 }

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 1971 of file processor.h.

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

01972                 {
01973                         params = new_params;
01974                         shift = params.get("shift");
01975                         scale = params.get("scale");
01976                 }


Member Data Documentation

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

Definition at line 1991 of file processor.h.

Referenced by get_name().

float EMAN::LinearXformProcessor::scale [private]

Definition at line 2001 of file processor.h.

Referenced by process_pixel(), and set_params().

float EMAN::LinearXformProcessor::shift [private]

Definition at line 2000 of file processor.h.

Referenced by process_pixel(), and set_params().


The documentation for this class was generated from the following files:
Generated on Tue Jul 12 13:48:51 2011 for EMAN2 by  doxygen 1.4.7