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

References NAME.

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::EMObject::INT, and 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                 }

static 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 3492 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().

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


Member Data Documentation

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

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