Decay edges of image to zero. More...

#include <processor.h>

Inheritance diagram for EMAN::DecayEdgeProcessor:

Collaboration diagram for EMAN::DecayEdgeProcessor:

[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...

TypeDict	get_param_types () const
	Get processor parameter information in a dictionary. 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 = "mask.decayedge2d"

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

Decay edges of image to zero.

Parameters

width Width of the decay region around the edge of the image in pixels

Definition at line 5675 of file processor.h.

Member Function Documentation

◆ get_desc()

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

                {
                        return "Decay edges of image to zero";
                }

◆ get_name()

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

                {
                        return NAME;
                }

References NAME.

◆ get_param_types()

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

                {
                        TypeDict d;
                        d.put("width", EMObject::INT, "Width of the decay region around the edge of the image in pixels");
                        return d;
                }

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

◆ NEW()

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

inlinestatic

Definition at line 5684 of file processor.h.

                {
                        return new DecayEdgeProcessor();
                }

◆ process_inplace()

void DecayEdgeProcessor::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 4485 of file processor.cpp.

{
        if (!image) {
                LOGWARN("NULL Image");
                return;
        }
 
        int nx = image->get_xsize();
        int ny = image->get_ysize();
 
        float *d = image->get_data();
        int width = params["width"];
 
        if (width > min(nx,ny)/2.){
                LOGERR("width parameter cannot be greater than min(nx,ny)/2");
                throw InvalidParameterException("width cannot be greater than min(nx,ny)/2");
        }
 
        if (image->get_zsize() > 1){
                for (int k=0; k<image->get_zsize(); k++){
                        int zidx = k*nx*ny;
                        for (int i=0; i<width; i++) {
                                float frac=i/(float)width;
                                for (int j=0; j<nx; j++) {
                                        d[zidx+j+i*nx]*=frac;
                                        d[zidx+nx*ny-j-i*nx-1]*=frac;
                                }
                                for (int j=0; j<ny; j++) {
                                        d[zidx+j*nx+i]*=frac;
                                        d[zidx+nx*ny-j*nx-i-1]*=frac;
                                }
                        }
                }
        } 
        else {
 
                for (int i=0; i<width; i++) {
                        float frac=i/(float)width;
                        for (int j=0; j<nx; j++) {
                                d[j+i*nx]*=frac;
                                d[nx*ny-j-i*nx-1]*=frac;
                        }
                        for (int j=0; j<ny; j++) {
                                d[j*nx+i]*=frac;
                                d[nx*ny-j*nx-i-1]*=frac;
                        }
                }
        }
 
        image->update();
}

References InvalidParameterException, LOGERR, LOGWARN, and EMAN::Processor::params.

Member Data Documentation

◆ NAME

const string DecayEdgeProcessor::NAME = "mask.decayedge2d"

static

Definition at line 5701 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()

◆ get_param_types()

◆ NEW()

◆ process_inplace()

Member Data Documentation

◆ NAME