Base class for normalization processors. More...

#include <processor.h>

Inheritance diagram for EMAN::NormalizeProcessor:

[legend]

Collaboration diagram for EMAN::NormalizeProcessor:

Public Member Functions
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 float	calc_sigma (EMData *image) const

virtual float	calc_mean (EMData *image) const =0

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::Processor
Dict	params

Detailed Description

Base class for normalization processors.

Each specific normalization processor needs to define how to calculate mean and how to calculate sigma.

Definition at line 5826 of file processor.h.

Member Function Documentation

◆ calc_mean()

virtual float EMAN::NormalizeProcessor::calc_mean ( EMData * image ) const

protectedpure virtual

Implemented in EMAN::NormalizeUnitProcessor, EMAN::NormalizeUnitSumProcessor, EMAN::NormalizeStdProcessor, EMAN::NormalizeHistPeakProcessor, EMAN::NormalizeEdgeMeanProcessor, EMAN::NormalizeCircleMeanProcessor, EMAN::NormalizeLREdgeMeanProcessor, and EMAN::NormalizeMaxMinProcessor.

Referenced by process_inplace().

◆ calc_sigma()

float NormalizeProcessor::calc_sigma ( EMData * image ) const

protectedvirtual

Reimplemented in EMAN::NormalizeUnitProcessor, EMAN::NormalizeUnitSumProcessor, and EMAN::NormalizeMaxMinProcessor.

Definition at line 4630 of file processor.cpp.

{
        return image->get_attr("sigma");
}

Referenced by process_inplace().

◆ get_group_desc()

static string EMAN::NormalizeProcessor::get_group_desc ( )

inlinestatic

Definition at line 5831 of file processor.h.

                {
                        return "Base class for normalization processors. Each specific normalization processor needs to define how to calculate mean and how to calculate sigma.";
                }

◆ process_inplace()

void NormalizeProcessor::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 4635 of file processor.cpp.

{
        if (!image) {
                LOGWARN("cannot do normalization on NULL image");
                return;
        }
 
        if (image->is_complex()) {
                LOGWARN("cannot do normalization on complex image");
                return;
        }
 
        float sigma = calc_sigma(image);
        if (sigma == 0 || !Util::goodf(&sigma)) {
                LOGWARN("cannot do normalization on image with sigma = 0");
                return;
        }
 
        float mean = calc_mean(image);
 
        size_t size = (size_t)image->get_xsize() * image->get_ysize() * image->get_zsize();
        float *data = image->get_data();
 
        for (size_t i = 0; i < size; ++i) {
                data[i] = (data[i] - mean) / sigma;
        }
 
        image->update();
}

References calc_mean(), calc_sigma(), EMAN::Util::goodf(), and LOGWARN.

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions