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

ProcessorNEW ()

Static Public Attributes

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

03751                 {
03752                         return "zero edges of image on top and bottom, and on left and right.";
03753                 }

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

03741                 {
03742                         return NAME;
03743                 }

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

References EMAN::TypeDict::put().

03756                 {
03757                         TypeDict d;
03758                         d.put("x0", EMObject::INT, "The number of columns to zero from left");
03759                         d.put("x1", EMObject::INT, "The number of columns to zero from right");
03760                         d.put("y0", EMObject::INT, "The number of rows to zero from the bottom");
03761                         d.put("y1", EMObject::INT, "The number of rows to zero from the top");
03762                         return d;
03763                 }

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

Definition at line 3745 of file processor.h.

03746                 {
03747                         return new ZeroEdgeRowProcessor();
03748                 }

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 3247 of file processor.cpp.

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

03248 {
03249         if (!image) {
03250                 LOGWARN("NULL Image");
03251                 return;
03252         }
03253 
03254         if (image->get_zsize() > 1) {
03255                 LOGERR("ZeroEdgeRowProcessor is not supported in 3D models");
03256                 throw ImageDimensionException("3D model not supported");
03257         }
03258 
03259         int nx = image->get_xsize();
03260         int ny = image->get_ysize();
03261 
03262         float *d = image->get_data();
03263         int top_nrows = params["y0"];
03264         int bottom_nrows = params["y1"];
03265 
03266         int left_ncols = params["x0"];
03267         int right_ncols = params["x1"];
03268 
03269         size_t row_size = nx * sizeof(float);
03270 
03271         memset(d, 0, top_nrows * row_size);
03272         memset(d + (ny - bottom_nrows) * nx, 0, bottom_nrows * row_size);
03273 
03274         for (int i = top_nrows; i < ny - bottom_nrows; i++) {
03275                 memset(d + i * nx, 0, left_ncols * sizeof(float));
03276                 memset(d + i * nx + nx - right_ncols, 0, right_ncols * sizeof(float));
03277         }
03278         image->update();
03279 }


Member Data Documentation

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

Definition at line 134 of file processor.cpp.


The documentation for this class was generated from the following files:
Generated on Thu Dec 9 13:48:02 2010 for EMAN2 by  doxygen 1.3.9.1