EMAN::NormalizeCircleMeanProcessor Class Reference

normalizes an image, mean value equals to mean of 2 pixel circular border. More...

#include <processor.h>

Inheritance diagram for EMAN::NormalizeCircleMeanProcessor:

Collaboration diagram for EMAN::NormalizeCircleMeanProcessor:

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...
TypeDict	get_param_types () const
	Get processor parameter information in a dictionary. 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...

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

Protected Member Functions
float	calc_mean (EMData *image) const
Protected Member Functions inherited from EMAN::NormalizeProcessor
virtual float	calc_sigma (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

normalizes an image, mean value equals to mean of 2 pixel circular border.

Definition at line 6089 of file processor.h.

Member Function Documentation

calc_mean()

float NormalizeCircleMeanProcessor::calc_mean ( EMData *  image ) const

protectedvirtual

Implements EMAN::NormalizeProcessor.

Definition at line 4832 of file processor.cpp.

{
        if (!image) {
                LOGWARN("NULL Image");
                return 0;
        }
//      return image->get_circle_mean();
        int nx=image->get_xsize();
        int ny=image->get_ysize();
        int nz=image->get_zsize();
 
        float radius = params.set_default("radius",((float)ny/2-2));
        float width = params.set_default("width",2.0f);
        if (radius<0) radius=ny/2+radius;
 
        static bool busy = false;               // reduce problems with threads and different image sizes
        static EMData *mask = 0;
        static int oldradius=radius;
        static int oldwidth=width;
 
        if (!mask || !EMUtil::is_same_size(image, mask)||radius!=oldradius||width!=oldwidth) {
                while (busy) ;
                busy=true;
                if (!mask) {
                        mask = new EMData();
                }
                mask->set_size(nx, ny, nz);
                mask->to_one();
 
                mask->process_inplace("mask.sharp", Dict("inner_radius", radius,
                                                         "outer_radius", radius + width));
 
        }
        busy=true;
        double n = 0,s=0;
        float *d = mask->get_data();
        float * data = image->get_data();
        size_t size = (size_t)nx*ny*nz;
        for (size_t i = 0; i < size; ++i) {
                if (d[i]!=0.0f) { n+=1.0; s+=data[i]; }
        }
 
        float result = (float)(s/n);
//      printf("cmean=%f\n",result);
        busy=false;
 
        return result;
}

References EMAN::EMUtil::is_same_size(), LOGWARN, EMAN::Processor::params, and EMAN::Dict::set_default().

get_desc()

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

                {
                        return "normalizes an image, mean value equals to mean of 2 pixel circular radius or of the circular border if no radius is set.";
                }

get_name()

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

                {
                        return NAME;
                }

References NAME.

get_param_types()

TypeDict EMAN::NormalizeCircleMeanProcessor::get_param_types ( ) const

inlinevirtual

Get processor parameter information in a dictionary.

Each parameter has one record in the dictionary. Each record contains its name, data-type, and description.

Returns

A dictionary containing the parameter info.

Reimplemented from EMAN::Processor.

Definition at line 6107 of file processor.h.

                {
                        TypeDict d;
                        d.put("radius", EMObject::FLOAT,"Radius (pixels) of inner edge of circular ring");
                        d.put("width", EMObject::FLOAT,"width (pixels) of ring to average over, default 2");
                        return d;
                }

References EMAN::EMObject::FLOAT, and EMAN::TypeDict::put().

NEW()

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

inlinestatic

Definition at line 6097 of file processor.h.

                {
                        return new NormalizeCircleMeanProcessor();
                }

Member Data Documentation

NAME

const string NormalizeCircleMeanProcessor::NAME = "normalize.circlemean"

static

Definition at line 6115 of file processor.h.

Referenced by get_name().

---

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

• processor.h
• processor.cpp