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

03876                 {
03877                         return "zero edges of volume on all sides";
03878                 }

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

03866                 {
03867                         return NAME;
03868                 }

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

References EMAN::TypeDict::put().

03881                 {
03882                         TypeDict d;
03883                         d.put("x0", EMObject::INT, "The number of columns to zero from left");
03884                         d.put("x1", EMObject::INT, "The number of columns to zero from right");
03885                         d.put("y0", EMObject::INT, "The number of rows to zero from the bottom");
03886                         d.put("y1", EMObject::INT, "The number of rows to zero from the top");
03887                         d.put("z0", EMObject::INT, "The number of slices to zero from the bottom");
03888                         d.put("z1", EMObject::INT, "The number of slices to zero from the top");
03889                         return d;
03890                 }

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

Definition at line 3870 of file processor.h.

03871                 {
03872                         return new ZeroEdgePlaneProcessor();
03873                 }

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

03343 {
03344         if (!image) {
03345                 LOGWARN("NULL Image");
03346                 return;
03347         }
03348 
03349         if (image->get_zsize() <= 1) {
03350                 LOGERR("ZeroEdgePlaneProcessor only support 3D models");
03351                 throw ImageDimensionException("3D model only");
03352         }
03353 
03354         int nx = image->get_xsize();
03355         int ny = image->get_ysize();
03356         int nz = image->get_zsize();
03357 
03358         float *d = image->get_data();
03359 
03360         int x0=params["x0"];
03361         int x1=params["x1"];
03362         int y0=params["y0"];
03363         int y1=params["y1"];
03364         int z0=params["z0"];
03365         int z1=params["z1"];
03366 
03367         size_t row_size = nx * sizeof(float);
03368         size_t nxy = nx * ny;
03369         size_t sec_size = nxy * sizeof(float);
03370         size_t y0row = y0 * row_size;
03371         size_t y1row = y1 * row_size;
03372         int max_y = ny-y1;
03373         size_t x0size = x0*sizeof(float);
03374         size_t x1size = x1*sizeof(float);
03375 
03376         memset(d,0,z0*sec_size);                                        // zero -z
03377         memset(d+(nxy*(nz-z1)),0,sec_size*z1);      // zero +z
03378 
03379         for (int z=z0; z<nz-z1; z++) {
03380                 memset(d+z*nxy,0,y0row);                        // zero -y
03381                 memset(d+z*nxy+(ny-y1)*nx,0,y1row);     // zero +y
03382 
03383                 int znxy = z * nxy;
03384                 int znxy2 = znxy + nx - x1;
03385 
03386                 for (int y=y0; y<max_y; y++) {
03387                         memset(d+znxy+y*nx,0,x0size);   // zero -x
03388                         memset(d+znxy2+y*nx,0,x1size);  // zero +x
03389                 }
03390         }
03391 
03392         image->update();
03393 }


Member Data Documentation

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

Definition at line 138 of file processor.cpp.


The documentation for this class was generated from the following files:
Generated on Thu Mar 10 23:00:08 2011 for EMAN2 by  doxygen 1.3.9.1