IterAverager performs iterative averaging of 3x3 pixel zones around each pixel, computing the mean of the 9 pixels initially, then iteratively refining the average to produce something self-consistent, but hopefully less noisy. More...

#include <averager.h>

Inheritance diagram for EMAN::IterAverager:

[legend]

Collaboration diagram for EMAN::IterAverager:

[legend]

Public Member Functions
	IterAverager ()

void	add_image (EMData *image)
	To add an image to the Averager. More...

EMData *	finish ()
	Finish up the averaging and return the result. More...

string	get_name () const
	Get the Averager's name. More...

string	get_desc () const

TypeDict	get_param_types () const
	Get Averager parameter information in a dictionary. More...

Public Member Functions inherited from EMAN::Averager
	Averager ()

virtual	~Averager ()

virtual void	add_image_list (const vector< EMData * > &images)
	To add multiple images to the Averager. More...

virtual void	set_params (const Dict &new_params)
	Set the Averager parameters using a key/value dictionary. More...

virtual void	mult (const float &s)
	Multiply the result image by some floating point constant This is useful when weighting the input images prior to calling add_image - a situation where it is likely you want to divide by the sum of the weights. More...

Static Public Member Functions
static Averager *	NEW ()

Static Public Attributes
static const string	NAME = "iterative"

Private Attributes
std::vector< EMData * >	images

Additional Inherited Members
Protected Attributes inherited from EMAN::Averager
Dict	params

EMData *	result

Detailed Description

IterAverager performs iterative averaging of 3x3 pixel zones around each pixel, computing the mean of the 9 pixels initially, then iteratively refining the average to produce something self-consistent, but hopefully less noisy.

Definition at line 260 of file averager.h.

Constructor & Destructor Documentation

◆ IterAverager()

IterAverager::IterAverager ( )

Definition at line 685 of file averager.cpp.

{
 
}

Referenced by NEW().

Member Function Documentation

◆ add_image()

void IterAverager::add_image ( EMData * image )

virtual

To add an image to the Averager.

This image will be averaged in this function.

Parameters

image The image to be averaged.

Reimplemented from EMAN::Averager.

Definition at line 690 of file averager.cpp.

{
        if (!image) return;
        
        images.push_back(image->do_fft());
}

References images.

◆ finish()

EMData * IterAverager::finish ( )

virtual

Finish up the averaging and return the result.

Returns: The averaged image.

Implements EMAN::Averager.

Definition at line 697 of file averager.cpp.

{
        if (images.size()==0) return NULL;
        
        int nx = images.front()->get_xsize();
        int ny = images.front()->get_ysize();
        int nz = images.front()->get_zsize();
        
        if (nz!=1) throw ImageDimensionException("IterAverager is for 2-D images only");
        
        if (result) delete result;
        result=new EMData(nx-2,ny,nz,0);
        result -> to_zero();
        
        EMData *tmp=new EMData(nx-2,ny,nz,0);
        tmp -> to_zero();
 
        for (int it=0; it<4; it++) {
                for (int y=-ny/2+1; y<ny/2-1; y++) {
                        for (int x=0; x<nx-2; x++) {
                                std::complex<double> nv=0;
                                // put the vector on the inside, then we can accumulate into a double easily
                                for (vector<EMData *>::iterator im=images.begin(); im<images.end(); im++) {
                                        for (int yy=y-1; yy<=y+1; yy++) {
                                                for (int xx=x-1; xx<=x+1; xx++) {
                                                        nv+=(*im)->get_complex_at(xx,yy)+tmp->get_complex_at(x,y)-tmp->get_complex_at(xx,yy);
                                                }
                                        }
                                }
                                result->set_complex_at(x,y,std::complex<float>(nv/(9.0*images.size())));
                        }
                }
                // Swap the pointers
                result->write_image("dbug.hdf",-1);
                EMData *swp=tmp;
                tmp=result;
                result=swp;
        }
        
        delete result;
        result=0;
        for (vector<EMData *>::iterator im=images.begin(); im<images.end(); im++) delete (*im);
        images.clear();
        result=tmp->do_ift();
        delete tmp;
        return result;
}

References ImageDimensionException, images, EMAN::Averager::result, to_zero(), x, and y.

◆ get_desc()

string EMAN::IterAverager::get_desc ( ) const

inlinevirtual

Implements EMAN::Averager.

Definition at line 273 of file averager.h.

                {
                        return "EXPERIMENTAL!  Not suggested for normal use. An iterative averager making use of local correlations for noise reduction";
                }

◆ get_name()

string EMAN::IterAverager::get_name ( ) const

inlinevirtual

Get the Averager's name.

Each Averager is identified by a unique name.

Returns: The Averager's name.

Implements EMAN::Averager.

Definition at line 268 of file averager.h.

                {
                        return NAME;
                }

References NAME.

◆ get_param_types()

TypeDict EMAN::IterAverager::get_param_types ( ) const

inlinevirtual

Get Averager 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::Averager.

Definition at line 283 of file averager.h.

                {
                        TypeDict d;
                        return d;
                }

◆ NEW()

static Averager * EMAN::IterAverager::NEW ( )

inlinestatic

Definition at line 278 of file averager.h.

                {
                        return new IterAverager();
                }

References IterAverager().

Member Data Documentation

◆ images

std::vector<EMData*> EMAN::IterAverager::images

private

Definition at line 292 of file averager.h.

Referenced by add_image(), and finish().

◆ NAME

const string IterAverager::NAME = "iterative"

static

Definition at line 289 of file averager.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

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IterAverager()

Member Function Documentation

◆ add_image()

◆ finish()

◆ get_desc()

◆ get_name()

◆ get_param_types()

◆ NEW()

Member Data Documentation

◆ images

◆ NAME