EMAN::BinarizeFourierProcessor Class Reference

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

#include <processor.h>

Inheritance diagram for EMAN::BinarizeFourierProcessor:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual string get_name () const
 Get the processor's name.
virtual void process_inplace (EMData *image)
 
Exceptions:
ImageFormatException if the input image is not complex Note result is always in real-imaginary format

virtual TypeDict get_param_types () const
 Get processor parameter information in a dictionary.
virtual string get_desc () const
 Get the descrition of this specific processor.

Static Public Member Functions

static ProcessorNEW ()

Static Public Attributes

static const string NAME = "threshold.binary.fourier"

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 1870 of file processor.h.


Member Function Documentation

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

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

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

References NAME.

01874                         {
01875                                 return NAME;
01876                         }

virtual TypeDict EMAN::BinarizeFourierProcessor::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::Processor.

Definition at line 1888 of file processor.h.

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

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

static Processor* EMAN::BinarizeFourierProcessor::NEW (  )  [inline, static]

Definition at line 1877 of file processor.h.

01878                         {
01879                                 return new BinarizeFourierProcessor();
01880                         }

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 3875 of file processor.cpp.

References EMAN::EMData::ap2ri(), ENTERFUNC, EXITFUNC, EMAN::EMData::get_data(), EMAN::EMData::get_size(), ImageFormatException, EMAN::EMData::is_complex(), EMAN::Processor::params, EMAN::EMData::ri2ap(), EMAN::Dict::set_default(), EMAN::EMData::set_ri(), and EMAN::EMData::update().

03875                                                             {
03876         ENTERFUNC;
03877         if (!image->is_complex()) throw ImageFormatException("Fourier binary thresholding processor only works for complex images");
03878 
03879         float threshold = params.set_default("value",0.0f);
03880         image->ri2ap(); //  works for cuda
03881 
03882         float* d = image->get_data();
03883         for( size_t i = 0; i < image->get_size()/2; ++i, d+=2) {
03884                 if ( *d < threshold ) {
03885                         *d = 0;
03886                         *(d+1) = 0;
03887                 } 
03888         }
03889         image->ap2ri();
03890         image->set_ri(true); // So it can be used for fourier multiplaction, for example
03891         image->update();
03892         EXITFUNC;
03893 } 


Member Data Documentation

const string BinarizeFourierProcessor::NAME = "threshold.binary.fourier" [static]

Definition at line 1900 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Tue Jul 12 13:48:50 2011 for EMAN2 by  doxygen 1.4.7