Normalize an image so its vector length is 1.0. More...

#include <processor.h>

Inheritance diagram for EMAN::NormalizeUnitProcessor:

Collaboration diagram for EMAN::NormalizeUnitProcessor:

[legend]

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

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

Static Public Member Functions
static Processor *	NEW ()

Static Public Member Functions inherited from EMAN::NormalizeProcessor
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 = "normalize.unitlen"

Protected Member Functions
float	calc_sigma (EMData *image) const

float	calc_mean (EMData *image) const

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

Normalize an image so its vector length is 1.0.

Definition at line 5843 of file processor.h.

Member Function Documentation

◆ calc_mean()

float EMAN::NormalizeUnitProcessor::calc_mean ( EMData * image ) const

inlineprotectedvirtual

Implements EMAN::NormalizeProcessor.

Definition at line 5868 of file processor.h.

5868{ return 0; }

◆ calc_sigma()

float NormalizeUnitProcessor::calc_sigma ( EMData * image ) const

protectedvirtual

Reimplemented from EMAN::NormalizeProcessor.

Definition at line 4665 of file processor.cpp.

{
        if (!image) {
                LOGWARN("NULL Image");
                return 0;
        }
        float ret=sqrt((float)image->get_attr("square_sum"));
        return ret==0.0f?1.0f:ret;
}

References LOGWARN, and sqrt().

◆ get_desc()

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

                {
                        return "Normalize an image so its vector length is 1.0.";
                }

◆ get_name()

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

                {
                        return NAME;
                }

References NAME.

◆ NEW()

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

inlinestatic

Definition at line 5851 of file processor.h.

                {
                        return new NormalizeUnitProcessor();
                }

Member Data Documentation

◆ NAME

const string NormalizeUnitProcessor::NAME = "normalize.unitlen"

static

Definition at line 5861 of file processor.h.

Referenced by get_name().

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members