CircularMaskProcessor applies a circular mask to the data.This is the base class for specific circular mask processors.Its subclass must implement process_dist_pixel(). More...

#include <processor.h>

Inheritance diagram for EMAN::CircularMaskProcessor:

[legend]

Collaboration diagram for EMAN::CircularMaskProcessor:

[legend]

Public Member Functions
	CircularMaskProcessor ()

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

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

TypeDict	get_param_types () const
	Get processor parameter information in a 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 string	get_name () const =0
	Get the processor's name. More...

virtual Dict	get_params () const
	Get the processor parameters in a key/value dictionary. More...

Protected Member Functions
void	calc_locals (EMData *image)

bool	is_valid () const

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

virtual void	process_dist_pixel (float *pixel, float dist) const =0

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

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

Detailed Description

CircularMaskProcessor applies a circular mask to the data.This is the base class for specific circular mask processors.Its subclass must implement process_dist_pixel().

Parameters

inner_radius	inner mask radius. optional, default=-1
outer_radius	outer mask radius
dx	Modify mask center by dx relative to the default center nx/2
dy	Modify mask center by dy relative to the default center ny/2
dz	Modify mask center by dz relative to the default center nz/2

Definition at line 3720 of file processor.h.

Constructor & Destructor Documentation

◆ CircularMaskProcessor()

EMAN::CircularMaskProcessor::CircularMaskProcessor ( )

inline

Definition at line 3723 of file processor.h.

                                       :inner_radius(0), outer_radius(0), inner_radius_square(0),
                        outer_radius_square(0), dx(0), dy(0), dz(0), xc(0), yc(0), zc(0)
                {
                }

Member Function Documentation

◆ calc_locals()

void CircularMaskProcessor::calc_locals ( EMData * image )

protectedvirtual

Reimplemented from EMAN::CoordinateProcessor.

Reimplemented in EMAN::MaskGaussInvProcessor, and EMAN::MaskEdgeMeanProcessor.

Definition at line 2382 of file processor.cpp.

{
        xc = Util::fast_floor(nx/2.0f) + dx;
        yc = Util::fast_floor(ny/2.0f) + dy;
        zc = Util::fast_floor(nz/2.0f) + dz;
 
        if (outer_radius < 0) {
                outer_radius = nx / 2 + outer_radius +1;
                outer_radius_square = outer_radius * outer_radius;
        }
 
        if (inner_radius <= 0) {
                inner_radius_square = 0;
        }
}

References dx, dy, dz, EMAN::Util::fast_floor(), inner_radius, inner_radius_square, EMAN::CoordinateProcessor::nx, EMAN::CoordinateProcessor::ny, EMAN::CoordinateProcessor::nz, outer_radius, outer_radius_square, xc, yc, and zc.

◆ get_desc()

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

Reimplemented in EMAN::MaskSharpProcessor, EMAN::MaskSoftProcessor, EMAN::MaskEdgeMeanProcessor, EMAN::MaskNoiseProcessor, EMAN::MaskGaussProcessor, EMAN::MaskGaussInvProcessor, EMAN::MakeRadiusSquaredProcessor, EMAN::MakeRadiusProcessor, and EMAN::RadialProcessor.

Definition at line 3755 of file processor.h.

                {
                        return "CircularMaskProcessor applies a circular mask to the data.This is the base class for specific circular mask processors.Its subclass must implement process_dist_pixel().";
                }

◆ get_param_types()

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

Reimplemented in EMAN::MaskSharpProcessor, EMAN::MaskSoftProcessor, EMAN::MaskEdgeMeanProcessor, EMAN::MaskGaussProcessor, EMAN::MaskGaussInvProcessor, and EMAN::RadialProcessor.

Definition at line 3760 of file processor.h.

                {
                        TypeDict d;
 
                        d.put("inner_radius", EMObject::FLOAT, "inner mask radius. optional");
                        d.put("outer_radius", EMObject::FLOAT, "outer mask radius. Negative value -> box radius + outer_radius +1");
 
                        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, and EMAN::TypeDict::put().

Referenced by EMAN::MaskSharpProcessor::get_param_types(), EMAN::MaskSoftProcessor::get_param_types(), EMAN::MaskEdgeMeanProcessor::get_param_types(), and EMAN::MaskGaussProcessor::get_param_types().

◆ is_valid()

bool EMAN::CircularMaskProcessor::is_valid ( ) const

inlineprotectedvirtual

Reimplemented from EMAN::CoordinateProcessor.

Definition at line 3779 of file processor.h.

                {
                        return (!is_complex);
                }

References EMAN::CoordinateProcessor::is_complex.

◆ process_dist_pixel()

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

protectedpure virtual

Implemented in EMAN::MaskSharpProcessor, EMAN::MaskSoftProcessor, EMAN::MaskEdgeMeanProcessor, EMAN::MaskNoiseProcessor, EMAN::MaskGaussProcessor, EMAN::MaskGaussInvProcessor, EMAN::MakeRadiusSquaredProcessor, EMAN::MakeRadiusProcessor, and EMAN::RadialProcessor.

Referenced by process_pixel().

◆ process_pixel()

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

inlineprotectedvirtual

Implements EMAN::CoordinateProcessor.

Definition at line 3784 of file processor.h.

                {
                        float dist = (xi - xc) * (xi - xc) + (yi - yc) * (yi - yc) + (zi - zc) * (zi - zc);
                        process_dist_pixel(pixel, dist);
                }

References process_dist_pixel(), xc, yc, and zc.

◆ set_params()

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

Reimplemented in EMAN::MaskSharpProcessor, EMAN::MaskSoftProcessor, EMAN::MaskEdgeMeanProcessor, EMAN::MaskGaussProcessor, and EMAN::RadialProcessor.

Definition at line 3728 of file processor.h.

                {
                        params = new_params;
 
                        if (params.has_key("inner_radius")) {
                                inner_radius = params["inner_radius"];
                                inner_radius_square = inner_radius * inner_radius;
                        }
                        else {
                                inner_radius = -1;
                                inner_radius_square = -1;
                        }
 
                        if (params.has_key("outer_radius")) {
                                outer_radius = params["outer_radius"];
                                outer_radius_square = outer_radius * outer_radius;
                        }
                        else {
                                outer_radius = INT_MAX;
                                outer_radius_square = INT_MAX;
                        }
 
                        if (params.has_key("dx")) dx = params["dx"];
                        if (params.has_key("dy")) dy = params["dy"];
                        if (params.has_key("dz")) dz = params["dz"];
                }