a gaussian falloff to zero, with anisotropic widths along x,y,z More...

#include <processor.h>

Inheritance diagram for EMAN::MaskGaussNonuniformProcessor:

Collaboration diagram for EMAN::MaskGaussNonuniformProcessor:

[legend]

Public Member Functions
	MaskGaussNonuniformProcessor ()

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_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::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.nonuniform"

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

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

virtual bool	is_valid () const

Protected Attributes
float	radius_x

float	radius_y

float	radius_z

float	gauss_width

float	dx

float	dy

float	dz

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, with anisotropic widths along x,y,z

Parameters

radius_x	x-axis radius
radius_y	y-axis radius
radius_z	z-axis radius
gauss_width	Gaussian falloff width, relative to each radius, default 0.05

Definition at line 4050 of file processor.h.

Constructor & Destructor Documentation

◆ MaskGaussNonuniformProcessor()

EMAN::MaskGaussNonuniformProcessor::MaskGaussNonuniformProcessor ( )

inline

Definition at line 4053 of file processor.h.

                                              :radius_x(0), radius_y(0), radius_z(0), gauss_width(0),dx(0),dy(0),dz(0)
                {
                }

Referenced by NEW().

Member Function Documentation

◆ get_desc()

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

                {
                        return "A Gaussian falloff to zero. Anisotropic, specify inner radius for x,y,z and Gaussian falloff width. Falloff \
width is also anisotropic and relative to the radii, with 1 being equal to the radius on that axis.";
                }

◆ get_name()

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

                {
                        return NAME;
                }

References NAME.

◆ get_param_types()

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

                {
                        TypeDict d;
 
                        d.put("radius_x", EMObject::INT, "x-axis radius");
                        d.put("radius_y", EMObject::INT, "y-axis radius");
                        d.put("radius_z", EMObject::INT, "z-axis radius");
                        d.put("gauss_width", EMObject::FLOAT, "Gaussian falloff width, relative to each radius, default 0.05");
                        
                        d.put("dx", EMObject::FLOAT,
                                  "Modify mask center by dx relative to the default center nx/2");
                        d.put("dy", EMObject::FLOAT,
                                  "Modify mask center by dy relative to the default center ny/2");
                        d.put("dz", EMObject::FLOAT,
                                  "Modify mask center by dz relative to the default center nz/2");
 
 
                        return d;
                }

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

◆ NEW()

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

inlinestatic

Definition at line 4103 of file processor.h.

                {
                        return new MaskGaussNonuniformProcessor();
                }

References MaskGaussNonuniformProcessor().

◆ process_pixel()

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

inlineprotectedvirtual

Implements EMAN::CoordinateProcessor.

Definition at line 4117 of file processor.h.

                {
                        float dist = pow((xi - (nx/2+dx))/radius_x,2.0f) + pow((yi - (ny/2+dy))/radius_y,2.0f) + pow((zi - (nz/2+dz))/radius_z,2.0f);
                        if (dist>1.0) (*pixel)*=exp(-pow((sqrt(dist)-1.0f)/gauss_width,2.0f));
                }

References dx, dy, dz, gauss_width, EMAN::CoordinateProcessor::nx, EMAN::CoordinateProcessor::ny, EMAN::CoordinateProcessor::nz, radius_x, radius_y, radius_z, and sqrt().

◆ set_params()

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

                {
                        params = new_params;
 
                        if (params.has_key("radius_x")) radius_x=params["radius_x"];
                        else radius_x=5.0;
 
                        if (params.has_key("radius_y")) radius_y=params["radius_y"];
                        else radius_y=5.0;
 
                        if (params.has_key("radius_z")) radius_z=params["radius_z"];
                        else radius_z=5.0;
                        
                        dx=dy=dz=0.0;
                        if (params.has_key("dx")) dx=params["dx"];
                        if (params.has_key("dy")) dy=params["dy"];
                        if (params.has_key("dz")) dz=params["dz"];
 
                        if (params.has_key("gauss_width")) gauss_width=params["gauss_width"];
                        else gauss_width=0.05f;
                }