Averager class defines a way to do averaging on a set of images. More...

#include <averager.h>

Inheritance diagram for EMAN::Averager:

[legend]

Collaboration diagram for EMAN::Averager:

[legend]

Public Member Functions
	Averager ()

virtual	~Averager ()

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

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

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

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

virtual string	get_desc () const =0

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

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

Protected Attributes
Dict	params

EMData *	result

Detailed Description

Averager class defines a way to do averaging on a set of images.

A user may add one or more images to the Averager at one time. The images are averaged at the time of adding to the Averager. After all images are added, Average will return the averaged result.

Averager class is the base class for all averager classes. Each specific averager has a unique ID name. This name is used to call a averager.

All Averager classes in EMAN are managed by a Factory
pattern. So each Averager class must define:
  - a unique name to idenfity itself in the factory.
  - a static method to register itself in the factory.

Typical usages of Averager:

How to get all Averager types
vector<string> all_averagers = Factory<Averager>::get_list();

EMAN::Factory::get_list
static vector< string > get_list()
Definition: emobject.h:837
How to use an Averager
Averager *imgavg = Factory<Averager>::get("image");

vector<EMData *> images(2);

EMData *image1 = ...;

EMData *image2 = ...;

images[0] = image1;

images[1] = image2;

imgavg->add_image(image1);

imgavg->add_image(image2);

EMData *result = imgavg->finish();

EMAN::Averager::result
EMData * result
Definition: averager.h:158

EMAN::Averager::Averager
Averager()
Definition: averager.h:95

EMAN::Factory::get
static T * get(const string &instance_name)
Definition: emobject.h:781

images
#define images(i, j, k)
Definition: projector.cpp:1897
How to define a new XYZAverager
XYZAverager should extend Averager and implement the following functions: (Please replace 'XYZ' with your own class name).
void add_image(EMData * image);

EMData * finish();

string get_name() const { return "XYZ"; }

static Averager *NEW() { return new XYZAverager(); }

EMAN::Averager::finish
virtual EMData * finish()=0
Finish up the averaging and return the result.

EMAN::Averager::get_name
virtual string get_name() const =0
Get the Averager's name.

EMAN::Averager::add_image
virtual void add_image(EMData *image)
To add an image to the Averager.
Definition: averager.cpp:81

Definition at line 92 of file averager.h.

Constructor & Destructor Documentation

◆ Averager()

EMAN::Averager::Averager ( )

inline

Definition at line 95 of file averager.h.

95: result(0) {}

◆ ~Averager()

virtual EMAN::Averager::~Averager ( )

inlinevirtual

Definition at line 97 of file averager.h.

98 {

99 }

Member Function Documentation

◆ add_image()

void Averager::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 in EMAN::ImageAverager, EMAN::LocalWeightAverager, EMAN::IterAverager, EMAN::FourierWeightAverager, EMAN::TomoAverager, EMAN::MinMaxAverager, EMAN::MedianAverager, EMAN::CtfWtAverager, EMAN::CtfWtFiltAverager, EMAN::CtfCAutoAverager, EMAN::CtfCWautoAverager, EMAN::SigmaAverager, and EMAN::XYZAverager.

Definition at line 81 of file averager.cpp.

{
return;
}

Referenced by add_image_list(), and EMAN::ApplySymProcessor::process().

◆ add_image_list()

void Averager::add_image_list ( const vector< EMData * > & images )

virtual

To add multiple images to the Averager.

All the newly-added images are averaged in this function.

Parameters

images The images to be averaged.

Definition at line 86 of file averager.cpp.

{
        for (size_t i = 0; i < image_list.size(); i++) {
                add_image(image_list[i]);
        }
}

References add_image().

◆ finish()

virtual EMData * EMAN::Averager::finish ( )

pure virtual

Finish up the averaging and return the result.

Returns: The averaged image.

Implemented in EMAN::ImageAverager, EMAN::LocalWeightAverager, EMAN::IterAverager, EMAN::FourierWeightAverager, EMAN::TomoAverager, EMAN::MinMaxAverager, EMAN::MedianAverager, EMAN::CtfWtAverager, EMAN::CtfWtFiltAverager, EMAN::CtfCAutoAverager, EMAN::CtfCWautoAverager, EMAN::SigmaAverager, and EMAN::XYZAverager.

