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

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

ProcessorNEW ()

Static Public Attributes

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


Member Function Documentation

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

Reimplemented from EMAN::CircularMaskProcessor.

Definition at line 1479 of file processor.cpp.

References data, EMAN::EMData::get_data(), NullPointerException, ring_avg, sqrt(), x, and y.

01480 {
01481         if (!image) {
01482                 throw NullPointerException("NULL image");
01483         }
01484         int nitems = 0;
01485         float sum = 0;
01486         float *data = image->get_data();
01487         size_t i = 0;
01488 
01489         for (int z = 0; z < nz; ++z) {
01490                 for (int y = 0; y < ny; ++y) {
01491                         for (int x = 0; x < nx; ++x) {
01492                                 float x1 = sqrt((x - xc) * (x - xc) + (y - yc) * (y - yc) + (z - zc) * (z - zc));
01493                                 if (x1 <= outer_radius + ring_width && x1 >= outer_radius - ring_width) {
01494                                         sum += data[i];
01495                                         ++nitems;
01496                                 }
01497                                 ++i;
01498                         }
01499                 }
01500         }
01501 
01502         ring_avg = sum / nitems;
01503 }

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

02464                 {
02465                         return "A step cutoff to the the mean value in a ring centered on the outer radius";
02466                 }

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

02439                 {
02440                         return NAME;
02441                 }

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

References EMAN::TypeDict::put().

02457                 {
02458                         TypeDict d = CircularMaskProcessor::get_param_types();
02459                         d.put("ring_width", EMObject::INT, "The width of the mask ring.");
02460                         return d;
02461                 }

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

Definition at line 2442 of file processor.h.

02443                 {
02444                         return new MaskEdgeMeanProcessor();
02445                 }

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

Implements EMAN::CircularMaskProcessor.

Definition at line 2474 of file processor.h.

References dist().

02475                 {
02476                         if (dist >= outer_radius_square || dist < inner_radius_square){
02477                                 *pixel = ring_avg;
02478                         }
02479                 }

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

02448                 {
02449                         CircularMaskProcessor::set_params(new_params);
02450                         ring_width = params["ring_width"];
02451                         if (ring_width == 0) {
02452                                 ring_width = 1;
02453                         }
02454                 }


Member Data Documentation

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

Definition at line 105 of file processor.cpp.

float EMAN::MaskEdgeMeanProcessor::ring_avg [private]
 

Definition at line 2483 of file processor.h.

Referenced by calc_locals().

int EMAN::MaskEdgeMeanProcessor::ring_width [private]
 

Definition at line 2482 of file processor.h.


The documentation for this class was generated from the following files:
Generated on Thu Nov 17 12:46:03 2011 for EMAN2 by  doxygen 1.3.9.1