EMAN::BinarizeFourierProcessor Class Reference

A thresholding processor for Fourier images based on the amplitude component. More...

#include <processor.h>

Inheritance diagram for EMAN::BinarizeFourierProcessor:

Collaboration diagram for EMAN::BinarizeFourierProcessor:

Public Member Functions
virtual string	get_name () const
	Get the processor's name. More...
virtual void	process_inplace (EMData *image)
virtual TypeDict	get_param_types () const
	Get processor parameter information in a dictionary. More...
virtual string	get_desc () const
	Get the descrition of this specific processor. More...
Public Member Functions inherited from EMAN::Processor
virtual	~Processor ()
virtual EMData *	process (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...
virtual void	set_params (const Dict &new_params)
	Set the processor parameters using a key/value dictionary. More...

Static Public Member Functions
static Processor *	NEW ()
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 EMData *	EMFourierFilter (EMData *fimage, Dict params)
	Compute a Fourier-processor processed image without altering the original image. More...

Static Public Attributes
static const string	NAME = "threshold.binary.fourier"

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

A thresholding processor for Fourier images based on the amplitude component.

All maps set below value are set to zero Useful in tomography when you want to toss complex components with low amplitides

Author

John Flanagan

Date

Oct 25th 2010

Parameters

value

The Fourier amplitude threshold cutoff

Definition at line 3236 of file processor.h.

Member Function Documentation

get_desc()

virtual string EMAN::BinarizeFourierProcessor::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 3261 of file processor.h.

                        {
                                return "f(k) = 0 + 0i if ||f(k)|| < value; f(k) = a + bi if ||f(k)|| >= value.";
                        }

get_name()

virtual string EMAN::BinarizeFourierProcessor::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 3239 of file processor.h.

                        {
                                return NAME;
                        }

References NAME.

get_param_types()

virtual TypeDict EMAN::BinarizeFourierProcessor::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 3254 of file processor.h.

                        {
                                TypeDict d;
                                d.put("value", EMObject::FLOAT, "The Fourier amplitude threshold cutoff" );
                                return d;
                        }

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

NEW()

static Processor * EMAN::BinarizeFourierProcessor::NEW ( )

inlinestatic

Definition at line 3243 of file processor.h.

                        {
                                return new BinarizeFourierProcessor();
                        }

process_inplace()

void BinarizeFourierProcessor::process_inplace ( EMData *  image )

virtual

Exceptions

ImageFormatException

if the input image is not complex Note result is always in real-imaginary format

Implements EMAN::Processor.

Definition at line 5314 of file processor.cpp.

                                                            {
        ENTERFUNC;
        if (!image->is_complex()) throw ImageFormatException("Fourier binary thresholding processor only works for complex images");
 
        float threshold = params.set_default("value",0.0f);
        image->ri2ap(); //      works for cuda
 
        float* d = image->get_data();
        for( size_t i = 0; i < image->get_size()/2; ++i, d+=2) {
                if ( *d < threshold ) {
                        *d = 0;
                        *(d+1) = 0;
                }
        }
                image->ap2ri();
        image->set_ri(true); // So it can be used for fourier multiplaction, for example
        image->update();
        EXITFUNC;
}

References ENTERFUNC, EXITFUNC, ImageFormatException, EMAN::Processor::params, and EMAN::Dict::set_default().

Member Data Documentation

NAME

const string BinarizeFourierProcessor::NAME = "threshold.binary.fourier"

static

Definition at line 3266 of file processor.h.

Referenced by get_name().

---

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

• processor.h
• processor.cpp