Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

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)
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

ProcessorNEW ()

Static Public Attributes

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

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

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

01870                         {
01871                                 return NAME;
01872                         }

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

References EMAN::TypeDict::put().

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

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

Definition at line 1873 of file processor.h.

01874                         {
01875                                 return new BinarizeFourierProcessor();
01876                         }

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

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

03890                                                             {
03891         ENTERFUNC;
03892         if (!image->is_complex()) throw ImageFormatException("Fourier binary thresholding processor only works for complex images");
03893 
03894         float threshold = params.set_default("value",0.0f);
03895         image->ri2ap(); //  works for cuda
03896 
03897         float* d = image->get_data();
03898         for( size_t i = 0; i < image->get_size()/2; ++i, d+=2) {
03899                 if ( *d < threshold ) {
03900                         *d = 0;
03901                         *(d+1) = 0;
03902                 } 
03903         }
03904         image->ap2ri();
03905         image->set_ri(true); // So it can be used for fourier multiplaction, for example
03906         image->update();
03907         EXITFUNC;
03908 } 


Member Data Documentation

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

Definition at line 96 of file processor.cpp.


The documentation for this class was generated from the following files:
Generated on Thu Nov 17 12:45:58 2011 for EMAN2 by  doxygen 1.3.9.1