EMAN::GradientRemoverProcessor Class Reference

Gradient remover, does a rough plane fit to find linear gradients. More...

#include <processor.h>

Inheritance diagram for EMAN::GradientRemoverProcessor:

Collaboration diagram for EMAN::GradientRemoverProcessor:

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

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

Gradient remover, does a rough plane fit to find linear gradients.

Definition at line 5173 of file processor.h.

Member Function Documentation

get_desc()

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

                {
                        return "Gradient remover, does a rough plane fit to find linear gradients.";
                }

get_name()

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

                {
                        return NAME;
                }

References NAME.

Referenced by process_inplace().

NEW()

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

inlinestatic

Definition at line 5182 of file processor.h.

                {
                        return new GradientRemoverProcessor();
                }

process_inplace()

void GradientRemoverProcessor::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 3582 of file processor.cpp.

{
        if (!image) {
                LOGWARN("NULL Image");
                return;
        }
 
        int nz = image->get_zsize();
        if (nz > 1) {
                LOGERR("%s Processor doesn't support 3D model", get_name().c_str());
                throw ImageDimensionException("3D model not supported");
        }
 
        int nx = image->get_xsize();
        int ny = image->get_ysize();
        float *dy = new float[ny];
        float m = 0;
        float b = 0;
        float sum_y = 0;
        float *data = image->get_data();
 
        for (int i = 0; i < ny; i++) {
                Util::calc_least_square_fit(nx, 0, data + i * nx, &m, &b, false);
                dy[i] = b;
                sum_y += m;
        }
 
        float mean_y = sum_y / ny;
        float sum_x = 0;
        Util::calc_least_square_fit(ny, 0, dy, &sum_x, &b, false);
 
        for (int j = 0; j < ny; j++) {
                for (int i = 0; i < nx; i++) {
                        data[i + j * nx] -= i * sum_x + j * mean_y + b;
                }
        }
 
        image->update();
}

References EMAN::Util::calc_least_square_fit(), get_name(), ImageDimensionException, LOGERR, and LOGWARN.

Member Data Documentation

NAME

const string GradientRemoverProcessor::NAME = "math.lineargradientfix"

static

Definition at line 5192 of file processor.h.

Referenced by get_name().

---

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

• processor.h
• processor.cpp