EMAN::NormalizeRampNormVar Class Reference

Normalize the image whilst also removing any ramps. More...

#include <processor.h>

Inheritance diagram for EMAN::NormalizeRampNormVar:

Collaboration diagram for EMAN::NormalizeRampNormVar:

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...
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::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.ramp.normvar"

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 the image whilst also removing any ramps.

Ramps are removed first, then mean and sigma becomes 0 and 1 respectively This is essential Pawel Penczek's preferred method of particle normalization

Author

David Woolford

Date

Mid 2008

Definition at line 5996 of file processor.h.

Member Function Documentation

get_desc()

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

                        {
                                return "First call filter.ramp on the image, then make the mean 0 and norm 1";
                        }

get_name()

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

                        {
                                return NAME;
                        }

References NAME.

NEW()

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

inlinestatic

Definition at line 6004 of file processor.h.

                        {
                                return new NormalizeRampNormVar();
                        }

process_inplace()

void NormalizeRampNormVar::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 4733 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;
        }
 
        image->process_inplace( "filter.ramp" );
        int nx = image->get_xsize();
        EMData mask(nx,nx);
        mask.process_inplace("testimage.circlesphere", Dict("radius",nx/2-2,"fill",1));
 
        vector<float> rstls = Util::infomask( image, &mask, false);
        image->add((float)-rstls[0]);
        image->mult((float)1.0/rstls[1]);
        image->update();
}

References LOGWARN.

Member Data Documentation

NAME

const string NormalizeRampNormVar::NAME = "normalize.ramp.normvar"

static

Definition at line 6016 of file processor.h.

Referenced by get_name().

---

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

• processor.h
• processor.cpp