CoordinateProcessor applies processing based on a pixel's value and it coordinates. More...

#include <processor.h>

Inheritance diagram for EMAN::CoordinateProcessor:

[legend]

Collaboration diagram for EMAN::CoordinateProcessor:

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

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

virtual TypeDict	get_param_types () const
	Get processor parameter information in a dictionary. More...

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

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

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

virtual void	calc_locals (EMData *)

virtual bool	is_valid () const

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

CoordinateProcessor applies processing based on a pixel's value and it coordinates.

This is the base class. Specific coordinate processor should implement process_pixel().

Definition at line 3628 of file processor.h.

Constructor & Destructor Documentation

◆ CoordinateProcessor()

EMAN::CoordinateProcessor::CoordinateProcessor ( )

inline

Definition at line 3631 of file processor.h.

                                     :nx(0), ny(0), nz(0), mean(0), sigma(0), maxval(0), is_complex(false)
                {
                }

Member Function Documentation

◆ calc_locals()

virtual void EMAN::CoordinateProcessor::calc_locals ( EMData * )

inlineprotectedvirtual

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

Definition at line 3643 of file processor.h.

3644 {

3645 }

Referenced by process_inplace().

◆ get_group_desc()

static string EMAN::CoordinateProcessor::get_group_desc ( )

inlinestatic

Definition at line 3636 of file processor.h.

                {
                        return "CoordinateProcessor applies processing based on a pixel's value and it coordinates. This is the base class. Specific coordinate processor should implement process_pixel().";
                }

◆ is_valid()

virtual bool EMAN::CoordinateProcessor::is_valid ( ) const

inlineprotectedvirtual

Reimplemented in EMAN::CircularMaskProcessor.

Definition at line 3646 of file processor.h.

                {
                        return true;
                }

Referenced by process_inplace().

◆ process_inplace()

void CoordinateProcessor::process_inplace ( EMData * image )

virtual

To process an image in-place.

For those processors which can only be processed out-of-place, override this function to just print out some error message to remind user call the out-of-place version.

Parameters

image The image to be processed.

Implements EMAN::Processor.

Definition at line 2268 of file processor.cpp.

{
        if (!image) {
                LOGWARN("NULL Image");
                return;
        }
 
        maxval = image->get_attr("maximum");
        mean = image->get_attr("mean");
        sigma = image->get_attr("sigma");
        nx = image->get_xsize();
        ny = image->get_ysize();
        nz = image->get_zsize();
        is_complex = image->is_complex();
 
        calc_locals(image);
 
 
        if (!is_valid()) {
                return;
        }
 
        float *data = image->get_data();
        size_t i = 0;
 
        for (int z = 0; z < nz; z++) {
                for (int y = 0; y < ny; y++) {
                        for (int x = 0; x < nx; x++) {
                                process_pixel(&data[i], x, y, z);
                                ++i;
                        }
                }
        }
        image->update();
}