a gaussian falloff to zero, radius is the 1/e of the width. More...

#include <processor.h>

Inheritance diagram for EMAN::MaskGaussProcessor:

[legend]

Collaboration diagram for EMAN::MaskGaussProcessor:

[legend]

Public Member Functions
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::CircularMaskProcessor
	CircularMaskProcessor ()

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

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::CoordinateProcessor
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 = "mask.gaussian"

Protected Member Functions
void	process_dist_pixel (float *pixel, float dist) const

Protected Member Functions inherited from EMAN::CircularMaskProcessor
void	calc_locals (EMData *image)

bool	is_valid () const

void	process_pixel (float *pixel, int xi, int yi, int zi) const

Protected Attributes
float	exponent

Protected Attributes inherited from EMAN::CircularMaskProcessor
float	inner_radius

float	outer_radius

float	inner_radius_square

float	outer_radius_square

float	dx

float	dy

float	dz

float	xc

float	yc

float	zc

Protected Attributes inherited from EMAN::CoordinateProcessor
int	nx

int	ny

int	nz

float	mean

float	sigma

float	maxval

bool	is_complex

Protected Attributes inherited from EMAN::Processor
Dict	params

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

Detailed Description

a gaussian falloff to zero, radius is the 1/e of the width.

Definition at line 3991 of file processor.h.

Member Function Documentation

◆ get_desc()

string EMAN::MaskGaussProcessor::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.

Reimplemented from EMAN::CircularMaskProcessor.

Definition at line 4019 of file processor.h.

                {
                        return "a gaussian falloff to zero, radius is the 1/e of the width. If inner_radius>0, then \
outer radius specifies width of Gaussian starting at inner_radius rather than total radius.";
                }

◆ get_name()

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

                {
                        return NAME;
                }

References NAME.

◆ get_param_types()

TypeDict EMAN::MaskGaussProcessor::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::CircularMaskProcessor.

Definition at line 4012 of file processor.h.

                {
                        TypeDict d = CircularMaskProcessor::get_param_types();
                        d.put("exponent", EMObject::FLOAT, "The exponent, f in e^-Bs^f. default 2.0, producing a Gaussian");
                        return d;
                }

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

◆ NEW()

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

inlinestatic

Definition at line 3998 of file processor.h.

                {
                        return new MaskGaussProcessor();
                }

◆ process_dist_pixel()

void EMAN::MaskGaussProcessor::process_dist_pixel	(	float *	pixel,
		float	dist
	)		const

inlineprotectedvirtual

Implements EMAN::CircularMaskProcessor.

Definition at line 4029 of file processor.h.

                {
                        if (inner_radius_square>0) {
                                if (dist>inner_radius_square) {
                                        if (exponent==2.0f) (*pixel) *= exp(-pow(sqrt(dist)-inner_radius,2.0f) / outer_radius_square);
                                        else (*pixel) *= exp(-pow(sqrt(dist)-inner_radius,exponent) / pow((float)outer_radius_square,exponent/2.0f));
                                }
                        }
                        else {
                                if (exponent==2.0f) (*pixel) *= exp(-dist / outer_radius_square);
                                else (*pixel) *= exp(-pow(dist,exponent/2.0f) / pow((float)outer_radius_square,exponent/2.0f));
                        }
                }

References exponent, EMAN::CircularMaskProcessor::inner_radius, EMAN::CircularMaskProcessor::inner_radius_square, EMAN::CircularMaskProcessor::outer_radius_square, and sqrt().

◆ set_params()

void EMAN::MaskGaussProcessor::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::CircularMaskProcessor.

Definition at line 4003 of file processor.h.

                {
                        CircularMaskProcessor::set_params(new_params);
                        exponent = params["exponent"];
                        if (exponent <= 0.0) {
                                exponent = 2.0;
                        }
                }

References exponent, EMAN::Processor::params, and EMAN::CircularMaskProcessor::set_params().

Member Data Documentation

◆ exponent

float EMAN::MaskGaussProcessor::exponent

protected

Definition at line 4028 of file processor.h.

Referenced by process_dist_pixel(), and set_params().

◆ NAME

const string MaskGaussProcessor::NAME = "mask.gaussian"

static

Definition at line 4025 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

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_desc()

◆ get_name()

◆ get_param_types()

◆ NEW()

◆ process_dist_pixel()

◆ set_params()

Member Data Documentation

◆ exponent

◆ NAME