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

EMAN::ZeroEdgePlaneProcessor Class Reference

zero edges of volume on all sides More...

#include <processor.h>

Inheritance diagram for EMAN::ZeroEdgePlaneProcessor:

Inheritance graph
[legend]
Collaboration diagram for EMAN::ZeroEdgePlaneProcessor:

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.zeroedge3d"

Detailed Description

zero edges of volume on all sides

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
z0 The number of slices to zero from the bottom
z1 The number of slices to zero from the top

Definition at line 4031 of file processor.h.


Member Function Documentation

string EMAN::ZeroEdgePlaneProcessor::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 4045 of file processor.h.

04046                 {
04047                         return "zero edges of volume on all sides";
04048                 }

string EMAN::ZeroEdgePlaneProcessor::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 4035 of file processor.h.

04036                 {
04037                         return NAME;
04038                 }

TypeDict EMAN::ZeroEdgePlaneProcessor::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 4050 of file processor.h.

References EMAN::TypeDict::put().

04051                 {
04052                         TypeDict d;
04053                         d.put("x0", EMObject::INT, "The number of columns to zero from left");
04054                         d.put("x1", EMObject::INT, "The number of columns to zero from right");
04055                         d.put("y0", EMObject::INT, "The number of rows to zero from the bottom");
04056                         d.put("y1", EMObject::INT, "The number of rows to zero from the top");
04057                         d.put("z0", EMObject::INT, "The number of slices to zero from the bottom");
04058                         d.put("z1", EMObject::INT, "The number of slices to zero from the top");
04059                         return d;
04060                 }

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

Definition at line 4040 of file processor.h.

04041                 {
04042                         return new ZeroEdgePlaneProcessor();
04043                 }

void ZeroEdgePlaneProcessor::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 3496 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, EMAN::EMData::update(), and y.

03497 {
03498         if (!image) {
03499                 LOGWARN("NULL Image");
03500                 return;
03501         }
03502 
03503         if (image->get_zsize() <= 1) {
03504                 LOGERR("ZeroEdgePlaneProcessor only support 3D models");
03505                 throw ImageDimensionException("3D model only");
03506         }
03507 
03508         int nx = image->get_xsize();
03509         int ny = image->get_ysize();
03510         int nz = image->get_zsize();
03511 
03512         float *d = image->get_data();
03513 
03514         int x0=params["x0"];
03515         int x1=params["x1"];
03516         int y0=params["y0"];
03517         int y1=params["y1"];
03518         int z0=params["z0"];
03519         int z1=params["z1"];
03520 
03521         size_t row_size = nx * sizeof(float);
03522         size_t nxy = nx * ny;
03523         size_t sec_size = nxy * sizeof(float);
03524         size_t y0row = y0 * row_size;
03525         size_t y1row = y1 * row_size;
03526         int max_y = ny-y1;
03527         size_t x0size = x0*sizeof(float);
03528         size_t x1size = x1*sizeof(float);
03529 
03530         memset(d,0,z0*sec_size);                                        // zero -z
03531         memset(d+(nxy*(nz-z1)),0,sec_size*z1);      // zero +z
03532 
03533         for (int z=z0; z<nz-z1; z++) {
03534                 memset(d+z*nxy,0,y0row);                        // zero -y
03535                 memset(d+z*nxy+(ny-y1)*nx,0,y1row);     // zero +y
03536 
03537                 int znxy = z * nxy;
03538                 int znxy2 = znxy + nx - x1;
03539 
03540                 for (int y=y0; y<max_y; y++) {
03541                         memset(d+znxy+y*nx,0,x0size);   // zero -x
03542                         memset(d+znxy2+y*nx,0,x1size);  // zero +x
03543                 }
03544         }
03545 
03546         image->update();
03547 }


Member Data Documentation

const string ZeroEdgePlaneProcessor::NAME = "mask.zeroedge3d" [static]
 

Definition at line 141 of file processor.cpp.


The documentation for this class was generated from the following files:
Generated on Mon Aug 13 13:42:13 2012 for EMAN2 by  doxygen 1.3.9.1