EMAN::Axis0FourierProcessor Class Reference

Zeroes the values on the X=0 and y=0 Fourier axes (except x=y=0) More...

#include <processor.h>

Inheritance diagram for EMAN::Axis0FourierProcessor:

Collaboration diagram for EMAN::Axis0FourierProcessor:

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...
void	set_params (const Dict &new_params)
	Set the processor parameters using a key/value dictionary. More...
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...

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 = "filter.xyaxes0"

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

Zeroes the values on the X=0 and y=0 Fourier axes (except x=y=0)

Definition at line 500 of file processor.h.

Member Function Documentation

get_desc()

string EMAN::Axis0FourierProcessor::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 530 of file processor.h.

                {
                        return "Sets values along X/Y Fourier axes to 0, except origin";
                }

get_name()

string EMAN::Axis0FourierProcessor::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 503 of file processor.h.

                {
                        return NAME;
                }

References NAME.

get_param_types()

TypeDict EMAN::Axis0FourierProcessor::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 515 of file processor.h.

                {
                        TypeDict d;
                        d.put("x", EMObject::INT, "If set, zeroes along X axis. Default True.");
                        d.put("y", EMObject::INT, "If set, zeroes along Y axis. Default True.");
                        d.put("neighbor", EMObject::INT, "If set, interpolates neighbor values rather than zeroing");
                        d.put("neighbornorm", EMObject::INT, "In neighbor mode it sums the neighboring 2 (complex) pixels, then divides by this factor. default = sqrt(2), which is good for very noisy images");
                        return d;
                }

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

NEW()

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

inlinestatic

Definition at line 525 of file processor.h.

                {
                        return new Axis0FourierProcessor();
                }

process_inplace()

void Axis0FourierProcessor::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 1250 of file processor.cpp.

{
        EMData *fft;
        float *fftd;
        int f=0;
//      static float sum1=0,sum1a=0;
//      static double sum2=0,sum2a=0;
 
        if (!image) {
                LOGWARN("NULL Image");
                return;
        }
 
        if (!image->is_complex()) fft = image->do_fft();
        else fft = image;
 
        int neighbor=params.set_default("neighbor",0);
        float neighbornorm=params.set_default("neighbornorm",sqrt(2.0f));
 
        int nx=fft->get_xsize()/2;
        int ny=fft->get_ysize();
        if (params.set_default("x",1)) {
                if (neighbor) {
                                for (int x=1; x<nx; x++) fft->set_complex_at(x,0,(fft->get_complex_at(x,1)+fft->get_complex_at(x,-1))/neighbornorm); // sqrt is because the pixels are normally pretty noisy
                }
                else {
                                for (int x=1; x<nx; x++) fft->set_complex_at(x,0,0.0f);
                }
        }
        if (params.set_default("y",1)) {
                if (neighbor) {
                                for (int y=1; y<ny; y++) fft->set_complex_at(0,y,(fft->get_complex_at(-1,y)+fft->get_complex_at(1,y))/neighbornorm); // sqrt is because the pixels are normally pretty noisy
                }
                else {
                                for (int y=1; y<ny; y++) fft->set_complex_at(0,y,0.0f);
                }
        }
 
        if (fft!=image) {
//              fft->update();
                EMData *ift=fft->do_ift();
                memcpy(image->get_data(),ift->get_data(),(nx*2-2)*ny*sizeof(float));
                delete fft;
                delete ift;
        }
 
//      image->update();
 
}

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

set_params()

void EMAN::Axis0FourierProcessor::set_params ( const Dict &  new_params )

inlinevirtual

Set the processor parameters using a key/value dictionary.

Parameters

new_params

A dictionary containing the new parameters.

Reimplemented from EMAN::Processor.

Definition at line 510 of file processor.h.

                {
                        params = new_params;
                }

References EMAN::Processor::params.

Member Data Documentation

NAME

const string Axis0FourierProcessor::NAME = "filter.xyaxes0"

static

Definition at line 535 of file processor.h.

Referenced by get_name().

---

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

• processor.h
• processor.cpp