processor radial function: f(x) = slope * x + intercept More...

#include <processor.h>

Inheritance diagram for EMAN::LinearRampProcessor:

Collaboration diagram for EMAN::LinearRampProcessor:

[legend]

Public Member Functions
	LinearRampProcessor ()

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

string	get_desc () const
	Get the descrition of this specific processor. 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...

Public Member Functions inherited from EMAN::FourierProcessor
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::FourierProcessor
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 = "eman1.filter.ramp"

Protected Member Functions
void	create_radial_func (vector< float > &radial_mask) const

Protected Member Functions inherited from EMAN::FourierProcessor
virtual void	preprocess (EMData *image)

Private Attributes
float	intercept

float	slope

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::Processor
Dict	params

Detailed Description

processor radial function: f(x) = slope * x + intercept

Parameters

intercept	intercept in 'f(x) = slope * x + intercept
slope	slope in 'f(x) = slope * x + intercept

Definition at line 2034 of file processor.h.

Constructor & Destructor Documentation

◆ LinearRampProcessor()

EMAN::LinearRampProcessor::LinearRampProcessor ( )

inline

Definition at line 2037 of file processor.h.

                                     :intercept(0), slope(0)
                {
                }

Referenced by NEW().

Member Function Documentation

◆ create_radial_func()

void LinearRampProcessor::create_radial_func ( vector< float > & radial_mask ) const

protectedvirtual

Implements EMAN::FourierProcessor.

Definition at line 2165 of file processor.cpp.

{
        Assert(radial_mask.size() > 0);
        float x = 0.0f , step = 0.5f/radial_mask.size();
        size_t size=radial_mask.size();
        for (size_t i = 0; i < size; i++) {
                radial_mask[i] = intercept + ((slope - intercept) * i) / (size - 1.0f);
                x += step;
        }
}

References Assert, intercept, slope, and x.

◆ get_desc()

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

                {
                        return "processor radial function: f(x) = slope * x + intercept;";
                }

◆ get_name()

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

                {
                        return NAME;
                }

References NAME.

◆ get_param_types()

TypeDict EMAN::LinearRampProcessor::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::FourierProcessor.

Definition at line 2062 of file processor.h.

                {
                        TypeDict d;
                        d.put("intercept", EMObject::FLOAT, "intercept in 'f(x) = slope * x + intercept'");
                        d.put("slope", EMObject::FLOAT, "slope in 'f(x) = slope * x + intercept'");
                        return d;
                }

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

◆ NEW()

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

inlinestatic

Definition at line 2045 of file processor.h.

                {
                        return new LinearRampProcessor();
                }

References LinearRampProcessor().

◆ set_params()

void EMAN::LinearRampProcessor::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::Processor.

Definition at line 2055 of file processor.h.

                {
                        params = new_params;
                        intercept = params["intercept"];
                        slope = params["slope"];
                }

References intercept, EMAN::Processor::params, and slope.

Member Data Documentation

◆ intercept

float EMAN::LinearRampProcessor::intercept

private

Definition at line 2076 of file processor.h.

Referenced by create_radial_func(), and set_params().

◆ NAME

const string LinearRampProcessor::NAME = "eman1.filter.ramp"

static

Definition at line 2070 of file processor.h.

Referenced by get_name().

◆ slope

float EMAN::LinearRampProcessor::slope

private

Definition at line 2077 of file processor.h.

Referenced by create_radial_func(), 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

◆ LinearRampProcessor()

Member Function Documentation

◆ create_radial_func()

◆ get_desc()

◆ get_name()

◆ get_param_types()

◆ NEW()

◆ set_params()

Member Data Documentation

◆ intercept

◆ NAME

◆ slope