step cutoff to a user-given value in both inner and outer circles. More...

#include <processor.h>

Inheritance diagram for EMAN::MaskSoftProcessor:

[legend]

Collaboration diagram for EMAN::MaskSoftProcessor:

[legend]

Public Member Functions
	MaskSoftProcessor ()

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

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	value

float	width

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

step cutoff to a user-given value in both inner and outer circles.

Parameters

value step cutoff to this value

Definition at line 3854 of file processor.h.

Constructor & Destructor Documentation

◆ MaskSoftProcessor()

EMAN::MaskSoftProcessor::MaskSoftProcessor ( )

inline

Definition at line 3857 of file processor.h.

                                   :value(0)
                {
                }

Referenced by NEW().

Member Function Documentation

◆ get_desc()

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

                {
                        return "Outer (optionally also inner) mask to a user-provided value with a soft Gaussian edge.";
                }

◆ get_name()

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

                {
                        return NAME;
                }

References NAME.

◆ get_param_types()

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

                {
                        TypeDict d = CircularMaskProcessor::get_param_types();
                        d.put("value", EMObject::FLOAT, "cutoff to this value. default=0");
                        d.put("width", EMObject::FLOAT, "1/e width of Gaussian falloff (both inner and outer) in pixels. default=4");
                        return d;
                }

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

◆ NEW()

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

inlinestatic

Definition at line 3865 of file processor.h.

                {
                        return new MaskSoftProcessor();
                }

References MaskSoftProcessor().

◆ process_dist_pixel()

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

inlineprotectedvirtual

Implements EMAN::CircularMaskProcessor.

Definition at line 3893 of file processor.h.

                {
                        if (dist>=inner_radius_square && dist<=outer_radius_square) return;
 
                        if (dist<inner_radius_square) *pixel=value+(*pixel-value)*exp(-pow((inner_radius-sqrt(dist))/width,2.0f));
                        else *pixel=value+(*pixel-value)*exp(-pow((sqrt(dist)-outer_radius)/width,2.0f));
                }

References EMAN::CircularMaskProcessor::inner_radius, EMAN::CircularMaskProcessor::inner_radius_square, EMAN::CircularMaskProcessor::outer_radius, EMAN::CircularMaskProcessor::outer_radius_square, sqrt(), value, and width.

◆ set_params()

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

                {
                        CircularMaskProcessor::set_params(new_params);
                        value = params.set_default("value",0.0f);
                        width = params.set_default("width",4.0f);
                }

References EMAN::Processor::params, EMAN::Dict::set_default(), EMAN::CircularMaskProcessor::set_params(), value, and width.

Member Data Documentation

◆ NAME

const string MaskSoftProcessor::NAME = "mask.soft"

static

Definition at line 3890 of file processor.h.

Referenced by get_name().

◆ value

float EMAN::MaskSoftProcessor::value

protected

Definition at line 3901 of file processor.h.

Referenced by process_dist_pixel(), and set_params().

◆ width

float EMAN::MaskSoftProcessor::width

protected

Definition at line 3901 of file processor.h.

Referenced by process_dist_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

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MaskSoftProcessor()

Member Function Documentation

◆ get_desc()

◆ get_name()

◆ get_param_types()

◆ NEW()

◆ process_dist_pixel()

◆ set_params()

Member Data Documentation

◆ NAME

◆ value

◆ width