Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

EMAN::CircularMaskProcessor Class Reference

CircularMaskProcessor applies a circular mask to the data.This is the base class for specific circular mask processors.Its subclass must implement process_dist_pixel(). More...

#include <processor.h>

Inheritance diagram for EMAN::CircularMaskProcessor:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 CircularMaskProcessor ()
void set_params (const Dict &new_params)
 Set the processor parameters using a key/value dictionary.
string get_desc () const
 Get the descrition of this specific processor.
TypeDict get_param_types () const
 Get processor parameter information in a dictionary.

Protected Member Functions

void calc_locals (EMData *image)
bool is_valid () const
void process_pixel (float *pixel, int xi, int yi, int zi) const
virtual void process_dist_pixel (float *pixel, float dist) const =0

Protected Attributes

int inner_radius
int outer_radius
int inner_radius_square
int outer_radius_square
float dx
float dy
float dz
float xc
float yc
float zc

Detailed Description

CircularMaskProcessor applies a circular mask to the data.This is the base class for specific circular mask processors.Its subclass must implement process_dist_pixel().

Parameters:
inner_radius inner mask radius. optional, default=-1
outer_radius outer mask radius
dx Modify mask center by dx relative to the default center nx/2
dy Modify mask center by dy relative to the default center ny/2
dz Modify mask center by dz relative to the default center nz/2

Definition at line 2344 of file processor.h.


Constructor & Destructor Documentation

EMAN::CircularMaskProcessor::CircularMaskProcessor  )  [inline]
 

Definition at line 2347 of file processor.h.

02347                                        :inner_radius(0), outer_radius(0), inner_radius_square(0),
02348                         outer_radius_square(0), dx(0), dy(0), dz(0), xc(0), yc(0), zc(0)
02349                 {
02350                 }


Member Function Documentation

void CircularMaskProcessor::calc_locals EMData image  )  [protected, virtual]
 

Reimplemented from EMAN::CoordinateProcessor.

Reimplemented in EMAN::MaskEdgeMeanProcessor, and EMAN::MaskGaussInvProcessor.

Definition at line 1536 of file processor.cpp.

References EMAN::Util::fast_floor(), inner_radius, inner_radius_square, outer_radius, outer_radius_square, xc, yc, and zc.

01537 {
01538         xc = Util::fast_floor(nx/2.0f) + dx;
01539         yc = Util::fast_floor(ny/2.0f) + dy;
01540         zc = Util::fast_floor(nz/2.0f) + dz;
01541 
01542         if (outer_radius < 0) {
01543                 outer_radius = nx / 2 + outer_radius +1;
01544                 outer_radius_square = outer_radius * outer_radius;
01545         }
01546 
01547         if (inner_radius <= 0) {
01548                 inner_radius_square = 0;
01549         }
01550 }

string EMAN::CircularMaskProcessor::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.

Reimplemented in EMAN::MaskSharpProcessor, EMAN::MaskEdgeMeanProcessor, EMAN::MaskNoiseProcessor, EMAN::MaskGaussProcessor, EMAN::MaskGaussInvProcessor, EMAN::MakeRadiusSquaredProcessor, and EMAN::MakeRadiusProcessor.

Definition at line 2382 of file processor.h.

02383                 {
02384                         return "CircularMaskProcessor applies a circular mask to the data.This is the base class for specific circular mask processors.Its subclass must implement process_dist_pixel().";
02385                 }

TypeDict EMAN::CircularMaskProcessor::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.

Reimplemented in EMAN::MaskSharpProcessor, EMAN::MaskEdgeMeanProcessor, EMAN::MaskGaussProcessor, and EMAN::MaskGaussInvProcessor.

Definition at line 2387 of file processor.h.

References EMAN::TypeDict::put().

02388                 {
02389                         TypeDict d;
02390 
02391                         d.put("inner_radius", EMObject::INT, "inner mask radius. optional");
02392                         d.put("outer_radius", EMObject::INT, "outer mask radius. Negative value -> box radius + outer_radius +1");
02393 
02394                         d.put("dx", EMObject::FLOAT,
02395                                   "Modify mask center by dx relative to the default center nx/2");
02396                         d.put("dy", EMObject::FLOAT,
02397                                   "Modify mask center by dy relative to the default center ny/2");
02398                         d.put("dz", EMObject::FLOAT,
02399                                   "Modify mask center by dz relative to the default center nz/2");
02400 
02401                         return d;
02402                 }

