EMAN::LinearXformProcessor Class Reference

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

#include <processor.h>

Inheritance diagram for EMAN::LinearXformProcessor:

[legend]

Collaboration diagram for EMAN::LinearXformProcessor:

[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 Processor *	NEW ()
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 1892 of file processor.h.

---

Constructor & Destructor Documentation

EMAN::LinearXformProcessor::LinearXformProcessor

(

)

[inline]

Definition at line 1895 of file processor.h.

Referenced by NEW().

                                      :shift(0), scale(0)
                {
                }

---

Member Function Documentation

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

References NAME.

                {
                        return NAME;
                }

static Processor* EMAN::LinearXformProcessor::NEW

(

)

[inline, static]

Definition at line 1903 of file processor.h.

References LinearXformProcessor().

                {
                        return new LinearXformProcessor();
                }

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

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

                {
                        params = new_params;
                        shift = params.get("shift");
                        scale = params.get("scale");
                }

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

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

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

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

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

void EMAN::LinearXformProcessor::process_pixel

(

float *

x

)

const [inline, protected, virtual]

Implements EMAN::RealPixelProcessor.

Definition at line 1931 of file processor.h.

References scale, and shift.

                {
                        *x = (*x) * scale + shift;
                }

---

Member Data Documentation

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

Definition at line 1928 of file processor.h.

Referenced by get_name().

float EMAN::LinearXformProcessor::shift [private]

Definition at line 1937 of file processor.h.

Referenced by process_pixel(), and set_params().

float EMAN::LinearXformProcessor::scale [private]

Definition at line 1938 of file processor.h.

Referenced by process_pixel(), and set_params().

---

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

• processor.h
• processor.cpp