EMAN2
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
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]

Public Member Functions

string get_name () const
 Get the processor's name. More...
 
void set_params (const Dict &new_params)
 Set the processor parameters using a key/value dictionary. More...
 
TypeDict get_param_types () const
 Get processor parameter information in a dictionary. More...
 
string get_desc () const
 Get the descrition of this specific processor. More...
 
- Public Member Functions inherited from EMAN::RealPixelProcessor
 RealPixelProcessor ()
 
void process_inplace (EMData *image)
 To process an image in-place. More...
 
- Public Member Functions inherited from EMAN::Processor
virtual ~Processor ()
 
virtual EMDataprocess (const EMData *const image)
 To proccess an image out-of-place. More...
 
virtual void process_list_inplace (vector< EMData * > &images)
 To process multiple images using the same algorithm. More...
 
virtual Dict get_params () const
 Get the processor parameters in a key/value dictionary. More...
 

Static Public Member Functions

static ProcessorNEW ()
 
- Static Public Member Functions inherited from EMAN::RealPixelProcessor
static string get_group_desc ()
 
- Static Public Member Functions inherited from EMAN::Processor
static string get_group_desc ()
 Get the description of this group of processors. More...
 
static void EMFourierFilterInPlace (EMData *fimage, Dict params)
 Compute a Fourier-filter processed image in place. More...
 
static EMDataEMFourierFilter (EMData *fimage, Dict params)
 Compute a Fourier-processor processed image without altering the original image. More...
 

Static Public Attributes

static const string NAME = "math.sigma"
 

Protected Member Functions

void process_pixel (float *x) const
 
- Protected Member Functions inherited from EMAN::RealPixelProcessor
virtual void calc_locals (EMData *)
 
virtual void normalize (EMData *) const
 

Private Attributes

float value1
 
float value2
 

Additional Inherited Members

- Public Types inherited from EMAN::Processor
enum  fourier_filter_types {
  TOP_HAT_LOW_PASS , TOP_HAT_HIGH_PASS , TOP_HAT_BAND_PASS , TOP_HOMOMORPHIC ,
  GAUSS_LOW_PASS , GAUSS_HIGH_PASS , GAUSS_BAND_PASS , GAUSS_INVERSE ,
  GAUSS_HOMOMORPHIC , BUTTERWORTH_LOW_PASS , BUTTERWORTH_HIGH_PASS , BUTTERWORTH_HOMOMORPHIC ,
  KAISER_I0 , KAISER_SINH , KAISER_I0_INVERSE , KAISER_SINH_INVERSE ,
  SHIFT , TANH_LOW_PASS , TANH_HIGH_PASS , TANH_HOMOMORPHIC ,
  TANH_BAND_PASS , RADIAL_TABLE , CTF_
}
 Fourier filter Processor type enum. More...
 
- Protected Attributes inherited from EMAN::RealPixelProcessor
float value
 
float maxval
 
float mean
 
float sigma
 
- Protected Attributes inherited from EMAN::Processor
Dict params
 

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

Member Function Documentation

◆ get_desc()

string EMAN::SigmaProcessor::get_desc ( ) const
inlinevirtual

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

3571 {
3572 return "f(x) = mean if x<(mean-v2*sigma) or x>(mean+v1*sigma); else f(x) = x;";
3573 }

◆ get_name()

string EMAN::SigmaProcessor::get_name ( ) const
inlinevirtual

Get the processor's name.

Each processor is identified by a unique name.

Returns
The processor's name.

Implements EMAN::Processor.

Definition at line 3546 of file processor.h.

3547 {
3548 return NAME;
3549 }
static const string NAME
Definition: processor.h:3575

References NAME.

◆ get_param_types()

TypeDict EMAN::SigmaProcessor::get_param_types ( ) const
inlinevirtual

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

3563 {
3564 TypeDict d;
3565 d.put("value1", EMObject::FLOAT, "A number reflecting total standard deviations in the right direction");
3566 d.put("value2", EMObject::FLOAT, "A number reflecting total standard deviations in the left direction");
3567 return d;
3568 }
TypeDict is a dictionary to store <string, EMObject::ObjectType> pair.
Definition: emobject.h:305
void put(const string &key, EMObject::ObjectType o, const string &desc="")
Definition: emobject.h:330

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

◆ NEW()

static Processor * EMAN::SigmaProcessor::NEW ( )
inlinestatic

Definition at line 3550 of file processor.h.

3551 {
3552 return new SigmaProcessor();
3553 }
f(x) = mean if x<(mean-v2*sigma) or x>(mean+v1*sigma); else f(x) = x;
Definition: processor.h:3544

◆ process_pixel()

void EMAN::SigmaProcessor::process_pixel ( float *  x) const
inlineprotectedvirtual

Implements EMAN::RealPixelProcessor.

Definition at line 3578 of file processor.h.

3579 {
3580 if (*x < (mean - value2 * sigma) || *x > (mean + value1 * sigma))
3581 {
3582 *x = mean;
3583 }
3584 }
#define x(i)
Definition: projector.cpp:1517

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

◆ set_params()

void EMAN::SigmaProcessor::set_params ( const Dict new_params)
inlinevirtual

Set the processor parameters using a key/value dictionary.

Parameters
new_paramsA dictionary containing the new parameters.

Reimplemented from EMAN::RealPixelProcessor.

Definition at line 3555 of file processor.h.

3556 {
3557 params = new_params;
3558 value1 = params.get("value1");
3559 value2 = params.get("value2");
3560 }
EMObject get(const string &key) const
Get the EMObject corresponding to the particular key Probably better to just use operator[].
Definition: emobject.h:527

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

Member Data Documentation

◆ NAME

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

Definition at line 3575 of file processor.h.

Referenced by get_name().

◆ value1

float EMAN::SigmaProcessor::value1
private

Definition at line 3587 of file processor.h.

Referenced by process_pixel(), and set_params().

◆ value2

float EMAN::SigmaProcessor::value2
private

Definition at line 3588 of file processor.h.

Referenced by process_pixel(), and set_params().


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