#include <processor.h>

Inheritance diagram for EMAN::PolyMaskProcessor:

Collaboration diagram for EMAN::PolyMaskProcessor:

[legend]

Public Member Functions
	PolyMaskProcessor ()

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

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	k0

float	k1

float	k2

float	k3

float	k4

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

Definition at line 9789 of file processor.h.

Constructor & Destructor Documentation

◆ PolyMaskProcessor()

EMAN::PolyMaskProcessor::PolyMaskProcessor ( )

inline

Definition at line 9792 of file processor.h.

                                   :k0(0), k1(0), k2(0), k3(0), k4(0)
                {
                }

Referenced by NEW().

Member Function Documentation

◆ get_desc()

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

                {
                        return "Mask with polynomial falloff. k4 x^4 + k3 x^3 + k2 x^2 + k1 x + k0, where x is distance to center divided by nx/2.";
                }

◆ get_name()

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

                {
                        return NAME;
                }

References NAME.

◆ get_param_types()

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

                {
                        TypeDict d;
 
                        d.put("k0", EMObject::FLOAT, "constant term");
                        d.put("k1", EMObject::FLOAT, "k x term");
                        d.put("k2", EMObject::FLOAT, "k x^2 term");
                        d.put("k3", EMObject::FLOAT, "k x^3 term");
                        d.put("k4", EMObject::FLOAT, "k x^4 term");
                        d.put("2d", EMObject::BOOL, "apply mask in 2D");
                        
                        return d;
                }

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

◆ NEW()

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

inlinestatic

Definition at line 9826 of file processor.h.

                {
                        return new PolyMaskProcessor();
                }

References PolyMaskProcessor().

◆ process_pixel()

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

inlineprotectedvirtual

Implements EMAN::CoordinateProcessor.

Definition at line 9839 of file processor.h.

                {
                        float x=0.0f;
                        if (params["2d"]){
                                x = sqrt( pow((xi - nx/2),2.0f) + pow((yi - ny/2),2.0f) ) / (nx/2);
                        }
                        else{
                                x = sqrt( pow((xi - nx/2),2.0f) + pow((yi - ny/2),2.0f) + pow((zi - nz/2),2.0f)) / (nx/2);
                        }
                        
                        (*pixel)*= k4*pow(x, 4.0f) + k3*pow(x, 3.0f) + k2*pow(x, 2.0f) + k1*x + k0;
                }

References k0, k1, k2, k3, k4, EMAN::CoordinateProcessor::nx, EMAN::CoordinateProcessor::ny, EMAN::CoordinateProcessor::nz, EMAN::Processor::params, sqrt(), and x.

◆ set_params()

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

                {
                        params = new_params;
 
                        if (params.has_key("k0")) k0 = params["k0"];
                        if (params.has_key("k1")) k1 = params["k1"];
                        if (params.has_key("k2")) k2 = params["k2"];
                        if (params.has_key("k3")) k3 = params["k3"];
                        if (params.has_key("k4")) k4 = params["k4"];
 
                }