EMAN::MaskEdgeMeanProcessor Class Reference

A step cutoff to the the mean value in a ring centered on the outer radius. More...

#include <processor.h>

Inheritance diagram for EMAN::MaskEdgeMeanProcessor:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

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

Static Public Member Functions

static ProcessorNEW ()

Static Public Attributes

static const string NAME = "mask.ringmean"

Protected Member Functions

void calc_locals (EMData *image)
void process_dist_pixel (float *pixel, float dist) const

Private Attributes

int ring_width
float ring_avg

Detailed Description

A step cutoff to the the mean value in a ring centered on the outer radius.

Parameters:
ring_width The width of the mask ring.

Definition at line 2480 of file processor.h.


Member Function Documentation

void MaskEdgeMeanProcessor::calc_locals ( EMData image  )  [protected, virtual]

Reimplemented from EMAN::CircularMaskProcessor.

Definition at line 1551 of file processor.cpp.

References data, EMAN::EMData::get_data(), NullPointerException, EMAN::CoordinateProcessor::nx, EMAN::CoordinateProcessor::ny, EMAN::CoordinateProcessor::nz, EMAN::CircularMaskProcessor::outer_radius, ring_avg, ring_width, sqrt(), x, EMAN::CircularMaskProcessor::xc, y, EMAN::CircularMaskProcessor::yc, and EMAN::CircularMaskProcessor::zc.

01552 {
01553         if (!image) {
01554                 throw NullPointerException("NULL image");
01555         }
01556         int nitems = 0;
01557         float sum = 0;
01558         float *data = image->get_data();
01559         size_t i = 0;
01560 
01561         for (int z = 0; z < nz; ++z) {
01562                 for (int y = 0; y < ny; ++y) {
01563                         for (int x = 0; x < nx; ++x) {
01564                                 float x1 = sqrt((x - xc) * (x - xc) + (y - yc) * (y - yc) + (z - zc) * (z - zc));
01565                                 if (x1 <= outer_radius + ring_width && x1 >= outer_radius - ring_width) {
01566                                         sum += data[i];
01567                                         ++nitems;
01568                                 }
01569                                 ++i;
01570                         }
01571                 }
01572         }
01573 
01574         ring_avg = sum / nitems;
01575 }

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

Reimplemented from EMAN::CircularMaskProcessor.

Definition at line 2508 of file processor.h.

02509                 {
02510                         return "A step cutoff to the the mean value in a ring centered on the outer radius";
02511                 }

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

References NAME.

02484                 {
02485                         return NAME;
02486                 }

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

Definition at line 2501 of file processor.h.

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

02502                 {
02503                         TypeDict d = CircularMaskProcessor::get_param_types();
02504                         d.put("ring_width", EMObject::INT, "The width of the mask ring.");
02505                         return d;
02506                 }

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

Definition at line 2487 of file processor.h.

02488                 {
02489                         return new MaskEdgeMeanProcessor();
02490                 }

void EMAN::MaskEdgeMeanProcessor::process_dist_pixel ( float *  pixel,
float  dist 
) const [inline, protected, virtual]

Implements EMAN::CircularMaskProcessor.

Definition at line 2519 of file processor.h.

References EMAN::CircularMaskProcessor::inner_radius_square, EMAN::CircularMaskProcessor::outer_radius_square, and ring_avg.

02520                 {
02521                         if (dist >= outer_radius_square || dist < inner_radius_square){
02522                                 *pixel = ring_avg;
02523                         }
02524                 }

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

Definition at line 2492 of file processor.h.

References EMAN::Processor::params, ring_width, and EMAN::CircularMaskProcessor::set_params().

02493                 {
02494                         CircularMaskProcessor::set_params(new_params);
02495                         ring_width = params["ring_width"];
02496                         if (ring_width == 0) {
02497                                 ring_width = 1;
02498                         }
02499                 }


Member Data Documentation

const string MaskEdgeMeanProcessor::NAME = "mask.ringmean" [static]

Definition at line 2513 of file processor.h.

Referenced by get_name().

float EMAN::MaskEdgeMeanProcessor::ring_avg [private]

Definition at line 2528 of file processor.h.

Referenced by calc_locals(), and process_dist_pixel().

int EMAN::MaskEdgeMeanProcessor::ring_width [private]

Definition at line 2527 of file processor.h.

Referenced by calc_locals(), and set_params().


The documentation for this class was generated from the following files:
Generated on Thu May 3 10:09:59 2012 for EMAN2 by  doxygen 1.4.7