EMAN2
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes
EMAN::SigmaProcessor Class Reference

f(x) = mean if x<(mean-v2*sigma) or x>(mean+v1*sigma); else f(x) = x; More...

#include <processor.h>

Inheritance diagram for EMAN::SigmaProcessor:
Inheritance graph
[legend]
Collaboration diagram for EMAN::SigmaProcessor:
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 = "math.sigma"

Protected Member Functions

void process_pixel (float *x) const

Private Attributes

float value1
float value2

Detailed Description

f(x) = mean if x<(mean-v2*sigma) or x>(mean+v1*sigma); else f(x) = x;

Parameters:
value1A number reflecting total standard deviations in the right direction
value2A number reflecting total standard deviations in the left direction

Definition at line 2352 of file processor.h.


Member Function Documentation

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

Definition at line 2379 of file processor.h.

                {
                        return "f(x) = mean if x<(mean-v2*sigma) or x>(mean+v1*sigma); else f(x) = x;";
                }
string EMAN::SigmaProcessor::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 2355 of file processor.h.

References NAME.

                {
                        return NAME;
                }
TypeDict EMAN::SigmaProcessor::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.

Definition at line 2371 of file processor.h.

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

                {
                        TypeDict d;
                        d.put("value1", EMObject::FLOAT, "A number reflecting total standard deviations in the right direction");
                        d.put("value2", EMObject::FLOAT, "A number reflecting total standard deviations in the left direction");
                        return d;
                }
static Processor* EMAN::SigmaProcessor::NEW ( ) [inline, static]

Definition at line 2359 of file processor.h.

                {
                        return new SigmaProcessor();
                }
void EMAN::SigmaProcessor::process_pixel ( float *  x) const [inline, protected, virtual]

Implements EMAN::RealPixelProcessor.

Definition at line 2387 of file processor.h.

References EMAN::RealPixelProcessor::mean, EMAN::RealPixelProcessor::sigma, value1, and value2.

                {
                        if (*x < (mean - value2 * sigma) || *x > (mean + value1 * sigma))
                        {
                                *x = mean;
                        }
                }
void EMAN::SigmaProcessor::set_params ( const Dict new_params) [inline, virtual]

Set the processor parameters using a key/value dictionary.

Parameters:
new_paramsA dictionary containing the new parameters.

Reimplemented from EMAN::RealPixelProcessor.

Definition at line 2364 of file processor.h.

References EMAN::Dict::get(), EMAN::Processor::params, value1, and value2.

                {
                        params = new_params;
                        value1 = params.get("value1");
                        value2 = params.get("value2");
                }

Member Data Documentation

const string SigmaProcessor::NAME = "math.sigma" [static]

Definition at line 2384 of file processor.h.

Referenced by get_name().

Definition at line 2396 of file processor.h.

Referenced by process_pixel(), and set_params().

Definition at line 2397 of file processor.h.

Referenced by process_pixel(), and set_params().


The documentation for this class was generated from the following files: