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

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

ProcessorNEW ()

Static Public Attributes

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


Constructor & Destructor Documentation

EMAN::LinearXformProcessor::LinearXformProcessor  )  [inline]
 

Definition at line 2001 of file processor.h.

02001                                       :shift(0), scale(0)
02002                 {
02003                 }


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

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

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

02006                 {
02007                         return NAME;
02008                 }

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

References EMAN::TypeDict::put().

02022                 {
02023                         TypeDict d;
02024                         d.put("shift", EMObject::FLOAT, "The amount to shift pixel values by before scaling");
02025                         d.put("scale", EMObject::FLOAT, "The scaling factor to be applied to pixel values");
02026                         return d;
02027                 }

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

Definition at line 2009 of file processor.h.

02010                 {
02011                         return new LinearXformProcessor();
02012                 }

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

Implements EMAN::RealPixelProcessor.

Definition at line 2037 of file processor.h.

References x.

02038                 {
02039                         *x = (*x) * scale + shift;
02040                 }

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

References EMAN::Dict::get().

02015                 {
02016                         params = new_params;
02017                         shift = params.get("shift");
02018                         scale = params.get("scale");
02019                 }


Member Data Documentation

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

Definition at line 98 of file processor.cpp.

float EMAN::LinearXformProcessor::scale [private]
 

Definition at line 2044 of file processor.h.

float EMAN::LinearXformProcessor::shift [private]
 

Definition at line 2043 of file processor.h.


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