EMAN::ZeroEdgePlaneProcessor Class Reference

zero edges of volume on all sides More...

#include <processor.h>

Inheritance diagram for EMAN::ZeroEdgePlaneProcessor:

Collaboration diagram for EMAN::ZeroEdgePlaneProcessor:

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.zeroedge3d"

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

zero edges of volume on all sides

Parameters

x0	The number of columns to zero from left
x1	The number of columns to zero from right
y0	The number of rows to zero from the bottom
y1	The number of rows to zero from the top
z0	The number of slices to zero from the bottom
z1	The number of slices to zero from the top

Definition at line 5751 of file processor.h.

Member Function Documentation

get_desc()

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

                {
                        return "zero edges of volume on all sides";
                }

get_name()

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

                {
                        return NAME;
                }

References NAME.

get_param_types()

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

                {
                        TypeDict d;
                        d.put("x0", EMObject::INT, "The number of columns to zero from left");
                        d.put("x1", EMObject::INT, "The number of columns to zero from right");
                        d.put("y0", EMObject::INT, "The number of rows to zero from the bottom");
                        d.put("y1", EMObject::INT, "The number of rows to zero from the top");
                        d.put("z0", EMObject::INT, "The number of slices to zero from the bottom");
                        d.put("z1", EMObject::INT, "The number of slices to zero from the top");
                        return d;
                }

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

NEW()

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

inlinestatic

Definition at line 5760 of file processor.h.

                {
                        return new ZeroEdgePlaneProcessor();
                }

process_inplace()

void ZeroEdgePlaneProcessor::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 4576 of file processor.cpp.

{
        if (!image) {
                LOGWARN("NULL Image");
                return;
        }
 
        if (image->get_zsize() <= 1) {
                LOGERR("ZeroEdgePlaneProcessor only support 3D models");
                throw ImageDimensionException("3D model only");
        }
 
        int nx = image->get_xsize();
        int ny = image->get_ysize();
        int nz = image->get_zsize();
 
        float *d = image->get_data();
 
        int x0=params["x0"];
        int x1=params.set_default("x1",x0);
        int y0=params["y0"];
        int y1=params.set_default("y1",y0);
        int z0=params["z0"];
        int z1=params.set_default("z1",z0);
 
        size_t row_size = nx * sizeof(float);
        size_t nxy = nx * ny;
        size_t sec_size = nxy * sizeof(float);
        size_t y0row = y0 * row_size;
        size_t y1row = y1 * row_size;
        int max_y = ny-y1;
        size_t x0size = x0*sizeof(float);
        size_t x1size = x1*sizeof(float);
 
        memset(d,0,z0*sec_size);                                        // zero -z
        memset(d+(nxy*(nz-z1)),0,sec_size*z1);          // zero +z
 
        for (int z=z0; z<nz-z1; z++) {
                memset(d+z*nxy,0,y0row);                        // zero -y
                memset(d+z*nxy+(ny-y1)*nx,0,y1row); // zero +y
 
                int znxy = z * nxy;
                int znxy2 = znxy + nx - x1;
 
                for (int y=y0; y<max_y; y++) {
                        memset(d+znxy+y*nx,0,x0size);   // zero -x
                        memset(d+znxy2+y*nx,0,x1size);  // zero +x
                }
        }
 
        image->update();
}

References ImageDimensionException, LOGERR, LOGWARN, EMAN::Processor::params, EMAN::Dict::set_default(), and y.

Member Data Documentation

NAME

const string ZeroEdgePlaneProcessor::NAME = "mask.zeroedge3d"

static

Definition at line 5782 of file processor.h.

Referenced by get_name().

---

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

• processor.h
• processor.cpp