FourierWeightAverager makes an average of a set of images in Fourier space using a per-image radial weight. More...

#include <averager.h>

Inheritance diagram for EMAN::FourierWeightAverager:

Collaboration diagram for EMAN::FourierWeightAverager:

[legend]

Public Member Functions
	FourierWeightAverager ()

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

Private Attributes
EMData *	normimage

int	freenorm

int	nimg

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

EMData *	result

Detailed Description

FourierWeightAverager makes an average of a set of images in Fourier space using a per-image radial weight.

The provided XYData object for each inserted image should range from x=0 - 0.5*sqrt(2), and contains the radial weights from 0 - Nyquist at the point. If the x range is insufficient, values will be clamped at the ends of the available x-range. 2-D Images only, but will work with rectangular images.

Parameters

normimage After finish() will contain the sum of the weights in each Fourier location. Size must be ((nx+1)/2,y)

Definition at line 301 of file averager.h.

Constructor & Destructor Documentation

◆ FourierWeightAverager()

FourierWeightAverager::FourierWeightAverager ( )

Definition at line 462 of file averager.cpp.

        : normimage(0), freenorm(0), nimg(0)
{
 
}

Referenced by NEW().

Member Function Documentation

◆ add_image()

void FourierWeightAverager::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 468 of file averager.cpp.

{
        if (!image) {
                return;
        }
 
 
 
        EMData *img=image->do_fft();
        if (nimg >= 1 && !EMUtil::is_same_size(img, result)) {
                LOGERR("%sAverager can only process same-size Image",
                           get_name().c_str());
                return;
        }
        
        nimg++;
 
        int nx = img->get_xsize();
        int ny = img->get_ysize();
        int nz = 1;
//      size_t image_size = (size_t)nx * ny * nz;
 
        XYData *weight=(XYData *)image->get_attr("avg_weight");
        
        if (nimg == 1) {
                result = new EMData(nx,ny,nz);
                result->set_complex(true);
                result->to_zero();
 
                normimage = params.set_default("normimage", (EMData*)0);
                if (normimage==0) { normimage=new EMData(nx/2,ny,nz); freenorm=1; }
                normimage->to_zero();
        }
 
        // We're using routines that handle complex image wraparound for us, so we iterate over the half-plane
        for (int y=-ny/2; y<ny/2; y++) {
                for (int x=0; x<nx/2; x++) {
                        std::complex<float> v=img->get_complex_at(x,y);
                        float r=Util::hypot2(y/(float)ny,x/(float)nx);
                        float wt=weight->get_yatx(r);
                        result->set_complex_at(x,y,result->get_complex_at(x,y)+v*wt);
                        normimage->set_value_at(x,y+ny/2,normimage->get_value_at(x,y+ny/2)+wt);
                }
        }
 
        delete img;
}

References freenorm, get_name(), EMAN::XYData::get_yatx(), EMAN::Util::hypot2(), EMAN::EMUtil::is_same_size(), LOGERR, nimg, normimage, EMAN::Averager::params, EMAN::Averager::result, EMAN::Dict::set_default(), x, and y.

◆ finish()

EMData * FourierWeightAverager::finish ( )

virtual

Finish up the averaging and return the result.

Returns: The averaged image.

Implements EMAN::Averager.

Definition at line 516 of file averager.cpp.

{
        EMData *ret = (EMData *)0;
        
        if (result && nimg >= 1) {
        // We're using routines that handle complex image wraparound for us, so we iterate over the half-plane
                int nx = result->get_xsize();
                int ny = result->get_ysize();
                
                for (int y=-ny/2; y<ny/2; y++) {
                        for (int x=0; x<nx/2; x++) {
                                float norm=normimage->get_value_at(x,y+ny/2);
                                if (norm<=0) result->set_complex_at(x,y,0.0f);
                                else result->set_complex_at(x,y,result->get_complex_at(x,y)/norm);
                        }
                }
 
                result->update();
//              result->mult(1.0f/(float)result->get_attr("sigma"));
//              result->write_image("tmp.hdf",0);
//              printf("%g %g %g\n",(float)result->get_attr("sigma"),(float)result->get_attr("minimum"),(float)result->get_attr("maximum"));
                ret=result->do_ift();
                delete result;
                result=(EMData*) 0;
        }
        ret->set_attr("ptcl_repr",nimg);
 
        if (freenorm) { delete normimage; normimage=(EMData*)0; }
        nimg=0;
 
        return ret;
}

References freenorm, nimg, normimage, EMAN::Averager::result, x, and y.

◆ get_desc()

string EMAN::FourierWeightAverager::get_desc ( ) const

inlinevirtual

Implements EMAN::Averager.

Definition at line 314 of file averager.h.

                {
                        return "Weighted mean of images in Fourier space. Each image must have weighting curve in its header, an XYData object called 'avg_weight'.";
                }

◆ get_name()

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

                {
                        return NAME;
                }

References NAME.

Referenced by add_image().

◆ get_param_types()

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

                {
                        TypeDict d;
//                      d.put("weight", EMObject::XYDATA, "Radial weight. X: 0 - 0.5*sqrt(2). Y contains weights.");
                        d.put("normimage", EMObject::EMDATA, "After finish() will contain the sum of the weights in each Fourier location. Size must be ((nx+1)/2,y)");
                        return d;
                }

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

◆ NEW()

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

inlinestatic

Definition at line 319 of file averager.h.

                {
                        return new FourierWeightAverager();
                }

References FourierWeightAverager().

Member Data Documentation

◆ freenorm

int EMAN::FourierWeightAverager::freenorm

private

Definition at line 336 of file averager.h.

Referenced by add_image(), and finish().

◆ NAME

const string FourierWeightAverager::NAME = "weightedfourier"

static

Definition at line 332 of file averager.h.

Referenced by get_name().

◆ nimg

int EMAN::FourierWeightAverager::nimg

private

Definition at line 337 of file averager.h.

Referenced by add_image(), and finish().

◆ normimage

EMData* EMAN::FourierWeightAverager::normimage

private

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

◆ FourierWeightAverager()

Member Function Documentation

◆ add_image()

◆ finish()

◆ get_desc()

◆ get_name()

◆ get_param_types()

◆ NEW()

Member Data Documentation

◆ freenorm

◆ NAME

◆ nimg

◆ normimage