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

processor radial function: f(x) = 1/sqrt(2*pi)*[1/sigma1*exp-(x^2/2*sigma1^2) - 1/sigma2*exp-(x^2/2*sigma2^2)] More...

#include <processor.h>

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

Public Member Functions

 DoGFourierProcessor ()
 
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.DoG"
 

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 sigma1
 
float sigma2
 

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) = 1/sqrt(2*pi)*[1/sigma1*exp-(x^2/2*sigma1^2) - 1/sigma2*exp-(x^2/2*sigma2^2)]

Parameters
sigma1DoG sigma1
sigma1DoG sigma2

Definition at line 2130 of file processor.h.

Constructor & Destructor Documentation

◆ DoGFourierProcessor()

EMAN::DoGFourierProcessor::DoGFourierProcessor ( )
inline

Definition at line 2133 of file processor.h.

2133 :sigma1(0), sigma2(0)
2134 {
2135 }

Referenced by NEW().

Member Function Documentation

◆ create_radial_func()

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

Implements EMAN::FourierProcessor.

Definition at line 2189 of file processor.cpp.

2190{
2191
2192 Assert(radial_mask.size() > 0);
2193 float x = 0.0f , nqstep = 0.5f/radial_mask.size();
2194 size_t size=radial_mask.size();
2195 float norm = 1.0f/sqrt(2*M_PI);
2196 for (size_t i = 0; i < size; i++) {
2197 radial_mask[i] = norm*((1.0f/sigma1*exp(-x*x/(2.0f*sigma1*sigma1))) - (1.0f/sigma2*exp(-x*x/(2.0f*sigma2*sigma2))));
2198 x += nqstep;
2199 }
2200}
#define Assert(s)
Define Assert() function that is effective only when -DDEBUG is used.
Definition: emassert.h:42
EMData * sqrt() const
return square root of current image
#define x(i)
Definition: projector.cpp:1517

References Assert, sigma1, sigma2, sqrt(), and x.

◆ get_desc()

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

2147 {
2148 return "processor radial function: f(x) = 1/sqrt(2*pi)*[1/sigma1*exp-(x^2/2*sigma1^2) - 1/sigma2*exp-(x^2/2*sigma2^2)]";
2149 }

◆ get_name()

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

2138 {
2139 return NAME;
2140 }
static const string NAME
Definition: processor.h:2166

References NAME.

◆ get_param_types()

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

2159 {
2160 TypeDict d;
2161 d.put("sigma1", EMObject::FLOAT, "DoG sigma1");
2162 d.put("sigma2", EMObject::FLOAT, "DoG sigma2");
2163 return d;
2164 }
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::DoGFourierProcessor::NEW ( )
inlinestatic

Definition at line 2141 of file processor.h.

2142 {
2143 return new DoGFourierProcessor();
2144 }

References DoGFourierProcessor().

◆ set_params()

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

2152 {
2153 params = new_params;
2154 sigma1 = params["sigma1"];
2155 sigma2 = params["sigma2"];
2156 }

References EMAN::Processor::params, sigma1, and sigma2.

Member Data Documentation

◆ NAME

const string DoGFourierProcessor::NAME = "filter.DoG"
static

Definition at line 2166 of file processor.h.

Referenced by get_name().

◆ sigma1

float EMAN::DoGFourierProcessor::sigma1
private

Definition at line 2172 of file processor.h.

Referenced by create_radial_func(), and set_params().

◆ sigma2

float EMAN::DoGFourierProcessor::sigma2
private

Definition at line 2173 of file processor.h.

Referenced by create_radial_func(), and set_params().


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