Ramp processor – Fits a least-squares plane to the picture, and subtracts the plane from the picture. More...

#include <processor.h>

Inheritance diagram for EMAN::RampProcessor:

Collaboration diagram for EMAN::RampProcessor:

[legend]

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

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

Ramp processor – Fits a least-squares plane to the picture, and subtracts the plane from the picture.

A wedge-shaped overall density profile can thus be removed from the picture.

Definition at line 5310 of file processor.h.

Member Function Documentation

◆ get_desc()

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

                {
                        return "Ramp processor -- Fits a least-squares plane "
                                   "to the picture, and subtracts the plane from "
                                   "the picture.  A wedge-shaped overall density "
                                   "profile can thus be removed from the picture.";
                }

◆ get_name()

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

                {
                        return NAME;
                }

References NAME.

Referenced by process_inplace().

◆ NEW()

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

inlinestatic

Definition at line 5319 of file processor.h.

                {
                        return new RampProcessor();
                }

◆ process_inplace()

void RampProcessor::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 10187 of file processor.cpp.

{
        if (!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 nsam = image->get_xsize();
        int nrow = image->get_ysize();
        int n1 = nsam / 2;
        double sx1 = double(n1)*double(nsam+1);
        if ( nsam % 2 == 1 )
                sx1 += 1 + n1;
        sx1 *= nrow;
        int n2 = nrow / 2;
        double sx2 = double(n2)*double(nrow+1);
        if ( nrow % 2 == 1 )
                sx2 += 1 + n2;
        sx2 *= nsam;
        float *data = image->get_data();
        float *row = NULL; // handy pointer for values in a specific row of the data
        // statistical sums
        double syx1 = 0, syx2 = 0, sy = 0, sx1q = 0, sx2q = 0, syq = 0;
        for (int j=1; j <= nrow; j++) {
                row = data + (j-1)*nsam - 1; // "-1" so that we can start counting at 1
                for (int i=1; i<=nsam; i++) {
                        syx1 += row[i]*i;
                        syx2 += row[i]*j;
                        sy += row[i];
                        sx1q += i*i;
                        sx2q += j*j;
                        syq += row[i]*double(row[i]);
                }
        }
        // least-squares
        float dn = float(nsam)*float(nrow);
        double qyx1 = syx1 - sx1*sy / dn;
        double qyx2 = syx2 - sx2*sy / dn;
        double qx1x2 = 0.0;
        double qx1 = sx1q - sx1*sx1 / dn;
        double qx2 = sx2q - sx2*sx2 / dn;
        double qy = syq - sy*sy / dn;
        double c = qx1*qx2 - qx1x2*qx1x2;
        if ( c > FLT_EPSILON ) {
                double b1 = (qyx1*qx2 - qyx2*qx1x2) / c;
                double b2 = (qyx2*qx1 - qyx1*qx1x2) / c;
                double a = (sy - b1*sx1 - b2*sx2) / dn;
                double d = a + b1 + b2;
                for (int i=1; i<=nrow; i++) {
                        qy = d;
                        row = data + (i-1)*nsam - 1;
                        for (int k=1; k<=nsam; k++) {
                                row[k] -= static_cast<float>(qy);
                                qy += b1;
                        }
                        d += b2;
                }
        } // image not altered if c is zero
 
        image->update();
}

References get_name(), ImageDimensionException, and LOGERR.

Member Data Documentation

◆ NAME

const string RampProcessor::NAME = "filter.ramp"

static

Definition at line 5332 of file processor.h.

Referenced by get_name().

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_desc()

◆ get_name()

◆ NEW()

◆ process_inplace()

Member Data Documentation

◆ NAME