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

03932                 {
03933                         return "zero edges of volume on all sides";
03934                 }

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

03922                 {
03923                         return NAME;
03924                 }

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

References EMAN::TypeDict::put().

03937                 {
03938                         TypeDict d;
03939                         d.put("x0", EMObject::INT, "The number of columns to zero from left");
03940                         d.put("x1", EMObject::INT, "The number of columns to zero from right");
03941                         d.put("y0", EMObject::INT, "The number of rows to zero from the bottom");
03942                         d.put("y1", EMObject::INT, "The number of rows to zero from the top");
03943                         d.put("z0", EMObject::INT, "The number of slices to zero from the bottom");
03944                         d.put("z1", EMObject::INT, "The number of slices to zero from the top");
03945                         return d;
03946                 }

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

Definition at line 3926 of file processor.h.

03927                 {
03928                         return new ZeroEdgePlaneProcessor();
03929                 }

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 3373 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.

03374 {
03375         if (!image) {
03376                 LOGWARN("NULL Image");
03377                 return;
03378         }
03379 
03380         if (image->get_zsize() <= 1) {
03381                 LOGERR("ZeroEdgePlaneProcessor only support 3D models");
03382                 throw ImageDimensionException("3D model only");
03383         }
03384 
03385         int nx = image->get_xsize();
03386         int ny = image->get_ysize();
03387         int nz = image->get_zsize();
03388 
03389         float *d = image->get_data();
03390 
03391         int x0=params["x0"];
03392         int x1=params["x1"];
03393         int y0=params["y0"];
03394         int y1=params["y1"];
03395         int z0=params["z0"];
03396         int z1=params["z1"];
03397 
03398         size_t row_size = nx * sizeof(float);
03399         size_t nxy = nx * ny;
03400         size_t sec_size = nxy * sizeof(float);
03401         size_t y0row = y0 * row_size;
03402         size_t y1row = y1 * row_size;
03403         int max_y = ny-y1;
03404         size_t x0size = x0*sizeof(float);
03405         size_t x1size = x1*sizeof(float);
03406 
03407         memset(d,0,z0*sec_size);                                        // zero -z
03408         memset(d+(nxy*(nz-z1)),0,sec_size*z1);      // zero +z
03409 
03410         for (int z=z0; z<nz-z1; z++) {
03411                 memset(d+z*nxy,0,y0row);                        // zero -y
03412                 memset(d+z*nxy+(ny-y1)*nx,0,y1row);     // zero +y
03413 
03414                 int znxy = z * nxy;
03415                 int znxy2 = znxy + nx - x1;
03416 
03417                 for (int y=y0; y<max_y; y++) {
03418                         memset(d+znxy+y*nx,0,x0size);   // zero -x
03419                         memset(d+znxy2+y*nx,0,x1size);  // zero +x
03420                 }
03421         }
03422 
03423         image->update();
03424 }


Member Data Documentation

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

Definition at line 140 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