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

#include <processor.h>

Inheritance diagram for EMAN::DiscritizeProcessor:
Inheritance graph
[legend]
Collaboration diagram for EMAN::DiscritizeProcessor:
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 = "threshold.discritize.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
 

Protected Attributes

float center
 
float step
 
- Protected Attributes inherited from EMAN::RealPixelProcessor
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 2541 of file processor.h.

Member Function Documentation

◆ get_desc()

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

2572 {
2573 return "Converts each pixel value to the integral number of standard deviations from the specified center. Rounds to the nearest integer, -0.5*sigma<x<0.5*sigma -> 0.0 ";
2574 }

◆ get_name()

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

2545 {
2546 return NAME;
2547 }
static const string NAME
Definition: processor.h:2576

References NAME.

◆ get_param_types()

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

2564 {
2565 TypeDict d;
2566 d.put("center", EMObject::FLOAT, "Center value from which number of standard deviations is computed (default = 0)");
2567 d.put("step", EMObject::FLOAT, "Stepsize in terms of sigma. ie - 1.5 will discritize to 1.5*sigma steps (default = 1.0)");
2568 return d;
2569 }
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::DiscritizeProcessor::NEW ( )
inlinestatic

Definition at line 2548 of file processor.h.

2549 {
2550 return new DiscritizeProcessor();
2551 }

◆ process_pixel()

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

Implements EMAN::RealPixelProcessor.

Definition at line 2581 of file processor.h.

2582 {
2583 *x = Util::fast_floor((*x-center)/(step*sigma)+0.5)*step;
2584 }
static int fast_floor(float x)
A fast way to calculate a floor, which is largest integral value not greater than argument.
Definition: util.h:874
#define x(i)
Definition: projector.cpp:1517

References center, EMAN::Util::fast_floor(), EMAN::RealPixelProcessor::sigma, step, and x.

◆ set_params()

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

2554 {
2555 params = new_params;
2556 if (params.has_key("center")) center=params["center"];
2557 else center=0.0;
2558 if (params.has_key("step")) center=params["step"];
2559 else step=1.0;
2560 if (step<=0) step=1.0;
2561 }
bool has_key(const string &key) const
Ask the Dictionary if it as a particular key.
Definition: emobject.h:511

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

Member Data Documentation

◆ center

float EMAN::DiscritizeProcessor::center
protected

Definition at line 2579 of file processor.h.

Referenced by process_pixel(), and set_params().

◆ NAME

const string DiscritizeProcessor::NAME = "threshold.discritize.sigma"
static

Definition at line 2576 of file processor.h.

Referenced by get_name().

◆ step

float EMAN::DiscritizeProcessor::step
protected

Definition at line 2579 of file processor.h.

Referenced by process_pixel(), and set_params().


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