EMAN2
Public Member Functions | Static Public Member Functions | Static Public Attributes
EMAN::NewLowpassGaussProcessor Class Reference

Lowpass Gauss filter processor applied in Fourier space. More...

#include <processor_sparx.h>

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

List of all members.

Public Member Functions

string get_name () const
 Get the processor's name.
string get_desc () const
 Get the descrition of this specific processor.
void process_inplace (EMData *image)
 To process an image in-place.
TypeDict get_param_types () const
 Get processor parameter information in a dictionary.

Static Public Member Functions

static ProcessorNEW ()

Static Public Attributes

static const string NAME = "filter.lowpass.gauss"

Detailed Description

Lowpass Gauss filter processor applied in Fourier space.

Parameters:
cutoff_absGaussian sigma.

Definition at line 310 of file processor_sparx.h.


Member Function Documentation

string EMAN::NewLowpassGaussProcessor::get_desc ( ) const [inline, virtual]

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 317 of file processor_sparx.h.

                {
                        return "Lowpass Gauss filter processor applied in Fourier space.";
                }
string EMAN::NewLowpassGaussProcessor::get_name ( ) const [inline, virtual]

Get the processor's name.

Each processor is identified by a unique name.

Returns:
The processor's name.

Implements EMAN::Processor.

Definition at line 313 of file processor_sparx.h.

References NAME.

                { return NAME; }
TypeDict EMAN::NewLowpassGaussProcessor::get_param_types ( ) const [inline, virtual]

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

Definition at line 338 of file processor_sparx.h.

References EMAN::EMObject::FLOAT, and EMAN::TypeDict::put().

                {
                        TypeDict d = NewFourierProcessor::get_param_types();
                        d.put("cutoff_resolv", EMObject::FLOAT, "Resolvibility in 1/A, applied using filter.lowpass.gauss where cutoff_freq = 2/(pi*R) & R = 1/cutoff_resolv*apix");
                        return d;
                }
static Processor* EMAN::NewLowpassGaussProcessor::NEW ( ) [inline, static]

Definition at line 315 of file processor_sparx.h.

                { return new NewLowpassGaussProcessor(); }
void EMAN::NewLowpassGaussProcessor::process_inplace ( EMData image) [inline, 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.

Definition at line 321 of file processor_sparx.h.

References EMAN::Processor::EMFourierFilterInPlace(), EMAN::Processor::GAUSS_LOW_PASS, EMAN::EMData::get_attr_dict(), EMAN::Dict::has_key(), log(), EMAN::Processor::params, EMAN::NewFourierProcessor::preprocessandconvertpars(), R, and sqrt().

                                                    {
                        params["filter_type"] = GAUSS_LOW_PASS;
                        preprocessandconvertpars(image);
                        
                        if(params.has_key("cutoff_resolv")){
                          
                                const Dict dict = image->get_attr_dict();
                        
                                // here I have added a little function to filter to a resolvability (John Flanagan 20/09/2010)
                                float R = 1/((float)params["cutoff_resolv"]*(float)dict["apix_x"]);    // convert to pixels
                                float rsigma = sqrt(-4*log(0.36))/(M_PI*R);        // find optimal sigma
                                params["cutoff_abs"] = rsigma / sqrt(2.0f);                               // patch to fix the 2s^2 problem
                                params["sigma"] = rsigma / sqrt(2.0f);                                    // patch to fix the 2s^2 problem
                        }
                        
                        EMFourierFilterInPlace(image, params);
                }

Member Data Documentation

const string NewLowpassGaussProcessor::NAME = "filter.lowpass.gauss" [static]

Definition at line 345 of file processor_sparx.h.

Referenced by get_name().


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