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


Member Function Documentation

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

Reimplemented from EMAN::CircularMaskProcessor.

Definition at line 1424 of file processor.cpp.

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

01425 {
01426         if (!image) {
01427                 throw NullPointerException("NULL image");
01428         }
01429         int nitems = 0;
01430         float sum = 0;
01431         float *data = image->get_data();
01432         size_t i = 0;
01433 
01434         for (int z = 0; z < nz; ++z) {
01435                 for (int y = 0; y < ny; ++y) {
01436                         for (int x = 0; x < nx; ++x) {
01437                                 float x1 = sqrt((x - xc) * (x - xc) + (y - yc) * (y - yc) + (z - zc) * (z - zc));
01438                                 if (x1 <= outer_radius + ring_width && x1 >= outer_radius - ring_width) {
01439                                         sum += data[i];
01440                                         ++nitems;
01441                                 }
01442                                 ++i;
01443                         }
01444                 }
01445         }
01446 
01447         ring_avg = sum / nitems;
01448 }

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

02289                 {
02290                         return "A step cutoff to the the mean value in a ring centered on the outer radius";
02291                 }

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

02264                 {
02265                         return NAME;
02266                 }

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

References EMAN::TypeDict::put().

02282                 {
02283                         TypeDict d = CircularMaskProcessor::get_param_types();
02284                         d.put("ring_width", EMObject::INT, "The width of the mask ring.");
02285                         return d;
02286                 }

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

Definition at line 2267 of file processor.h.

02268                 {
02269                         return new MaskEdgeMeanProcessor();
02270                 }

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

Implements EMAN::CircularMaskProcessor.

Definition at line 2299 of file processor.h.

References dist().

02300                 {
02301                         if (dist >= outer_radius_square || dist < inner_radius_square){
02302                                 *pixel = ring_avg;
02303                         }
02304                 }

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

02273                 {
02274                         CircularMaskProcessor::set_params(new_params);
02275                         ring_width = params["ring_width"];
02276                         if (ring_width == 0) {
02277                                 ring_width = 1;
02278                         }
02279                 }


Member Data Documentation

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

Definition at line 100 of file processor.cpp.

float EMAN::MaskEdgeMeanProcessor::ring_avg [private]
 

Definition at line 2308 of file processor.h.

Referenced by calc_locals().

int EMAN::MaskEdgeMeanProcessor::ring_width [private]
 

Definition at line 2307 of file processor.h.


The documentation for this class was generated from the following files:
Generated on Thu Dec 9 13:47:50 2010 for EMAN2 by  doxygen 1.3.9.1