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:
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

Definition at line 3821 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 3835 of file processor.h.

03836                 {
03837                         return "zero edges of image on top and bottom, and on left and right.";
03838                 }

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

References NAME.

03826                 {
03827                         return NAME;
03828                 }

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

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

03841                 {
03842                         TypeDict d;
03843                         d.put("x0", EMObject::INT, "The number of columns to zero from left");
03844                         d.put("x1", EMObject::INT, "The number of columns to zero from right");
03845                         d.put("y0", EMObject::INT, "The number of rows to zero from the bottom");
03846                         d.put("y1", EMObject::INT, "The number of rows to zero from the top");
03847                         return d;
03848                 }

static Processor* EMAN::ZeroEdgeRowProcessor::NEW (  )  [inline, static]

Definition at line 3830 of file processor.h.

03831                 {
03832                         return new ZeroEdgeRowProcessor();
03833                 }

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:
image The image to be processed.

Implements EMAN::Processor.

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

03309 {
03310         if (!image) {
03311                 LOGWARN("NULL Image");
03312                 return;
03313         }
03314 
03315         if (image->get_zsize() > 1) {
03316                 LOGERR("ZeroEdgeRowProcessor is not supported in 3D models");
03317                 throw ImageDimensionException("3D model not supported");
03318         }
03319 
03320         int nx = image->get_xsize();
03321         int ny = image->get_ysize();
03322 
03323         float *d = image->get_data();
03324         int top_nrows = params["y0"];
03325         int bottom_nrows = params["y1"];
03326 
03327         int left_ncols = params["x0"];
03328         int right_ncols = params["x1"];
03329 
03330         size_t row_size = nx * sizeof(float);
03331 
03332         memset(d, 0, top_nrows * row_size);
03333         memset(d + (ny - bottom_nrows) * nx, 0, bottom_nrows * row_size);
03334 
03335         for (int i = top_nrows; i < ny - bottom_nrows; i++) {
03336                 memset(d + i * nx, 0, left_ncols * sizeof(float));
03337                 memset(d + i * nx + nx - right_ncols, 0, right_ncols * sizeof(float));
03338         }
03339         image->update();
03340 }


Member Data Documentation

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

Definition at line 3850 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Mon Mar 7 18:02:49 2011 for EMAN2 by  doxygen 1.4.7