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

#include <processor.h>

Inheritance diagram for EMAN::LinearXformProcessor:

Collaboration diagram for EMAN::LinearXformProcessor:

[legend]

Public Member Functions
	LinearXformProcessor ()

string	get_name () const
	Get the processor's name. More...

void	set_params (const Dict &new_params)
	Set the processor parameters using a key/value dictionary. More...

TypeDict	get_param_types () const
	Get processor parameter information in a dictionary. More...

string	get_desc () const
	Get the descrition of this specific processor. More...

Public Member Functions inherited from EMAN::RealPixelProcessor
	RealPixelProcessor ()

void	process_inplace (EMData *image)
	To process an image in-place. More...

Public Member Functions inherited from EMAN::Processor
virtual	~Processor ()

virtual EMData *	process (const EMData *const image)
	To proccess an image out-of-place. More...

virtual void	process_list_inplace (vector< EMData * > &images)
	To process multiple images using the same algorithm. More...

virtual Dict	get_params () const
	Get the processor parameters in a key/value dictionary. More...

Static Public Member Functions
static Processor *	NEW ()

Static Public Member Functions inherited from EMAN::RealPixelProcessor
static string	get_group_desc ()

Static Public Member Functions inherited from EMAN::Processor
static string	get_group_desc ()
	Get the description of this group of processors. More...

static void	EMFourierFilterInPlace (EMData *fimage, Dict params)
	Compute a Fourier-filter processed image in place. More...

static EMData *	EMFourierFilter (EMData *fimage, Dict params)
	Compute a Fourier-processor processed image without altering the original image. More...

Static Public Attributes
static const string	NAME = "math.linear"

Protected Member Functions
void	process_pixel (float *x) const

Protected Member Functions inherited from EMAN::RealPixelProcessor
virtual void	calc_locals (EMData *)

virtual void	normalize (EMData *) const

Private Attributes
float	shift

float	scale

Additional Inherited Members
Public Types inherited from EMAN::Processor
enum	fourier_filter_types { TOP_HAT_LOW_PASS , TOP_HAT_HIGH_PASS , TOP_HAT_BAND_PASS , TOP_HOMOMORPHIC , GAUSS_LOW_PASS , GAUSS_HIGH_PASS , GAUSS_BAND_PASS , GAUSS_INVERSE , GAUSS_HOMOMORPHIC , BUTTERWORTH_LOW_PASS , BUTTERWORTH_HIGH_PASS , BUTTERWORTH_HOMOMORPHIC , KAISER_I0 , KAISER_SINH , KAISER_I0_INVERSE , KAISER_SINH_INVERSE , SHIFT , TANH_LOW_PASS , TANH_HIGH_PASS , TANH_HOMOMORPHIC , TANH_BAND_PASS , RADIAL_TABLE , CTF_ }
	Fourier filter Processor type enum. More...

Protected Attributes inherited from EMAN::RealPixelProcessor
float	value

float	maxval

float	mean

float	sigma

Protected Attributes inherited from EMAN::Processor
Dict	params

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

Constructor & Destructor Documentation

◆ LinearXformProcessor()

EMAN::LinearXformProcessor::LinearXformProcessor ( )

inline

Definition at line 3325 of file processor.h.

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

Referenced by NEW().

Member Function Documentation

◆ get_desc()

string EMAN::LinearXformProcessor::get_desc ( ) const

inlinevirtual

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

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

◆ get_name()

string EMAN::LinearXformProcessor::get_name ( ) const

inlinevirtual

Get the processor's name.

Each processor is identified by a unique name.

Returns: The processor's name.

Implements EMAN::Processor.

Definition at line 3329 of file processor.h.

                {
                        return NAME;
                }

References NAME.

◆ get_param_types()

TypeDict EMAN::LinearXformProcessor::get_param_types ( ) const

inlinevirtual

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

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

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

◆ NEW()

static Processor * EMAN::LinearXformProcessor::NEW ( )

inlinestatic

Definition at line 3333 of file processor.h.

                {
                        return new LinearXformProcessor();
                }

References LinearXformProcessor().

◆ process_pixel()

void EMAN::LinearXformProcessor::process_pixel ( float * x ) const

inlineprotectedvirtual

Implements EMAN::RealPixelProcessor.

Definition at line 3361 of file processor.h.

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

References scale, shift, and x.

◆ set_params()

void EMAN::LinearXformProcessor::set_params ( const Dict & new_params )

inlinevirtual

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

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

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

Member Data Documentation

◆ NAME

const string LinearXformProcessor::NAME = "math.linear"

static

Definition at line 3358 of file processor.h.

Referenced by get_name().

◆ scale

float EMAN::LinearXformProcessor::scale

private

Definition at line 3368 of file processor.h.

Referenced by process_pixel(), and set_params().

◆ shift

float EMAN::LinearXformProcessor::shift

private

Definition at line 3367 of file processor.h.

Referenced by process_pixel(), and set_params().

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LinearXformProcessor()

Member Function Documentation

◆ get_desc()

◆ get_name()

◆ get_param_types()

◆ NEW()

◆ process_pixel()

◆ set_params()

Member Data Documentation

◆ NAME

◆ scale

◆ shift