EMAN2
Public Member Functions | Static Public Member Functions | Static Public Attributes
EMAN::NormalizeRampNormVar Class Reference

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

#include <processor.h>

Inheritance diagram for EMAN::NormalizeRampNormVar:
Inheritance graph
[legend]
Collaboration diagram for EMAN::NormalizeRampNormVar:
Collaboration graph
[legend]

List of all members.

Public Member Functions

string get_name () const
 Get the processor's name.
string get_desc () const
 Get the descrition of this specific processor.
void process_inplace (EMData *image)
 To process an image in-place.

Static Public Member Functions

static ProcessorNEW ()

Static Public Attributes

static const string NAME = "normalize.ramp.normvar"

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 4444 of file processor.h.


Member Function Documentation

string EMAN::NormalizeRampNormVar::get_desc ( ) const [inline, virtual]

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 4457 of file processor.h.

                        {
                                return "First call filter.ramp on the image, then make the mean 0 and norm 1";
                        }
string EMAN::NormalizeRampNormVar::get_name ( ) const [inline, virtual]

Get the processor's name.

Each processor is identified by a unique name.

Returns:
The processor's name.

Implements EMAN::Processor.

Definition at line 4447 of file processor.h.

References NAME.

                        {
                                return NAME;
                        }
static Processor* EMAN::NormalizeRampNormVar::NEW ( ) [inline, static]

Definition at line 4452 of file processor.h.

                        {
                                return new NormalizeRampNormVar();
                        }
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:
imageThe image to be processed.

Implements EMAN::Processor.

Definition at line 3742 of file processor.cpp.

References EMAN::EMData::add(), EMAN::EMData::get_xsize(), infomask(), EMAN::EMData::is_complex(), LOGWARN, EMAN::EMData::mult(), EMAN::EMData::process_inplace(), and EMAN::EMData::update().

{
        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();
}

Member Data Documentation

const string NormalizeRampNormVar::NAME = "normalize.ramp.normvar" [static]

Definition at line 4464 of file processor.h.

Referenced by get_name().


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