A step cutoff to the the mean value in a ring centered on the outer radius. More...

#include <processor.h>

Inheritance diagram for EMAN::MaskEdgeMeanProcessor:

[legend]

Collaboration diagram for EMAN::MaskEdgeMeanProcessor:

[legend]

Public Member Functions
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.ringmean"

Protected Member Functions
void	calc_locals (EMData *image)

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
int	ring_width

float	ring_avg

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

A step cutoff to the the mean value in a ring centered on the outer radius.

Parameters

ring_width The width of the mask ring.

Definition at line 3907 of file processor.h.

Member Function Documentation

◆ calc_locals()

void MaskEdgeMeanProcessor::calc_locals ( EMData * image )

protectedvirtual

Reimplemented from EMAN::CircularMaskProcessor.

Definition at line 2399 of file processor.cpp.

{
        if (!image) {
                throw NullPointerException("NULL image");
        }
        int nitems = 0;
        float sum = 0;
        float *data = image->get_data();
        size_t i = 0;
 
        xc = Util::fast_floor(nx/2.0f) + dx;
        yc = Util::fast_floor(ny/2.0f) + dy;
        zc = Util::fast_floor(nz/2.0f) + dz;
 
        for (int z = 0; z < nz; ++z) {
                for (int y = 0; y < ny; ++y) {
                        for (int x = 0; x < nx; ++x) {
                                float x1 = sqrt((x - xc) * (x - xc) + (y - yc) * (y - yc) + (z - zc) * (z - zc));
                                if (x1 <= outer_radius + ring_width && x1 >= outer_radius - ring_width) {
                                        sum += data[i];
                                        ++nitems;
                                }
                                ++i;
                        }
                }
        }
 
        ring_avg = sum / nitems;
}

References EMAN::CircularMaskProcessor::dx, EMAN::CircularMaskProcessor::dy, EMAN::CircularMaskProcessor::dz, EMAN::Util::fast_floor(), NullPointerException, EMAN::CoordinateProcessor::nx, EMAN::CoordinateProcessor::ny, EMAN::CoordinateProcessor::nz, EMAN::CircularMaskProcessor::outer_radius, ring_avg, ring_width, sqrt(), x, EMAN::CircularMaskProcessor::xc, y, EMAN::CircularMaskProcessor::yc, and EMAN::CircularMaskProcessor::zc.

◆ get_desc()

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

                {
                        return "A step cutoff to the the mean value in a ring centered on the outer radius";
                }

◆ get_name()

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

                {
                        return NAME;
                }

References NAME.

◆ get_param_types()

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

                {
                        TypeDict d = CircularMaskProcessor::get_param_types();
                        d.put("ring_width", EMObject::INT, "The width of the mask ring.");
                        return d;
                }

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

◆ NEW()

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

inlinestatic

Definition at line 3914 of file processor.h.

                {
                        return new MaskEdgeMeanProcessor();
                }

◆ process_dist_pixel()

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

inlineprotectedvirtual

Implements EMAN::CircularMaskProcessor.

Definition at line 3946 of file processor.h.

                {
                        if (dist >= outer_radius_square || dist < inner_radius_square){
                                *pixel = ring_avg;
                        }
                }

References EMAN::CircularMaskProcessor::inner_radius_square, EMAN::CircularMaskProcessor::outer_radius_square, and ring_avg.

◆ set_params()

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

                {
                        CircularMaskProcessor::set_params(new_params);
                        ring_width = params["ring_width"];
                        if (ring_width == 0) {
                                ring_width = 1;
                        }
                }

References EMAN::Processor::params, ring_width, and EMAN::CircularMaskProcessor::set_params().

Member Data Documentation

◆ NAME

const string MaskEdgeMeanProcessor::NAME = "mask.ringmean"

static

Definition at line 3940 of file processor.h.

Referenced by get_name().

◆ ring_avg

float EMAN::MaskEdgeMeanProcessor::ring_avg

private

Definition at line 3955 of file processor.h.

Referenced by calc_locals(), and process_dist_pixel().

◆ ring_width

int EMAN::MaskEdgeMeanProcessor::ring_width

private

Definition at line 3954 of file processor.h.

Referenced by calc_locals(), 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

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ calc_locals()

◆ get_desc()

◆ get_name()

◆ get_param_types()

◆ NEW()

◆ process_dist_pixel()

◆ set_params()

Member Data Documentation

◆ NAME

◆ ring_avg

◆ ring_width