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

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

04007                 {
04008                         return "zero edges of volume on all sides";
04009                 }

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

References NAME.

03997                 {
03998                         return NAME;
03999                 }

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

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

04012                 {
04013                         TypeDict d;
04014                         d.put("x0", EMObject::INT, "The number of columns to zero from left");
04015                         d.put("x1", EMObject::INT, "The number of columns to zero from right");
04016                         d.put("y0", EMObject::INT, "The number of rows to zero from the bottom");
04017                         d.put("y1", EMObject::INT, "The number of rows to zero from the top");
04018                         d.put("z0", EMObject::INT, "The number of slices to zero from the bottom");
04019                         d.put("z1", EMObject::INT, "The number of slices to zero from the top");
04020                         return d;
04021                 }

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

Definition at line 4001 of file processor.h.

04002                 {
04003                         return new ZeroEdgePlaneProcessor();
04004                 }

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

03434 {
03435         if (!image) {
03436                 LOGWARN("NULL Image");
03437                 return;
03438         }
03439 
03440         if (image->get_zsize() <= 1) {
03441                 LOGERR("ZeroEdgePlaneProcessor only support 3D models");
03442                 throw ImageDimensionException("3D model only");
03443         }
03444 
03445         int nx = image->get_xsize();
03446         int ny = image->get_ysize();
03447         int nz = image->get_zsize();
03448 
03449         float *d = image->get_data();
03450 
03451         int x0=params["x0"];
03452         int x1=params["x1"];
03453         int y0=params["y0"];
03454         int y1=params["y1"];
03455         int z0=params["z0"];
03456         int z1=params["z1"];
03457 
03458         size_t row_size = nx * sizeof(float);
03459         size_t nxy = nx * ny;
03460         size_t sec_size = nxy * sizeof(float);
03461         size_t y0row = y0 * row_size;
03462         size_t y1row = y1 * row_size;
03463         int max_y = ny-y1;
03464         size_t x0size = x0*sizeof(float);
03465         size_t x1size = x1*sizeof(float);
03466 
03467         memset(d,0,z0*sec_size);                                        // zero -z
03468         memset(d+(nxy*(nz-z1)),0,sec_size*z1);      // zero +z
03469 
03470         for (int z=z0; z<nz-z1; z++) {
03471                 memset(d+z*nxy,0,y0row);                        // zero -y
03472                 memset(d+z*nxy+(ny-y1)*nx,0,y1row);     // zero +y
03473 
03474                 int znxy = z * nxy;
03475                 int znxy2 = znxy + nx - x1;
03476 
03477                 for (int y=y0; y<max_y; y++) {
03478                         memset(d+znxy+y*nx,0,x0size);   // zero -x
03479                         memset(d+znxy2+y*nx,0,x1size);  // zero +x
03480                 }
03481         }
03482 
03483         image->update();
03484 }


Member Data Documentation

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

Definition at line 4023 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Mon Jul 19 13:06:59 2010 for EMAN2 by  doxygen 1.4.4