Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

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

03967                 {
03968                         return "zero edges of image on top and bottom, and on left and right.";
03969                 }

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

References NAME.

03957                 {
03958                         return NAME;
03959                 }

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

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

03972                 {
03973                         TypeDict d;
03974                         d.put("x0", EMObject::INT, "The number of columns to zero from left");
03975                         d.put("x1", EMObject::INT, "The number of columns to zero from right");
03976                         d.put("y0", EMObject::INT, "The number of rows to zero from the bottom");
03977                         d.put("y1", EMObject::INT, "The number of rows to zero from the top");
03978                         return d;
03979                 }

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

Definition at line 3961 of file processor.h.

03962                 {
03963                         return new ZeroEdgeRowProcessor();
03964                 }

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 3399 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().

03400 {
03401         if (!image) {
03402                 LOGWARN("NULL Image");
03403                 return;
03404         }
03405 
03406         if (image->get_zsize() > 1) {
03407                 LOGERR("ZeroEdgeRowProcessor is not supported in 3D models");
03408                 throw ImageDimensionException("3D model not supported");
03409         }
03410 
03411         int nx = image->get_xsize();
03412         int ny = image->get_ysize();
03413 
03414         float *d = image->get_data();
03415         int top_nrows = params["y0"];
03416         int bottom_nrows = params["y1"];
03417 
03418         int left_ncols = params["x0"];
03419         int right_ncols = params["x1"];
03420 
03421         size_t row_size = nx * sizeof(float);
03422 
03423         memset(d, 0, top_nrows * row_size);
03424         memset(d + (ny - bottom_nrows) * nx, 0, bottom_nrows * row_size);
03425 
03426         for (int i = top_nrows; i < ny - bottom_nrows; i++) {
03427                 memset(d + i * nx, 0, left_ncols * sizeof(float));
03428                 memset(d + i * nx + nx - right_ncols, 0, right_ncols * sizeof(float));
03429         }
03430         image->update();
03431 }


Member Data Documentation

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

Definition at line 3981 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Mon Jul 19 13:06:58 2010 for EMAN2 by  doxygen 1.4.4