f(x) = exp( x / low - high) More...

#include <processor.h>

Inheritance diagram for EMAN::ExpProcessor:

Collaboration diagram for EMAN::ExpProcessor:

[legend]

Public Member Functions
	ExpProcessor ()

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.exp"

Protected Member Functions
void	process_pixel (float *x) const
	'40' is used to avoid floating number overflow. More...

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

virtual void	normalize (EMData *) const

Private Attributes
float	low

float	high

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

f(x) = exp( x / low - high)

Parameters

low	Pixels are divided by (low - high) prior to the exponential operation
high	Pixels are divided by (low - high) prior to the exponential operation

Definition at line 3375 of file processor.h.

Constructor & Destructor Documentation

◆ ExpProcessor()

EMAN::ExpProcessor::ExpProcessor ( )

inline

Definition at line 3378 of file processor.h.

                              :low(0), high(0)
                {
                }

Referenced by NEW().

Member Function Documentation

◆ get_desc()

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

                {
                        return "f(x) = exp( x / low - high)";
                }

◆ get_name()

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

                {
                        return NAME;
                }

References NAME.

◆ get_param_types()

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

                {
                        TypeDict d;
                        d.put("low", EMObject::FLOAT, "Pixels are divided by low then high is subtracted prior to the exponential operation, default 1.0");
                        d.put("high", EMObject::FLOAT, "Pixels are divided by low then high is subtracted prior to the exponential operation, default 0.0");
                        return d;
                }

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

◆ NEW()

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

inlinestatic

Definition at line 3387 of file processor.h.

                {
                        return new ExpProcessor();
                }

References ExpProcessor().

◆ process_pixel()

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

inlineprotectedvirtual

'40' is used to avoid floating number overflow.

Implements EMAN::RealPixelProcessor.

Definition at line 3418 of file processor.h.

                {
                        float v = *x / low - high;
                        if (v > 40) {
                                v = 40;
                        }
                        *x = exp(v);
                }

References high, low, and x.

◆ set_params()

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

                {
                        params = new_params;
                        low = params.set_default("low",1.0f);
                        high = params.set_default("high",0.0f);
                }

References high, low, EMAN::Processor::params, and EMAN::Dict::set_default().

Member Data Documentation

◆ high

float EMAN::ExpProcessor::high

private

Definition at line 3429 of file processor.h.

Referenced by process_pixel(), and set_params().

◆ low

float EMAN::ExpProcessor::low

private

Definition at line 3428 of file processor.h.

Referenced by process_pixel(), and set_params().

◆ NAME

const string ExpProcessor::NAME = "math.exp"

static

Definition at line 3412 of file processor.h.

Referenced by get_name().

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

◆ ExpProcessor()

Member Function Documentation

◆ get_desc()

◆ get_name()

◆ get_param_types()

◆ NEW()

◆ process_pixel()

◆ set_params()

Member Data Documentation

◆ high

◆ low

◆ NAME