Referenced by EMAN::ApplySymProcessor::process().

◆ get_desc()

virtual string EMAN::Averager::get_desc ( ) const

pure virtual

Implemented in EMAN::ImageAverager, EMAN::LocalWeightAverager, EMAN::IterAverager, EMAN::FourierWeightAverager, EMAN::TomoAverager, EMAN::MinMaxAverager, EMAN::MedianAverager, EMAN::CtfWtAverager, EMAN::CtfWtFiltAverager, EMAN::CtfCAutoAverager, EMAN::CtfCWautoAverager, EMAN::SigmaAverager, and EMAN::XYZAverager.

◆ get_name()

virtual string EMAN::Averager::get_name ( ) const

pure virtual

Get the Averager's name.

Each Averager is identified by a unique name.

Returns: The Averager's name.

Implemented in EMAN::ImageAverager, EMAN::LocalWeightAverager, EMAN::IterAverager, EMAN::FourierWeightAverager, EMAN::TomoAverager, EMAN::MinMaxAverager, EMAN::MedianAverager, EMAN::CtfWtAverager, EMAN::CtfWtFiltAverager, EMAN::CtfCAutoAverager, EMAN::CtfCWautoAverager, EMAN::SigmaAverager, and EMAN::XYZAverager.

◆ get_param_types()

virtual TypeDict EMAN::Averager::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 in EMAN::ImageAverager, EMAN::LocalWeightAverager, EMAN::IterAverager, EMAN::FourierWeightAverager, EMAN::TomoAverager, EMAN::MinMaxAverager, EMAN::MedianAverager, EMAN::SigmaAverager, and EMAN::XYZAverager.

Definition at line 150 of file averager.h.

                {
                        TypeDict d;
                        return d;
                }

◆ mult()

void Averager::mult ( const float & s )

virtual

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.

Hence call mult after all of the weighted images have been added.

Parameters

s	the scaling factor.

Exceptions

NullPointerException if the EMData pointer (result) is NULL

Reimplemented in EMAN::ImageAverager, EMAN::TomoAverager, EMAN::MinMaxAverager, and EMAN::SigmaAverager.

Definition at line 71 of file averager.cpp.

{
        if ( result != 0 )
        {
                result->mult(s);
        }
        else throw NullPointerException("Error, attempted to multiply the result image, which is NULL");
}

References NullPointerException, and result.

◆ set_params()

virtual void EMAN::Averager::set_params ( const Dict & new_params )

inlinevirtual

Set the Averager parameters using a key/value dictionary.

Parameters

new_params A dictionary containing the new parameters.

Reimplemented in EMAN::CtfWtAverager, EMAN::CtfWtFiltAverager, EMAN::CtfCAutoAverager, and EMAN::CtfCWautoAverager.

Definition at line 129 of file averager.h.

                {
                        params = new_params;
                }

References params.

Member Data Documentation

◆ params

Dict EMAN::Averager::params

mutableprotected

Definition at line 157 of file averager.h.

Referenced by EMAN::ImageAverager::add_image(), EMAN::LocalWeightAverager::add_image(), EMAN::FourierWeightAverager::add_image(), EMAN::TomoAverager::add_image(), EMAN::MinMaxAverager::add_image(), EMAN::SigmaAverager::add_image(), EMAN::LocalWeightAverager::finish(), EMAN::TomoAverager::finish(), set_params(), EMAN::CtfWtAverager::set_params(), EMAN::CtfWtFiltAverager::set_params(), EMAN::CtfCAutoAverager::set_params(), and EMAN::CtfCWautoAverager::set_params().

◆ result

EMData* EMAN::Averager::result

protected

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Averager()

◆ ~Averager()

Member Function Documentation

◆ add_image()

◆ add_image_list()

◆ finish()

◆ get_desc()

◆ get_name()

◆ get_param_types()

◆ mult()

◆ set_params()

Member Data Documentation

◆ params

◆ result