Perform a Wavelet transform using GSL. More...

#include <processor.h>

Inheritance diagram for EMAN::WaveletProcessor:

Collaboration diagram for EMAN::WaveletProcessor:

[legend]

Public Member Functions
virtual void	process_inplace (EMData *image)
	To process an image in-place. More...

virtual string	get_name () const
	Get the processor's name. More...

virtual TypeDict	get_param_types () const
	Get processor parameter information in a dictionary. More...

virtual string	get_desc () const
	Get the descrition of this specific processor. More...

Public Member Functions inherited from EMAN::Processor
virtual	~Processor ()

virtual EMData *	process (const EMData *const image)
	To proccess an image out-of-place. More...

virtual void	process_list_inplace (vector< EMData * > &images)
	To process multiple images using the same algorithm. More...

virtual Dict	get_params () const
	Get the processor parameters in a key/value dictionary. More...

virtual void	set_params (const Dict &new_params)
	Set the processor parameters using a key/value dictionary. More...

Static Public Member Functions
static Processor *	NEW ()

Static Public Member Functions inherited from EMAN::Processor
static string	get_group_desc ()
	Get the description of this group of processors. More...

static void	EMFourierFilterInPlace (EMData *fimage, Dict params)
	Compute a Fourier-filter processed image in place. More...

static EMData *	EMFourierFilter (EMData *fimage, Dict params)
	Compute a Fourier-processor processed image without altering the original image. More...

Static Public Attributes
static const string	NAME = "basis.wavelet"

Additional Inherited Members
Public Types inherited from EMAN::Processor
enum	fourier_filter_types { TOP_HAT_LOW_PASS , TOP_HAT_HIGH_PASS , TOP_HAT_BAND_PASS , TOP_HOMOMORPHIC , GAUSS_LOW_PASS , GAUSS_HIGH_PASS , GAUSS_BAND_PASS , GAUSS_INVERSE , GAUSS_HOMOMORPHIC , BUTTERWORTH_LOW_PASS , BUTTERWORTH_HIGH_PASS , BUTTERWORTH_HOMOMORPHIC , KAISER_I0 , KAISER_SINH , KAISER_I0_INVERSE , KAISER_SINH_INVERSE , SHIFT , TANH_LOW_PASS , TANH_HIGH_PASS , TANH_HOMOMORPHIC , TANH_BAND_PASS , RADIAL_TABLE , CTF_ }
	Fourier filter Processor type enum. More...

Protected Attributes inherited from EMAN::Processor
Dict	params

Detailed Description

Perform a Wavelet transform using GSL.

Author: Steve Ludtke sludt.nosp@m.ke@b.nosp@m.cm.ed.nosp@m.u

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

Member Function Documentation

◆ get_desc()

virtual string EMAN::WaveletProcessor::get_desc ( ) const

inlinevirtual

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

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

◆ get_name()

virtual string EMAN::WaveletProcessor::get_name ( ) const

inlinevirtual

Get the processor's name.

Each processor is identified by a unique name.

Returns: The processor's name.

Implements EMAN::Processor.

Definition at line 8963 of file processor.h.

                {
                        return NAME;
                }

References NAME.

Referenced by process_inplace().

◆ get_param_types()

virtual TypeDict EMAN::WaveletProcessor::get_param_types ( ) const

inlinevirtual

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

                {
                        TypeDict d;
                        d.put("type", EMObject::STRING, "'daub', 'harr' or 'bspl'");
                        d.put("dir", EMObject::INT, "1 for forward transform, -1 for inverse transform");
                        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)");
                        return d;
                }

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

◆ NEW()

static Processor * EMAN::WaveletProcessor::NEW ( )

inlinestatic

Definition at line 8968 of file processor.h.

                {
                        return new WaveletProcessor();
                }

◆ process_inplace()

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

{
        if (image->get_zsize() != 1) {
                        LOGERR("%s Processor doesn't support 3D", get_name().c_str());
                        throw ImageDimensionException("3D model not supported");
        }
 
        int i,nx,ny;
        const gsl_wavelet_type * T;
        nx=image->get_xsize();
        ny=image->get_ysize();
 
        if (nx != ny && ny!=1) throw ImageDimensionException("Wavelet transform only supports square images");
//      float l=log((float)nx)/log(2.0f);
//      if (l!=floor(l)) throw ImageDimensionException("Wavelet transform size must be power of 2");
        if( !Util::IsPower2(nx) )  throw ImageDimensionException("Wavelet transform size must be power of 2");
 
        // Unfortunately GSL works only on double() arrays
        // eventually we should put our own wavelet code in here
        // but this will work for now
        double *cpy = (double *)malloc(nx*ny*sizeof(double));
 
        for (i=0; i<nx*ny; i++) cpy[i]=image->get_value_at(i,0,0);
 
        string tp = (const char*)params["type"];
        if (tp=="daub") T=gsl_wavelet_daubechies;
        else if (tp=="harr") T=gsl_wavelet_haar;
        else if (tp=="bspl") T=gsl_wavelet_bspline;
        else throw InvalidStringException(tp,"Invalid wavelet name, 'daub', 'harr' or 'bspl'");
 
        int K=(int)params["ord"];
        gsl_wavelet_direction dir;
 
        if ((int)params["dir"]==1) dir=(gsl_wavelet_direction)1;        // defined as 'forward', but name is broken on mac
        else dir=(gsl_wavelet_direction)-1; // backward
 
        gsl_wavelet *w = gsl_wavelet_alloc(T, K);
        gsl_wavelet_workspace *work = gsl_wavelet_workspace_alloc(nx);
 
        if (ny==1) gsl_wavelet_transform (w,cpy, 1, nx, dir, work);
        else gsl_wavelet2d_transform (w, cpy, nx,nx,ny, dir, work);
 
        gsl_wavelet_workspace_free (work);
        gsl_wavelet_free (w);
 
        for (i=0; i<nx*ny; i++) image->set_value_at_fast(i,0,0,static_cast<float>(cpy[i]));
 
        free(cpy);
}

References get_name(), ImageDimensionException, InvalidStringException, EMAN::Util::IsPower2(), LOGERR, and EMAN::Processor::params.

Member Data Documentation

◆ NAME

const string WaveletProcessor::NAME = "basis.wavelet"

static

Definition at line 8987 of file processor.h.

Referenced by get_name().

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_desc()

◆ get_name()

◆ get_param_types()

◆ NEW()

◆ process_inplace()

Member Data Documentation

◆ NAME