EMAN::RotationalSubstractProcessor Class Reference

subtracts circularly symmetric part of an image. More...

#include <processor.h>

Inheritance diagram for EMAN::RotationalSubstractProcessor:

Collaboration diagram for EMAN::RotationalSubstractProcessor:

Public Member Functions
virtual void	process_inplace (EMData *image)
	To process an image in-place. More...
virtual string	get_name () const
	Get the processor's name. More...
virtual 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...
virtual TypeDict	get_param_types () const
	Get processor parameter information in a 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.rotationalsubtract"

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

subtracts circularly symmetric part of an image.

Definition at line 6325 of file processor.h.

Member Function Documentation

get_desc()

virtual string EMAN::RotationalSubstractProcessor::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 6340 of file processor.h.

                {
                        return "subtracts circularly/spherically symmetric part of an image.";
                }

get_name()

virtual string EMAN::RotationalSubstractProcessor::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 6330 of file processor.h.

                {
                        return NAME;
                }

References NAME.

NEW()

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

inlinestatic

Definition at line 6335 of file processor.h.

                {
                        return new RotationalSubstractProcessor();
                }

process_inplace()

void RotationalSubstractProcessor::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 5688 of file processor.cpp.

{
        if (!image || image->is_complex()) {
                LOGWARN("only works on real image. do nothing.");
                return;
        }
 
        if (image->get_ndim() != 2) throw ImageDimensionException("This processor works only for 2D images");
 
        float *rdata = image->get_data();
        int nx = image->get_xsize();
        int ny = image->get_ysize();
 
        vector < float >dist = image->calc_radial_dist(nx / 2, 0, 1,0);
 
        int c = 0;
        for (int y = 0; y < ny; y++) {
                for (int x = 0; x < nx; x++, c++) {
                        float r = (float) hypot(x - nx / 2, y - ny / 2);
                        int i = (int) floor(r);
                        r -= i;
                        if (i >= 0 && i < nx / 2 - 1) {
                                rdata[c] -= dist[i] * (1.0f - r) + dist[i + 1] * r;
                        }
                        else {
                                rdata[c] = 0;
                        }
                }
        }
 
        image->update();
}

References EMAN::EMData::calc_radial_dist(), ImageDimensionException, LOGWARN, rdata, x, and y.

Member Data Documentation

NAME

const string RotationalSubstractProcessor::NAME = "math.rotationalsubtract"

static

Definition at line 6345 of file processor.h.

Referenced by get_name().

---

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

• processor.h
• processor.cpp