ImageAverager averages a list of images. More...

#include <averager.h>

Inheritance diagram for EMAN::MinMaxAverager:

Collaboration diagram for EMAN::MinMaxAverager:

[legend]

Public Member Functions
	MinMaxAverager ()

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

virtual void	mult (const float &)
	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...

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

Static Public Member Functions
static Averager *	NEW ()

Static Public Attributes
static const string	NAME = "minmax"

Private Attributes
int	ismax

int	isabs

int	nimg

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

EMData *	result

Detailed Description

ImageAverager averages a list of images.

It optionally makes a sigma image.

Parameters

max	If set, will find the max value, otherwise finds min

Definition at line 400 of file averager.h.

Constructor & Destructor Documentation

◆ MinMaxAverager()

MinMaxAverager::MinMaxAverager ( )

Definition at line 849 of file averager.cpp.

        : nimg(0),ismax(0),isabs(0)
{
        
}

Referenced by NEW().

Member Function Documentation

◆ add_image()

void MinMaxAverager::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 855 of file averager.cpp.

{
        if (!image) {
                return;
        }
 
        if (nimg >= 1 && !EMUtil::is_same_size(image, result)) {
                LOGERR("%sAverager can only process same-size Image",
                           get_name().c_str());
                return;
        }
        EMData *owner = params.set_default("owner", (EMData*)0);
 
        float thisown = image->get_attr_default("ortid",(float)nimg);
        nimg++;
 
        size_t nxyz = image->get_size();
        
        if (nimg == 1) {
                result = image->copy();
                if (owner) owner->to_value(thisown);
                return;
        }
 
        float *rdata = result->get_data();
        float *data = image->get_data();
        float *owndata = 0;
        if (owner) owndata=owner->get_data();
 
        ismax=(int)params.set_default("max",0);
        isabs=(int)params.set_default("abs",0);
        
        
        for (size_t i=0; i<nxyz; i++) {
                float v = isabs?fabs(data[i]):data[i];
                float rv = isabs?fabs(rdata[i]):rdata[i];
                if ((ismax && v>rv) || (!ismax && v<rv)) {
                        rdata[i]=data[i];
                        if (owndata) owndata[i]=thisown;
                }
        }
 
}

References get_name(), EMAN::EMUtil::is_same_size(), isabs, ismax, LOGERR, nimg, EMAN::Averager::params, rdata, EMAN::Averager::result, and EMAN::Dict::set_default().

◆ finish()

EMData * MinMaxAverager::finish ( )

virtual

Finish up the averaging and return the result.

Returns: The averaged image.

Implements EMAN::Averager.

Definition at line 899 of file averager.cpp.

{
        result->update();
        result->set_attr("ptcl_repr",nimg);
        
        if (result && nimg >= 1) return result;
 
        return NULL;
}

References nimg, and EMAN::Averager::result.

◆ get_desc()

string EMAN::MinMaxAverager::get_desc ( ) const

inlinevirtual

Implements EMAN::Averager.

Definition at line 413 of file averager.h.

                {
                        return "Finds the minimum or maximum value in each pixel";
                }

◆ get_name()

string EMAN::MinMaxAverager::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 408 of file averager.h.

                {
                        return NAME;
                }

References NAME.

Referenced by add_image().

◆ get_param_types()

TypeDict EMAN::MinMaxAverager::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 423 of file averager.h.

                {
                        TypeDict d;
                        d.put("max", EMObject::INT, "If set, will find the max value, otherwise finds min");
                        d.put("abs", EMObject::INT, "If set, will find the value with the min or max absolute value. The actual value is preserved.");
                        d.put("owner", EMObject::EMDATA, "Contains the number of the input image which 'owns' the max/min value. Value will be insertion sequence number unless 'ortid' is set in each image being averaged.");
                        return d;
                }

References EMAN::EMObject::EMDATA, EMAN::EMObject::INT, and EMAN::TypeDict::put().

◆ mult()

virtual void EMAN::MinMaxAverager::mult ( const float & s )

inlinevirtual

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 from EMAN::Averager.

Definition at line 432 of file averager.h.

432{ }

◆ NEW()

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

inlinestatic

Definition at line 418 of file averager.h.

                {
                        return new MinMaxAverager();
                }

References MinMaxAverager().

Member Data Documentation

◆ isabs

int EMAN::MinMaxAverager::isabs

private

Definition at line 438 of file averager.h.

Referenced by add_image().

◆ ismax

int EMAN::MinMaxAverager::ismax

private

Definition at line 437 of file averager.h.

Referenced by add_image().

◆ NAME

const string MinMaxAverager::NAME = "minmax"

static

Definition at line 434 of file averager.h.

Referenced by get_name().

◆ nimg

int EMAN::MinMaxAverager::nimg

private

Definition at line 439 of file averager.h.

Referenced by add_image(), and finish().

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

◆ MinMaxAverager()

Member Function Documentation

◆ add_image()

◆ finish()

◆ get_desc()

◆ get_name()

◆ get_param_types()

◆ mult()

◆ NEW()

Member Data Documentation

◆ isabs

◆ ismax

◆ NAME

◆ nimg