EMAN::DecayEdgeProcessor Class Reference

Decay edges of image to zero. More...

#include <processor.h>

Inheritance diagram for EMAN::DecayEdgeProcessor:

Inheritance graph
[legend]
Collaboration diagram for EMAN::DecayEdgeProcessor:

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

Detailed Description

Decay edges of image to zero.

Parameters:
width Width of the decay region around the edge of the image in pixels

Definition at line 3956 of file processor.h.


Member Function Documentation

string EMAN::DecayEdgeProcessor::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 3970 of file processor.h.

03971                 {
03972                         return "Decay edges of image to zero";
03973                 }

string EMAN::DecayEdgeProcessor::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 3960 of file processor.h.

References NAME.

03961                 {
03962                         return NAME;
03963                 }

TypeDict EMAN::DecayEdgeProcessor::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 3975 of file processor.h.

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

03976                 {
03977                         TypeDict d;
03978                         d.put("width", EMObject::INT, "Width of the decay region around the edge of the image in pixels");
03979                         return d;
03980                 }

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

Definition at line 3965 of file processor.h.

03966                 {
03967                         return new DecayEdgeProcessor();
03968                 }

void DecayEdgeProcessor::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 3428 of file processor.cpp.

References EMAN::EMData::get_data(), EMAN::EMData::get_xsize(), EMAN::EMData::get_ysize(), EMAN::EMData::get_zsize(), ImageDimensionException, LOGWARN, EMAN::Processor::params, and EMAN::EMData::update().

03429 {
03430         if (!image) {
03431                 LOGWARN("NULL Image");
03432                 return;
03433         }
03434 
03435         if (image->get_zsize() > 1) throw ImageDimensionException("3D model not supported");
03436 
03437         int nx = image->get_xsize();
03438         int ny = image->get_ysize();
03439 
03440         float *d = image->get_data();
03441         int width = params["width"];
03442 
03443         for (int i=0; i<width; i++) {
03444                 float frac=i/(float)width;
03445                 for (int j=0; j<nx; j++) {
03446                         d[j+i*nx]*=frac;
03447                         d[nx*ny-j-i*nx-1]*=frac;
03448                 }
03449                 for (int j=0; j<ny; j++) {
03450                         d[j*nx+i]*=frac;
03451                         d[nx*ny-j*nx-i-1]*=frac;
03452                 }
03453         }
03454 
03455         image->update();
03456 }


Member Data Documentation

const string DecayEdgeProcessor::NAME = "mask.decayedge2d" [static]

Definition at line 3982 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:19 2012 for EMAN2 by  doxygen 1.4.7