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

03973                 {
03974                         return "Decay edges of image to zero";
03975                 }

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

References NAME.

03963                 {
03964                         return NAME;
03965                 }

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

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

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

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

Definition at line 3967 of file processor.h.

03968                 {
03969                         return new DecayEdgeProcessor();
03970                 }

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

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


Member Data Documentation

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

Definition at line 3984 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Tue Jun 11 12:44:09 2013 for EMAN2 by  doxygen 1.4.7