EMAN::LinearPyramidProcessor Class Reference

Multiplies image by a 'linear pyramid' 1-(|x-xsize/2|*|y-ysize/2|*4/(xsize*ysize)) This is useful in averaging together boxed out regions with 50% overlap. More...

#include <processor.h>

Inheritance diagram for EMAN::LinearPyramidProcessor:

Collaboration diagram for EMAN::LinearPyramidProcessor:

Public Member Functions
string	get_name () const
	Get the processor's name. More...
void	process_inplace (EMData *image)
	To process an image in-place. More...
virtual TypeDict	get_param_types () const
	Get processor parameter information in a dictionary. More...
string	get_desc () const
	Get the descrition of this specific processor. More...
Public Member Functions inherited from EMAN::Processor
virtual	~Processor ()
virtual EMData *	process (const EMData *const image)
	To proccess an image out-of-place. More...
virtual void	process_list_inplace (vector< EMData * > &images)
	To process multiple images using the same algorithm. More...
virtual Dict	get_params () const
	Get the processor parameters in a key/value dictionary. More...
virtual void	set_params (const Dict &new_params)
	Set the processor parameters using a key/value dictionary. More...

Static Public Member Functions
static Processor *	NEW ()
Static Public Member Functions inherited from EMAN::Processor
static string	get_group_desc ()
	Get the description of this group of processors. More...
static void	EMFourierFilterInPlace (EMData *fimage, Dict params)
	Compute a Fourier-filter processed image in place. More...
static EMData *	EMFourierFilter (EMData *fimage, Dict params)
	Compute a Fourier-processor processed image without altering the original image. More...

Static Public Attributes
static const string	NAME = "math.linearpyramid"

Additional Inherited Members
Public Types inherited from EMAN::Processor
enum	fourier_filter_types {   TOP_HAT_LOW_PASS , TOP_HAT_HIGH_PASS , TOP_HAT_BAND_PASS , TOP_HOMOMORPHIC ,   GAUSS_LOW_PASS , GAUSS_HIGH_PASS , GAUSS_BAND_PASS , GAUSS_INVERSE ,   GAUSS_HOMOMORPHIC , BUTTERWORTH_LOW_PASS , BUTTERWORTH_HIGH_PASS , BUTTERWORTH_HOMOMORPHIC ,   KAISER_I0 , KAISER_SINH , KAISER_I0_INVERSE , KAISER_SINH_INVERSE ,   SHIFT , TANH_LOW_PASS , TANH_HIGH_PASS , TANH_HOMOMORPHIC ,   TANH_BAND_PASS , RADIAL_TABLE , CTF_ }
	Fourier filter Processor type enum. More...
Protected Attributes inherited from EMAN::Processor
Dict	params

Detailed Description

Multiplies image by a 'linear pyramid' 1-(|x-xsize/2|*|y-ysize/2|*4/(xsize*ysize)) This is useful in averaging together boxed out regions with 50% overlap.

Definition at line 4217 of file processor.h.

Member Function Documentation

get_desc()

string EMAN::LinearPyramidProcessor::get_desc ( ) const

inlinevirtual

Get the descrition of this specific processor.

This function must be overwritten by a subclass.

Returns

The description of this processor.

Implements EMAN::Processor.

Definition at line 4244 of file processor.h.

                {
                        return "Multiplies image by a 'linear pyramid' in 1-3 dimensions. The origin and total base width of the pyramid can be specified. Default is centered with the total image size.";
                }

get_name()

string EMAN::LinearPyramidProcessor::get_name ( ) const

inlinevirtual

Get the processor's name.

Each processor is identified by a unique name.

Returns

The processor's name.

Implements EMAN::Processor.

Definition at line 4220 of file processor.h.

                {
                        return NAME;
                }

References NAME.

get_param_types()

virtual TypeDict EMAN::LinearPyramidProcessor::get_param_types ( ) const

inlinevirtual

Get processor 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::Processor.

Definition at line 4232 of file processor.h.

                {
                        TypeDict d;
                        d.put("x0", EMObject::FLOAT);
                        d.put("y0", EMObject::FLOAT);
                        d.put("z0", EMObject::FLOAT);
                        d.put("xwidth", EMObject::FLOAT);
                        d.put("ywidth", EMObject::FLOAT);
                        d.put("zwidth", EMObject::FLOAT);
                        return d;
                }

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

NEW()

static Processor * EMAN::LinearPyramidProcessor::NEW ( )

inlinestatic

Definition at line 4227 of file processor.h.

                {
                        return new LinearPyramidProcessor();
                }

process_inplace()

void LinearPyramidProcessor::process_inplace ( EMData *  image )

virtual

To process an image in-place.

For those processors which can only be processed out-of-place, override this function to just print out some error message to remind user call the out-of-place version.

Parameters

image

The image to be processed.

Implements EMAN::Processor.

Definition at line 1927 of file processor.cpp.

                                                          {
 
//      if (image->get_zsize()!=1) { throw ImageDimensionException("Only 2-D images supported"); }
 
        int nx=image->get_xsize();
        int ny=image->get_ysize();
        int nz=image->get_zsize();
        float x0 = params.set_default("x0",nx/2);
        float y0 = params.set_default("y0",ny/2);
        float z0 = params.set_default("z0",nz/2);
        float xwidth = params.set_default("xwidth",nx);
        float ywidth = params.set_default("ywidth",ny);
        float zwidth = params.set_default("zwidth",nz);
 
        for (int z=0; z<nz; z++) {
                for (int y=0; y<ny; y++) {
                        for (int x=0; x<nx; x++) {
                                float xf=1.0-fabs(x-x0)*2.0/xwidth;
                                float yf=1.0-fabs(y-y0)*2.0/ywidth;
                                float zf=1.0-fabs(z-z0)*2.0/zwidth;
                                float val=0.0;
                                if (xf>0&&yf>0&&zf>0) val=xf*yf*zf;
                                image->mult_value_at_fast(x,y,z,val);
                        }
                }
        }
}

References EMAN::Processor::params, EMAN::Dict::set_default(), x, and y.

Member Data Documentation

NAME

const string LinearPyramidProcessor::NAME = "math.linearpyramid"

static

Definition at line 4249 of file processor.h.

Referenced by get_name().

---

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

• processor.h
• processor.cpp