EMAN::FourierProcessor Class Reference

base class for Fourier filters More...

#include <processor.h>

Inheritance diagram for EMAN::FourierProcessor:

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

Collaboration graph
[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

static 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().

static 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::EMObject::FLOAT, and EMAN::TypeDict::put().

Referenced by EMAN::HighpassFourierProcessor::get_param_types(), and EMAN::LowpassFourierProcessor::get_param_types().

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 540 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().

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


The documentation for this class was generated from the following files:
Generated on Mon Jul 19 12:42:53 2010 for EMAN2 by  doxygen 1.4.7