f(x) = f(x) / exp(-radius*radius * gauss_width / (ny*ny)) More...

#include <processor.h>

Inheritance diagram for EMAN::MaskGaussInvProcessor:

[legend]

Collaboration diagram for EMAN::MaskGaussInvProcessor:

[legend]

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

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

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

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

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

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 = "math.gausskernelfix"

Protected Member Functions
void	calc_locals (EMData *)

void	process_dist_pixel (float *pixel, float dist) const

Protected Member Functions inherited from EMAN::CircularMaskProcessor
bool	is_valid () const

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

Private Attributes
float	slice_value

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

Detailed Description

f(x) = f(x) / exp(-radius*radius * gauss_width / (ny*ny))

Parameters

gauss_width	Used to calculate the constant factor - gauss_width / (ny*ny)
ring_width	The width of the mask ring

Definition at line 4130 of file processor.h.

Member Function Documentation

◆ calc_locals()

void EMAN::MaskGaussInvProcessor::calc_locals ( EMData * )

inlineprotectedvirtual

Reimplemented from EMAN::CircularMaskProcessor.

Definition at line 4160 of file processor.h.

                {
                        xc = Util::fast_floor(nx/2.0f) + dx;
                        yc = Util::fast_floor(ny/2.0f) + dy;
                        zc = Util::fast_floor(nz/2.0f) + dz;
 
                        float gauss_width = params["gauss_width"];
                        slice_value = gauss_width / (ny * ny);
                }

References EMAN::CircularMaskProcessor::dx, EMAN::CircularMaskProcessor::dy, EMAN::CircularMaskProcessor::dz, EMAN::Util::fast_floor(), EMAN::CoordinateProcessor::nx, EMAN::CoordinateProcessor::ny, EMAN::CoordinateProcessor::nz, EMAN::Processor::params, slice_value, EMAN::CircularMaskProcessor::xc, EMAN::CircularMaskProcessor::yc, and EMAN::CircularMaskProcessor::zc.

◆ get_desc()

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

                {
                        return "f(x) = f(x) / exp(-radius*radius * gauss_width / (ny*ny))";
                }

◆ get_name()

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

                {
                        return NAME;
                }

References NAME.

◆ get_param_types()

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

                {
//                      TypeDict d = CircularMaskProcessor::get_param_types();
                        TypeDict d;
                        d.put("gauss_width", EMObject::FLOAT, "Used to calculate the constant factor - gauss_width / (ny*ny)" );
//                      d.put("ring_width", EMObject::INT, "The width of the mask ring.");
                        return d;
                }

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

◆ NEW()

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

inlinestatic

Definition at line 4147 of file processor.h.

                {
                        return new MaskGaussInvProcessor();
                }

◆ process_dist_pixel()

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

inlineprotectedvirtual

Implements EMAN::CircularMaskProcessor.

Definition at line 4170 of file processor.h.

                {
                        (*pixel) /= exp(-dist * slice_value);
                }

References slice_value.

Member Data Documentation

◆ NAME

const string MaskGaussInvProcessor::NAME = "math.gausskernelfix"

static

Definition at line 4157 of file processor.h.

Referenced by get_name().

◆ slice_value

float EMAN::MaskGaussInvProcessor::slice_value

private

Definition at line 4175 of file processor.h.

Referenced by calc_locals(), and process_dist_pixel().

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

Member Function Documentation

◆ calc_locals()

◆ get_desc()

◆ get_name()

◆ get_param_types()

◆ NEW()

◆ process_dist_pixel()

Member Data Documentation

◆ NAME

◆ slice_value