bool EMAN::CircularMaskProcessor::is_valid  )  const [inline, protected, virtual]
 

Reimplemented from EMAN::CoordinateProcessor.

Definition at line 2406 of file processor.h.

02407                 {
02408                         return (!is_complex);
02409                 }

virtual void EMAN::CircularMaskProcessor::process_dist_pixel float *  pixel,
float  dist
const [protected, pure virtual]
 

Implemented in EMAN::MaskSharpProcessor, EMAN::MaskEdgeMeanProcessor, EMAN::MaskNoiseProcessor, EMAN::MaskGaussProcessor, EMAN::MaskGaussInvProcessor, EMAN::MakeRadiusSquaredProcessor, and EMAN::MakeRadiusProcessor.

void EMAN::CircularMaskProcessor::process_pixel float *  pixel,
int  xi,
int  yi,
int  zi
const [inline, protected, virtual]
 

Implements EMAN::CoordinateProcessor.

Definition at line 2411 of file processor.h.

References dist().

02412                 {
02413                         float dist = (xi - xc) * (xi - xc) + (yi - yc) * (yi - yc) + (zi - zc) * (zi - zc);
02414                         process_dist_pixel(pixel, dist);
02415                 }

void EMAN::CircularMaskProcessor::set_params const Dict new_params  )  [inline, virtual]
 

Set the processor parameters using a key/value dictionary.

Parameters:
new_params A dictionary containing the new parameters.

Reimplemented from EMAN::Processor.

Reimplemented in EMAN::MaskSharpProcessor, EMAN::MaskEdgeMeanProcessor, and EMAN::MaskGaussProcessor.

Definition at line 2352 of file processor.h.

02353                 {
02354                         params = new_params;
02355 
02356                         if (params.has_key("inner_radius")) {
02357                                 inner_radius = params["inner_radius"];
02358                                 inner_radius_square = inner_radius * inner_radius;
02359                         }
02360                         else {
02361                                 inner_radius = -1;
02362                                 inner_radius_square = -1;
02363                         }
02364 
02365                         if (params.has_key("outer_radius")) {
02366                                 outer_radius = params["outer_radius"];
02367                                 outer_radius_square = outer_radius * outer_radius;
02368                         }
02369                         else {
02370                                 outer_radius = INT_MAX;
02371                                 outer_radius_square = INT_MAX;
02372                         }
02373 
02374                         if (params.has_key("xc")) xc = params["xc"];
02375                         if (params.has_key("yc")) yc = params["yc"];
02376                         if (params.has_key("zc")) zc = params["zc"];
02377                         if (params.has_key("dx")) dx = params["dx"];
02378                         if (params.has_key("dy")) dy = params["dy"];
02379                         if (params.has_key("dz")) dz = params["dz"];
02380                 }


Member Data Documentation

float EMAN::CircularMaskProcessor::dx [protected]
 

Definition at line 2423 of file processor.h.

float EMAN::CircularMaskProcessor::dy [protected]
 

Definition at line 2423 of file processor.h.

float EMAN::CircularMaskProcessor::dz [protected]
 

Definition at line 2423 of file processor.h.

int EMAN::CircularMaskProcessor::inner_radius [protected]
 

Definition at line 2419 of file processor.h.

Referenced by calc_locals().

int EMAN::CircularMaskProcessor::inner_radius_square [protected]
 

Definition at line 2421 of file processor.h.

Referenced by calc_locals().

int EMAN::CircularMaskProcessor::outer_radius [protected]
 

Definition at line 2420 of file processor.h.

Referenced by calc_locals().

int EMAN::CircularMaskProcessor::outer_radius_square [protected]
 

Definition at line 2422 of file processor.h.

Referenced by calc_locals().

float EMAN::CircularMaskProcessor::xc [protected]
 

Definition at line 2424 of file processor.h.

Referenced by calc_locals().

float EMAN::CircularMaskProcessor::yc [protected]
 

Definition at line 2424 of file processor.h.

Referenced by calc_locals().

float EMAN::CircularMaskProcessor::zc [protected]
 

Definition at line 2424 of file processor.h.

Referenced by calc_locals().


The documentation for this class was generated from the following files:
Generated on Tue Jun 11 13:42:22 2013 for EMAN2 by  doxygen 1.3.9.1