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

03892                 {
03893                         return "zero edges of image on top and bottom, and on left and right.";
03894                 }

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

03882                 {
03883                         return NAME;
03884                 }

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

References EMAN::TypeDict::put().

03897                 {
03898                         TypeDict d;
03899                         d.put("x0", EMObject::INT, "The number of columns to zero from left");
03900                         d.put("x1", EMObject::INT, "The number of columns to zero from right");
03901                         d.put("y0", EMObject::INT, "The number of rows to zero from the bottom");
03902                         d.put("y1", EMObject::INT, "The number of rows to zero from the top");
03903                         return d;
03904                 }

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

Definition at line 3886 of file processor.h.

03887                 {
03888                         return new ZeroEdgeRowProcessor();
03889                 }

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

03340 {
03341         if (!image) {
03342                 LOGWARN("NULL Image");
03343                 return;
03344         }
03345 
03346         if (image->get_zsize() > 1) {
03347                 LOGERR("ZeroEdgeRowProcessor is not supported in 3D models");
03348                 throw ImageDimensionException("3D model not supported");
03349         }
03350 
03351         int nx = image->get_xsize();
03352         int ny = image->get_ysize();
03353 
03354         float *d = image->get_data();
03355         int top_nrows = params["y0"];
03356         int bottom_nrows = params["y1"];
03357 
03358         int left_ncols = params["x0"];
03359         int right_ncols = params["x1"];
03360 
03361         size_t row_size = nx * sizeof(float);
03362 
03363         memset(d, 0, top_nrows * row_size);
03364         memset(d + (ny - bottom_nrows) * nx, 0, bottom_nrows * row_size);
03365 
03366         for (int i = top_nrows; i < ny - bottom_nrows; i++) {
03367                 memset(d + i * nx, 0, left_ncols * sizeof(float));
03368                 memset(d + i * nx + nx - right_ncols, 0, right_ncols * sizeof(float));
03369         }
03370         image->update();
03371 }


Member Data Documentation

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

Definition at line 139 of file processor.cpp.


The documentation for this class was generated from the following files:
Generated on Mon May 2 13:30:26 2011 for EMAN2 by  doxygen 1.3.9.1