EMAN::MaskGaussProcessor Class Reference

a gaussian falloff to zero, radius is the 1/e of the width. More...

#include <processor.h>

Inheritance diagram for EMAN::MaskGaussProcessor:

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

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.gaussian"

Protected Member Functions

void process_dist_pixel (float *pixel, float dist) const

Protected Attributes

float exponent

Detailed Description

a gaussian falloff to zero, radius is the 1/e of the width.

Definition at line 2564 of file processor.h.


Member Function Documentation

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

02593                 {
02594                         return "a gaussian falloff to zero, radius is the 1/e of the width. If inner_radius>0, then \
02595 outer radius specifies width of Gaussian starting at inner_radius rather than total radius.";
02596                 }

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

References NAME.

02568                 {
02569                         return NAME;
02570                 }

TypeDict EMAN::MaskGaussProcessor::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 2585 of file processor.h.

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

02586                 {
02587                         TypeDict d = CircularMaskProcessor::get_param_types();
02588                         d.put("exponent", EMObject::FLOAT, "The exponent, f in e^-Bs^f. default 2.0, producing a Gaussian");
02589                         return d;
02590                 }

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

Definition at line 2571 of file processor.h.

02572                 {
02573                         return new MaskGaussProcessor();
02574                 }

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

Implements EMAN::CircularMaskProcessor.

Definition at line 2602 of file processor.h.

References exponent, EMAN::CircularMaskProcessor::inner_radius, EMAN::CircularMaskProcessor::inner_radius_square, EMAN::CircularMaskProcessor::outer_radius_square, and sqrt().

02603                 {
02604                         if (inner_radius_square>0) {
02605                                 if (dist>inner_radius_square) {
02606                                         if (exponent==2.0f) (*pixel) *= exp(-pow(sqrt(dist)-inner_radius,2.0f) / outer_radius_square);
02607                                         else (*pixel) *= exp(-pow(sqrt(dist)-inner_radius,exponent) / pow((float)outer_radius_square,exponent/2.0f));
02608                                 }
02609                         }
02610                         else {
02611                                 if (exponent==2.0f) (*pixel) *= exp(-dist / outer_radius_square);
02612                                 else (*pixel) *= exp(-pow(dist,exponent/2.0f) / pow((float)outer_radius_square,exponent/2.0f));
02613                         }
02614                 }

void EMAN::MaskGaussProcessor::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 2576 of file processor.h.

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

02577                 {
02578                         CircularMaskProcessor::set_params(new_params);
02579                         exponent = params["exponent"];
02580                         if (exponent <= 0.0) {
02581                                 exponent = 2.0;
02582                         }
02583                 }


Member Data Documentation

float EMAN::MaskGaussProcessor::exponent [protected]

Definition at line 2601 of file processor.h.

Referenced by process_dist_pixel(), and set_params().

const string MaskGaussProcessor::NAME = "mask.gaussian" [static]

Definition at line 2598 of file processor.h.

Referenced by get_name().


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