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

04006                 {
04007                         return "zero edges of image on top and bottom, and on left and right.";
04008                 }

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

References NAME.

03996                 {
03997                         return NAME;
03998                 }

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

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

04011                 {
04012                         TypeDict d;
04013                         d.put("x0", EMObject::INT, "The number of columns to zero from left");
04014                         d.put("x1", EMObject::INT, "The number of columns to zero from right");
04015                         d.put("y0", EMObject::INT, "The number of rows to zero from the bottom");
04016                         d.put("y1", EMObject::INT, "The number of rows to zero from the top");
04017                         return d;
04018                 }

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

Definition at line 4000 of file processor.h.

04001                 {
04002                         return new ZeroEdgeRowProcessor();
04003                 }

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

03459 {
03460         if (!image) {
03461                 LOGWARN("NULL Image");
03462                 return;
03463         }
03464 
03465         if (image->get_zsize() > 1) {
03466                 LOGERR("ZeroEdgeRowProcessor is not supported in 3D models");
03467                 throw ImageDimensionException("3D model not supported");
03468         }
03469 
03470         int nx = image->get_xsize();
03471         int ny = image->get_ysize();
03472 
03473         float *d = image->get_data();
03474         int top_nrows = params["y0"];
03475         int bottom_nrows = params["y1"];
03476 
03477         int left_ncols = params["x0"];
03478         int right_ncols = params["x1"];
03479 
03480         size_t row_size = nx * sizeof(float);
03481 
03482         memset(d, 0, top_nrows * row_size);
03483         memset(d + (ny - bottom_nrows) * nx, 0, bottom_nrows * row_size);
03484 
03485         for (int i = top_nrows; i < ny - bottom_nrows; i++) {
03486                 memset(d + i * nx, 0, left_ncols * sizeof(float));
03487                 memset(d + i * nx + nx - right_ncols, 0, right_ncols * sizeof(float));
03488         }
03489         image->update();
03490 }


Member Data Documentation

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

Definition at line 4020 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Thu May 3 10:10:20 2012 for EMAN2 by  doxygen 1.4.7