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

EMAN::FourierProcessor Class Reference

base class for Fourier filters More...

#include <processor.h>

Inheritance diagram for EMAN::FourierProcessor:

[legend]
Collaboration diagram for EMAN::FourierProcessor:
[legend]
List of all members.

Public Member Functions

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

string get_group_desc ()
 Get the description of this group of processors.

Protected Member Functions

virtual void preprocess (EMData *image)
virtual void create_radial_func (vector< float > &radial_mask) const =0

Detailed Description

base class for Fourier filters

Parameters:
cutoff_abs Processor radius in terms of Nyquist (0-.5).
cutoff_pixels Width in Fourier pixels (0 - size()/2).
cutoff_freq Resolution in 1/A (0 - 1 / size*apix).
apix Override A/pix in the image header (changes x,y and z).

Definition at line 336 of file processor.h.


Member Function Documentation

virtual void EMAN::FourierProcessor::create_radial_func vector< float > &  radial_mask  )  const [protected, pure virtual]
 

Implemented in EMAN::LinearRampFourierProcessor, EMAN::LowpassSharpCutoffProcessor, EMAN::HighpassSharpCutoffProcessor, EMAN::LowpassGaussProcessor, EMAN::HighpassGaussProcessor, EMAN::LowpassTanhProcessor, EMAN::HighpassTanhProcessor, EMAN::HighpassButterworthProcessor, and EMAN::LinearRampProcessor.

Referenced by process_inplace().

string EMAN::FourierProcessor::get_group_desc  )  [inline, static]
 

Get the description of this group of processors.

This function is defined in a parent class. It gives a introduction to a group of processors.

Returns:
The description of this group of processors.

Reimplemented from EMAN::Processor.

Reimplemented in EMAN::LowpassFourierProcessor, and EMAN::HighpassFourierProcessor.

Definition at line 341 of file processor.h.

00342                 {
00343                         return "Fourier Filter processors are a group of processor in the frequency domain. Before using such processors on an image, the image must be transformed from real space to the fourier space. FourierProcessor class is the base class of fourier space processors. Each specific processor is either a lowpass filter processor, or a highpass filter processor, or neighter. The unit of lowpass and highpass parameters are in terms of Nyquist, valid range is [0,0.5]. ";
00344                 }

TypeDict EMAN::FourierProcessor::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.

Reimplemented in EMAN::LowpassFourierProcessor, EMAN::HighpassFourierProcessor, and EMAN::LinearRampProcessor.

Definition at line 346 of file processor.h.

References EMAN::TypeDict::put().

00347                 {
00348                         TypeDict d;
00349                         d.put("cutoff_abs", EMObject::FLOAT, "Processor radius in terms of Nyquist (0-.5)");
00350                         d.put("cutoff_pixels", EMObject::FLOAT, " Width in Fourier pixels (0 - size()/2)");
00351                         d.put("cutoff_freq", EMObject::FLOAT, "Resolution in 1/A (0 - 1 / size*apix)");
00352                         d.put("apix", EMObject::FLOAT, " Override A/pix in the image header (changes x,y and z)");
00353                         return d;
00354                 }

virtual void EMAN::FourierProcessor::preprocess EMData image  )  [inline, protected, virtual]
 

Reimplemented in EMAN::LowpassFourierProcessor, and EMAN::HighpassFourierProcessor.

Definition at line 357 of file processor.h.

Referenced by process_inplace().

00357 {}

void FourierProcessor::process_inplace EMData image  )  [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:
image The image to be processed.

Implements EMAN::Processor.

Definition at line 538 of file processor.cpp.

References EMAN::EMData::apply_radial_func(), create_radial_func(), EMAN::EMData::do_fft(), EMAN::EMData::do_ift(), FFTRADIALOVERSAMPLE, EMAN::EMData::get_data(), EMAN::EMData::get_xsize(), EMAN::EMData::get_ysize(), EMAN::EMData::get_zsize(), EMAN::EMData::is_complex(), LOGWARN, preprocess(), and EMAN::EMData::update().

00539 {
00540         if (!image) {
00541                 LOGWARN("NULL Image");
00542                 return;
00543         }
00544 
00545         preprocess(image);
00546 
00547         int array_size = FFTRADIALOVERSAMPLE * image->get_ysize();
00548         float step=0.5f/array_size;
00549 
00550         vector < float >yarray(array_size);
00551 
00552         create_radial_func(yarray);
00553 
00554         if (image->is_complex()) {
00555                 image->apply_radial_func(0, step, yarray);
00556         }
00557         else {
00558                 EMData *fft = image->do_fft();
00559                 fft->apply_radial_func(0, step, yarray);
00560                 EMData *ift = fft->do_ift();
00561 
00562                 memcpy(image->get_data(),ift->get_data(),ift->get_xsize()*ift->get_ysize()*ift->get_zsize()*sizeof(float));
00563 
00564                 //ift->update(); Unecessary
00565 
00566                 if( fft )
00567                 {
00568                         delete fft;
00569                         fft = 0;
00570                 }
00571 
00572                 if( ift )
00573                 {
00574                         delete ift;
00575                         ift = 0;
00576                 }
00577         }
00578 
00579         image->update();
00580 }


The documentation for this class was generated from the following files:
Generated on Fri Apr 30 15:39:18 2010 for EMAN2 by  doxygen 1.3.9.1