MedianAverager averages a list of images to the maximum(or minimum of the absolute pixel value) It optionally makes a sigma image. More...

#include <averager.h>

Inheritance diagram for EMAN::MedianAverager:

[legend]

Collaboration diagram for EMAN::MedianAverager:

[legend]

Public Member Functions
	MedianAverager ()

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 = "median"

Private Attributes
std::vector< EMData * >	imgs

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

EMData *	result

Detailed Description

MedianAverager averages a list of images to the maximum(or minimum of the absolute pixel value) It optionally makes a sigma image.

Parameters

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

Definition at line 446 of file averager.h.

Constructor & Destructor Documentation

◆ MedianAverager()

MedianAverager::MedianAverager ( )

Definition at line 909 of file averager.cpp.

{
        
}

Referenced by NEW().

Member Function Documentation

◆ add_image()

void MedianAverager::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 914 of file averager.cpp.

{
        if (!image) {
                return;
        }
 
        if (!imgs.empty() && !EMUtil::is_same_size(image, imgs[0])) {
                LOGERR("MedianAverager can only process images of the same size");
                return;
        }
 
        imgs.push_back(image->copy());
}

References imgs, EMAN::EMUtil::is_same_size(), and LOGERR.

◆ finish()

EMData * MedianAverager::finish ( )

virtual

Finish up the averaging and return the result.

Returns: The averaged image.

Implements EMAN::Averager.

Definition at line 928 of file averager.cpp.

{
        if (imgs.size()==0) return 0;
        EMData *ret=0;
        
        if (imgs.size()==1) {
                ret=imgs[0];
                imgs.clear();
                return ret;
        }
        
        // special case for n==2
        if (imgs.size()==2) {
                imgs[0]->add(*imgs[1]);
                imgs[0]->mult(0.5f);
                delete imgs[1];
                ret=imgs[0];
                imgs.clear();
                return ret;
        }
 
        int nx=imgs[0]->get_xsize();
        int ny=imgs[0]->get_ysize();
        int nz=imgs[0]->get_zsize();
        
        // special case for n==3
        if (imgs.size()==3) {
                for (int z=0; z<nz; z++) {
                        for (int y=0; y<ny; y++) {
                                for (int x=0; x<nx; x++) {
                                        float v0=imgs[0]->get_value_at(x,y,z);
                                        float v1=imgs[1]->get_value_at(x,y,z);
                                        float v2=imgs[2]->get_value_at(x,y,z);
                                        
                                        if (v0<=v1) {
                                                if (v0>=v2) continue;
                                                if (v1<=v2) imgs[0]->set_value_at(x,y,z,v1);
                                                else imgs[0]->set_value_at(x,y,z,v2);
                                        }
                                        else {
                                                if (v0<=v2) continue;
                                                if (v2<=v1) imgs[0]->set_value_at(x,y,z,v1);
                                                else imgs[0]->set_value_at(x,y,z,v2);
                                        }
                                }
                        }
                }
                
                delete imgs[1];
                delete imgs[2];
                ret=imgs[0];
                imgs.clear();
                return ret;
        }
 
        ret=imgs[0]->copy();
        std::vector<float> vals(imgs.size(),0.0f);
        
        
        for (int z=0; z<nz; z++) {
                for (int y=0; y<ny; y++) {
                        for (int x=0; x<nx; x++) {
                                int i=0;
                                for (std::vector<EMData *>::iterator it = imgs.begin() ; it != imgs.end(); ++it,++i) {
                                        vals[i]=(*it)->get_value_at(x,y,z);
                                }
                                        
                                std::sort(vals.begin(),vals.end());
                                //printf("%d %d %d    %d\n",x,y,z,vals.size());
                                if (vals.size()&1) ret->set_value_at(x,y,z,vals[vals.size()/2]);                // for even sizes, not quite right, and should include possibility of local average
                                else ret->set_value_at(x,y,z,(vals[vals.size()/2]+vals[vals.size()/2-1])/2.0f);
                        }
                }
        }
 
        if (!imgs.empty()) {
                for (std::vector<EMData *>::iterator it = imgs.begin() ; it != imgs.end(); ++it) if (*it) delete *it;
                imgs.clear();
        }
 
 
        return ret;
}

References imgs, v0, x, and y.

◆ get_desc()

string EMAN::MedianAverager::get_desc ( ) const

inlinevirtual

Implements EMAN::Averager.

Definition at line 459 of file averager.h.

                {
                        return "Computes the median value instead of the mean. If even number of images, averages the middle two.";
                }

◆ get_name()

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

                {
                        return NAME;
                }

References NAME.

◆ get_param_types()

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

                {
                        TypeDict d;
                        //d.put("min", EMObject::INT, "If set, will average to minimum absolute value, by default average to max");
                        return d;
                }

◆ NEW()

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

inlinestatic

Definition at line 464 of file averager.h.

                {
                        return new MedianAverager();
                }

References MedianAverager().

Member Data Documentation

◆ imgs

std::vector<EMData*> EMAN::MedianAverager::imgs

private

Definition at line 479 of file averager.h.

Referenced by add_image(), and finish().

◆ NAME

const string MedianAverager::NAME = "median"

static

Definition at line 476 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

◆ MedianAverager()

Member Function Documentation

◆ add_image()

◆ finish()

◆ get_desc()

◆ get_name()

◆ get_param_types()

◆ NEW()

Member Data Documentation

◆ imgs

◆ NAME