EMAN2
Public Member Functions | Static Public Member Functions | Static Public Attributes
EMAN::ZeroEdgeRowProcessor Class Reference

zero edges of image on top and bottom, and on left and right. More...

#include <processor.h>

Inheritance diagram for EMAN::ZeroEdgeRowProcessor:
Inheritance graph
[legend]
Collaboration diagram for EMAN::ZeroEdgeRowProcessor:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void process_inplace (EMData *image)
 To process an image in-place.
string get_name () const
 Get the processor's name.
string get_desc () const
 Get the descrition of this specific processor.
TypeDict get_param_types () const
 Get processor parameter information in a dictionary.

Static Public Member Functions

static ProcessorNEW ()

Static Public Attributes

static const string NAME = "mask.zeroedge2d"

Detailed Description

zero edges of image on top and bottom, and on left and right.

Parameters:
x0The number of columns to zero from left
x1The number of columns to zero from right
y0The number of rows to zero from the bottom
y1The number of rows to zero from the top

Definition at line 4187 of file processor.h.


Member Function Documentation

string EMAN::ZeroEdgeRowProcessor::get_desc ( ) const [inline, virtual]

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 4201 of file processor.h.

                {
                        return "zero edges of image on top and bottom, and on left and right.";
                }
string EMAN::ZeroEdgeRowProcessor::get_name ( ) const [inline, virtual]

Get the processor's name.

Each processor is identified by a unique name.

Returns:
The processor's name.

Implements EMAN::Processor.

Definition at line 4191 of file processor.h.

References NAME.

                {
                        return NAME;
                }
TypeDict EMAN::ZeroEdgeRowProcessor::get_param_types ( ) const [inline, virtual]

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 4206 of file processor.h.

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

                {
                        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");
                        return d;
                }
static Processor* EMAN::ZeroEdgeRowProcessor::NEW ( ) [inline, static]

Definition at line 4196 of file processor.h.

                {
                        return new ZeroEdgeRowProcessor();
                }
void ZeroEdgeRowProcessor::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:
imageThe image to be processed.

Implements EMAN::Processor.

Definition at line 3526 of file processor.cpp.

References EMAN::EMData::get_data(), EMAN::EMData::get_xsize(), EMAN::EMData::get_ysize(), EMAN::EMData::get_zsize(), ImageDimensionException, LOGERR, LOGWARN, EMAN::Processor::params, and EMAN::EMData::update().

{
        if (!image) {
                LOGWARN("NULL Image");
                return;
        }

        if (image->get_zsize() > 1) {
                LOGERR("ZeroEdgeRowProcessor is not supported in 3D models");
                throw ImageDimensionException("3D model not supported");
        }

        int nx = image->get_xsize();
        int ny = image->get_ysize();

        float *d = image->get_data();
        int top_nrows = params["y0"];
        int bottom_nrows = params["y1"];

        int left_ncols = params["x0"];
        int right_ncols = params["x1"];

        size_t row_size = nx * sizeof(float);

        memset(d, 0, top_nrows * row_size);
        memset(d + (ny - bottom_nrows) * nx, 0, bottom_nrows * row_size);

        for (int i = top_nrows; i < ny - bottom_nrows; i++) {
                memset(d + i * nx, 0, left_ncols * sizeof(float));
                memset(d + i * nx + nx - right_ncols, 0, right_ncols * sizeof(float));
        }
        image->update();
}

Member Data Documentation

const string ZeroEdgeRowProcessor::NAME = "mask.zeroedge2d" [static]

Definition at line 4216 of file processor.h.

Referenced by get_name().


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