EMAN2
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
EMAN::MorphologicalProcessor Class Referenceabstract

#include <processor.h>

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

Public Member Functions

 MorphologicalProcessor ()
 
void process_inplace (EMData *image)
 To process an image in-place. More...
 
virtual void set_params (const Dict &new_params)
 Set the processor parameters using a key/value dictionary. 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 string get_name () const =0
 Get the processor's name. More...
 
virtual Dict get_params () const
 Get the processor parameters in a key/value dictionary. More...
 
virtual TypeDict get_param_types () const
 Get processor parameter information in a dictionary. More...
 
virtual string get_desc () const =0
 Get the descrition of this specific processor. More...
 

Static Public Member Functions

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

Protected Member Functions

virtual void process_pixel (float *x) const =0
 
virtual void calc_locals (EMData *)
 
virtual void normalize (EMData *) const
 

Protected Attributes

float value
 
float maxval
 
float mean
 
float sigma
 
- Protected Attributes inherited from EMAN::Processor
Dict params
 

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

Detailed Description

Definition at line 9400 of file processor.h.

Constructor & Destructor Documentation

◆ MorphologicalProcessor()

EMAN::MorphologicalProcessor::MorphologicalProcessor ( )
inline

Definition at line 9403 of file processor.h.

Member Function Documentation

◆ calc_locals()

virtual void EMAN::MorphologicalProcessor::calc_locals ( EMData )
inlineprotectedvirtual

Definition at line 9424 of file processor.h.

9425 {
9426 }

◆ get_group_desc()

static string EMAN::MorphologicalProcessor::get_group_desc ( )
inlinestatic

Definition at line 9417 of file processor.h.

9418 {
9419 return "The base class for morphological image processors.";
9420 }

◆ normalize()

virtual void EMAN::MorphologicalProcessor::normalize ( EMData ) const
inlineprotectedvirtual

Definition at line 9427 of file processor.h.

9428 {
9429 }

◆ process_inplace()

void EMAN::MorphologicalProcessor::process_inplace ( EMData image)
virtual

To process an image in-place.

For those processors which can only be processed out-of-place, override this function to just print out some error message to remind user call the out-of-place version.

Parameters
imageThe image to be processed.

Implements EMAN::Processor.

◆ process_pixel()

virtual void EMAN::MorphologicalProcessor::process_pixel ( float *  x) const
protectedpure virtual

◆ set_params()

virtual void EMAN::MorphologicalProcessor::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::Processor.

Definition at line 9408 of file processor.h.

9409 {
9410 params = new_params;
9411 if (params.size() == 1) {
9412 vector < EMObject > dict_values = params.values();
9413 value = dict_values[0];
9414 }
9415 }
vector< EMObject > values() const
Get a vector containing copies of each of the EMObjects in this dictionary.
Definition: emobject.h:487
size_t size() const
Ask the Dictionary for its size.
Definition: emobject.h:519

References EMAN::Processor::params, EMAN::Dict::size(), value, and EMAN::Dict::values().

Member Data Documentation

◆ maxval

float EMAN::MorphologicalProcessor::maxval
protected

Definition at line 9432 of file processor.h.

◆ mean

float EMAN::MorphologicalProcessor::mean
protected

Definition at line 9433 of file processor.h.

◆ sigma

float EMAN::MorphologicalProcessor::sigma
protected

Definition at line 9434 of file processor.h.

◆ value

float EMAN::MorphologicalProcessor::value
protected

Definition at line 9431 of file processor.h.

Referenced by set_params().


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