EMAN2
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
EMAN::FiniteProcessor Class Reference

f(x) = f(x) if f(x) is finite | to if f(x) is not finite More...

#include <processor.h>

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

Public Member Functions

 FiniteProcessor ()
 
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.finite"
 

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 to
 

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) = f(x) if f(x) is finite | to if f(x) is not finite

Parameters
toPixels which are not finite will be set to this value

Definition at line 3435 of file processor.h.

Constructor & Destructor Documentation

◆ FiniteProcessor()

EMAN::FiniteProcessor::FiniteProcessor ( )
inline

Definition at line 3438 of file processor.h.

3438 :to(0)
3439 {
3440 }

Referenced by NEW().

Member Function Documentation

◆ get_desc()

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

3466 {
3467 return "f(x) = f(x) if f(x) is finite | to if f(x) is not finite";
3468 }

◆ get_name()

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

3443 {
3444 return NAME;
3445 }
static const string NAME
Definition: processor.h:3470

References NAME.

◆ get_param_types()

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

3459 {
3460 TypeDict d;
3461 d.put("to", EMObject::FLOAT, "Pixels which are not finite will be set to this value");
3462 return d;
3463 }
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::FiniteProcessor::NEW ( )
inlinestatic

Definition at line 3447 of file processor.h.

3448 {
3449 return new FiniteProcessor();
3450 }

References FiniteProcessor().

◆ process_pixel()

void FiniteProcessor::process_pixel ( float *  x) const
protectedvirtual

Implements EMAN::RealPixelProcessor.

Definition at line 629 of file processor.cpp.

630{
631 if ( !Util::goodf(x) ) {
632 *x = to;
633 }
634}
static int goodf(const float *p_f)
Check whether a number is a good float.
Definition: util.h:1112
#define x(i)
Definition: projector.cpp:1517

References EMAN::Util::goodf(), to, and x.

◆ set_params()

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

3453 {
3454 if (new_params.has_key("to") )
3455 to = params["to"];
3456 }
bool has_key(const string &key) const
Ask the Dictionary if it as a particular key.
Definition: emobject.h:511

References EMAN::Dict::has_key(), EMAN::Processor::params, and to.

Member Data Documentation

◆ NAME

const string FiniteProcessor::NAME = "math.finite"
static

Definition at line 3470 of file processor.h.

Referenced by get_name().

◆ to

float EMAN::FiniteProcessor::to
private

Definition at line 3478 of file processor.h.

Referenced by process_pixel(), and set_params().


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