EMAN::WaveletProcessor Class Reference

Perform a Wavelet transform using GSL. More...

#include <processor.h>

Inheritance diagram for EMAN::WaveletProcessor:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual void process_inplace (EMData *image)
 To process an image in-place.
virtual string get_name () const
 Get the processor's name.
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 = "basis.wavelet"

Detailed Description

Perform a Wavelet transform using GSL.

Author:
Steve Ludtke <sludtke@bcm.edu>
Date:
10/15/2006
Parameters:
type "daub", "harr", or "bspl"
dir 1 for forward transform, -1 for inverse transform
ord for Daubechies (4,6,8,...,20), for Harr (2), for B-Splines (103, 105, 202, 204, 206, 208, 301, 303, 305 307, 309)

Definition at line 6633 of file processor.h.


Member Function Documentation

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

06658                 {
06659                         return "Computes the DWT (discrete wavelet transform) of an image in one of 3 possible bases";
06660                 }

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

References NAME.

Referenced by process_inplace().

06639                 {
06640                         return NAME;
06641                 }

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

References EMAN::EMObject::INT, EMAN::TypeDict::put(), and EMAN::EMObject::STRING.

06649                 {
06650                         TypeDict d;
06651                         d.put("type", EMObject::STRING, "'daub', 'harr' or 'bspl'");
06652                         d.put("dir", EMObject::INT, "1 for forward transform, -1 for inverse transform");
06653                         d.put("ord", EMObject::INT, "Daubechies (4,6,8,...,20), for Harr (2), for B-Splines (103, 105, 202, 204, 206, 208, 301, 303, 305 307, 309)");
06654                         return d;
06655                 }

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

Definition at line 6643 of file processor.h.

06644                 {
06645                         return new WaveletProcessor();
06646                 }

void WaveletProcessor::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 8119 of file processor.cpp.

References get_name(), EMAN::EMData::get_value_at(), EMAN::EMData::get_xsize(), EMAN::EMData::get_ysize(), EMAN::EMData::get_zsize(), ImageDimensionException, InvalidStringException, EMAN::Util::IsPower2(), LOGERR, EMAN::Processor::params, and EMAN::EMData::set_value_at_fast().

08120 {
08121         if (image->get_zsize() != 1) {
08122                         LOGERR("%s Processor doesn't support 3D", get_name().c_str());
08123                         throw ImageDimensionException("3D model not supported");
08124         }
08125 
08126         int i,nx,ny;
08127         const gsl_wavelet_type * T;
08128         nx=image->get_xsize();
08129         ny=image->get_ysize();
08130 
08131         if (nx != ny && ny!=1) throw ImageDimensionException("Wavelet transform only supports square images");
08132 //      float l=log((float)nx)/log(2.0f);
08133 //      if (l!=floor(l)) throw ImageDimensionException("Wavelet transform size must be power of 2");
08134         if( !Util::IsPower2(nx) )  throw ImageDimensionException("Wavelet transform size must be power of 2");
08135 
08136         // Unfortunately GSL works only on double() arrays
08137         // eventually we should put our own wavelet code in here
08138         // but this will work for now
08139         double *cpy = (double *)malloc(nx*ny*sizeof(double));
08140 
08141         for (i=0; i<nx*ny; i++) cpy[i]=image->get_value_at(i,0,0);
08142 
08143         string tp = (const char*)params["type"];
08144         if (tp=="daub") T=gsl_wavelet_daubechies;
08145         else if (tp=="harr") T=gsl_wavelet_haar;
08146         else if (tp=="bspl") T=gsl_wavelet_bspline;
08147         else throw InvalidStringException(tp,"Invalid wavelet name, 'daub', 'harr' or 'bspl'");
08148 
08149         int K=(int)params["ord"];
08150         gsl_wavelet_direction dir;
08151         if ((int)params["dir"]==1) dir=forward;
08152         else dir=backward;
08153 
08154         gsl_wavelet *w = gsl_wavelet_alloc(T, K);
08155         gsl_wavelet_workspace *work = gsl_wavelet_workspace_alloc(nx);
08156 
08157         if (ny==1) gsl_wavelet_transform (w,cpy, 1, nx, dir, work);
08158         else gsl_wavelet2d_transform (w, cpy, nx,nx,ny, dir, work);
08159 
08160         gsl_wavelet_workspace_free (work);
08161         gsl_wavelet_free (w);
08162 
08163         for (i=0; i<nx*ny; i++) image->set_value_at_fast(i,0,0,static_cast<float>(cpy[i]));
08164 
08165         free(cpy);
08166 }


Member Data Documentation

const string WaveletProcessor::NAME = "basis.wavelet" [static]

Definition at line 6662 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Thu Nov 17 12:47:03 2011 for EMAN2 by  doxygen 1.4.7