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

processor radial function: f(x) = ((x^2 - s^2)/s^4)e^-(x^2/2s^2) More...

#include <processor.h>

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

Public Member Functions

 LoGFourierProcessor ()
 
string get_name () const
 Get the processor's name. More...
 
string get_desc () const
 Get the descrition of this specific processor. 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...
 
- Public Member Functions inherited from EMAN::FourierProcessor
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::FourierProcessor
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 = "filter.LoG"
 

Protected Member Functions

void create_radial_func (vector< float > &radial_mask) const
 
- Protected Member Functions inherited from EMAN::FourierProcessor
virtual void preprocess (EMData *image)
 

Private Attributes

float sigma
 

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::Processor
Dict params
 

Detailed Description

processor radial function: f(x) = ((x^2 - s^2)/s^4)e^-(x^2/2s^2)

Parameters
sigmaLoG sigma

Definition at line 2083 of file processor.h.

Constructor & Destructor Documentation

◆ LoGFourierProcessor()

EMAN::LoGFourierProcessor::LoGFourierProcessor ( )
inline

Definition at line 2086 of file processor.h.

2086 :sigma(0)
2087 {
2088 }

Referenced by NEW().

Member Function Documentation

◆ create_radial_func()

void LoGFourierProcessor::create_radial_func ( vector< float > &  radial_mask) const
protectedvirtual

Implements EMAN::FourierProcessor.

Definition at line 2176 of file processor.cpp.

2177{
2178
2179 Assert(radial_mask.size() > 0);
2180 float x = 0.0f , nqstep = 0.5f/radial_mask.size();
2181 size_t size=radial_mask.size();
2182 float var = sigma*sigma;
2183 for (size_t i = 0; i < size; i++) {
2184 radial_mask[i] = ((x*x - var)/var*var)*exp(-x*x/2*var);
2185 x += nqstep;
2186 }
2187}
#define Assert(s)
Define Assert() function that is effective only when -DDEBUG is used.
Definition: emassert.h:42
#define x(i)
Definition: projector.cpp:1517

References Assert, sigma, and x.

◆ get_desc()

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

2100 {
2101 return "processor radial function: f(x) = ((x^2 - s^2)/s^4)e^-(x^2/2s^2)";
2102 }

◆ get_name()

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

2091 {
2092 return NAME;
2093 }
static const string NAME
Definition: processor.h:2117

References NAME.

◆ get_param_types()

TypeDict EMAN::LoGFourierProcessor::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::FourierProcessor.

Definition at line 2110 of file processor.h.

2111 {
2112 TypeDict d;
2113 d.put("sigma", EMObject::FLOAT, "LoG sigma");
2114 return d;
2115 }
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::LoGFourierProcessor::NEW ( )
inlinestatic

Definition at line 2094 of file processor.h.

2095 {
2096 return new LoGFourierProcessor();
2097 }

References LoGFourierProcessor().

◆ set_params()

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

2105 {
2106 params = new_params;
2107 sigma = params["sigma"];
2108 }

References EMAN::Processor::params, and sigma.

Member Data Documentation

◆ NAME

const string LoGFourierProcessor::NAME = "filter.LoG"
static

Definition at line 2117 of file processor.h.

Referenced by get_name().

◆ sigma

float EMAN::LoGFourierProcessor::sigma
private

Definition at line 2123 of file processor.h.

Referenced by create_radial_func(), and set_params().


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