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:

[legend]
Collaboration diagram for EMAN::ZeroEdgeRowProcessor:
[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 3912 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 3926 of file processor.h.

03927                 {
03928                         return "zero edges of image on top and bottom, and on left and right.";
03929                 }

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

03917                 {
03918                         return NAME;
03919                 }

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

References EMAN::TypeDict::put().

03932                 {
03933                         TypeDict d;
03934                         d.put("x0", EMObject::INT, "The number of columns to zero from left");
03935                         d.put("x1", EMObject::INT, "The number of columns to zero from right");
03936                         d.put("y0", EMObject::INT, "The number of rows to zero from the bottom");
03937                         d.put("y1", EMObject::INT, "The number of rows to zero from the top");
03938                         return d;
03939                 }

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

Definition at line 3921 of file processor.h.

03922                 {
03923                         return new ZeroEdgeRowProcessor();
03924                 }

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

03293 {
03294         if (!image) {
03295                 LOGWARN("NULL Image");
03296                 return;
03297         }
03298 
03299         if (image->get_zsize() > 1) {
03300                 LOGERR("ZeroEdgeRowProcessor is not supported in 3D models");
03301                 throw ImageDimensionException("3D model not supported");
03302         }
03303 
03304         int nx = image->get_xsize();
03305         int ny = image->get_ysize();
03306 
03307         float *d = image->get_data();
03308         int top_nrows = params["y0"];
03309         int bottom_nrows = params["y1"];
03310 
03311         int left_ncols = params["x0"];
03312         int right_ncols = params["x1"];
03313 
03314         size_t row_size = nx * sizeof(float);
03315 
03316         memset(d, 0, top_nrows * row_size);
03317         memset(d + (ny - bottom_nrows) * nx, 0, bottom_nrows * row_size);
03318 
03319         for (int i = top_nrows; i < ny - bottom_nrows; i++) {
03320                 memset(d + i * nx, 0, left_ncols * sizeof(float));
03321                 memset(d + i * nx + nx - right_ncols, 0, right_ncols * sizeof(float));
03322         }
03323         image->update();
03324 }


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 Fri Apr 30 15:39:23 2010 for EMAN2 by  doxygen 1.3.9.1