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

static ProcessorNEW ()

Static Public Attributes

static 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 3952 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 3966 of file processor.h.

03967                 {
03968                         return "zero edges of volume on all sides";
03969                 }

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

References NAME.

03957                 {
03958                         return NAME;
03959                 }

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

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

03972                 {
03973                         TypeDict d;
03974                         d.put("x0", EMObject::INT, "The number of columns to zero from left");
03975                         d.put("x1", EMObject::INT, "The number of columns to zero from right");
03976                         d.put("y0", EMObject::INT, "The number of rows to zero from the bottom");
03977                         d.put("y1", EMObject::INT, "The number of rows to zero from the top");
03978                         d.put("z0", EMObject::INT, "The number of slices to zero from the bottom");
03979                         d.put("z1", EMObject::INT, "The number of slices to zero from the top");
03980                         return d;
03981                 }

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

Definition at line 3961 of file processor.h.

03962                 {
03963                         return new ZeroEdgePlaneProcessor();
03964                 }

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

03327 {
03328         if (!image) {
03329                 LOGWARN("NULL Image");
03330                 return;
03331         }
03332 
03333         if (image->get_zsize() <= 1) {
03334                 LOGERR("ZeroEdgePlaneProcessor only support 3D models");
03335                 throw ImageDimensionException("3D model only");
03336         }
03337 
03338         int nx = image->get_xsize();
03339         int ny = image->get_ysize();
03340         int nz = image->get_zsize();
03341 
03342         float *d = image->get_data();
03343 
03344         int x0=params["x0"];
03345         int x1=params["x1"];
03346         int y0=params["y0"];
03347         int y1=params["y1"];
03348         int z0=params["z0"];
03349         int z1=params["z1"];
03350 
03351         size_t row_size = nx * sizeof(float);
03352         size_t nxy = nx * ny;
03353         size_t sec_size = nxy * sizeof(float);
03354         size_t y0row = y0 * row_size;
03355         size_t y1row = y1 * row_size;
03356         int max_y = ny-y1;
03357         size_t x0size = x0*sizeof(float);
03358         size_t x1size = x1*sizeof(float);
03359 
03360         memset(d,0,z0*sec_size);                                        // zero -z
03361         memset(d+(nxy*(nz-z1)),0,sec_size*z1);      // zero +z
03362 
03363         for (int z=z0; z<nz-z1; z++) {
03364                 memset(d+z*nxy,0,y0row);                        // zero -y
03365                 memset(d+z*nxy+(ny-y1)*nx,0,y1row);     // zero +y
03366 
03367                 int znxy = z * nxy;
03368                 int znxy2 = znxy + nx - x1;
03369 
03370                 for (int y=y0; y<max_y; y++) {
03371                         memset(d+znxy+y*nx,0,x0size);   // zero -x
03372                         memset(d+znxy2+y*nx,0,x1size);  // zero +x
03373                 }
03374         }
03375 
03376         image->update();
03377 }


Member Data Documentation

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

Definition at line 3983 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Tue May 25 17:17:05 2010 for EMAN2 by  doxygen 1.4.7