newwave is hosted by Hepforge, IPPP Durham

New Wave - Noise Elimination With Wavelets At Vast Energies  0.1.0
NewWave::WaveletEngine Class Reference

Abstract interface defining methods to perform a wavelet transform. More...

#include <WaveletEngine.hh>

Inheritance diagram for NewWave::WaveletEngine:
NewWave::GSLEngine

List of all members.

Public Member Functions

virtual ~WaveletEngine ()
virtual WaveletCoefficients transform (const PixelArray &pixels) const =0
 Perform the wavelet transformation on a 2-D array of pixels.
virtual PixelArray inverseTransform (const WaveletCoefficients &coefficients) const =0
 Perform the inverse wavelet transformation on a list of coefficients.

Detailed Description

Abstract interface defining methods to perform a wavelet transform.

This interface defines methods that will perform the wavelet transform on a sequence of numbers in the PixelArray. Concrete implementations of this class can use e.g. GSL to perform the actual transform

Definition at line 15 of file WaveletEngine.hh.


Constructor & Destructor Documentation

virtual NewWave::WaveletEngine::~WaveletEngine ( ) [inline, virtual]

Definition at line 19 of file WaveletEngine.hh.


Member Function Documentation

virtual PixelArray NewWave::WaveletEngine::inverseTransform ( const WaveletCoefficients &  coefficients) const [pure virtual]

Perform the inverse wavelet transformation on a list of coefficients.

The inverse wavelet transform takes a list of coefficients and returns an array of pixel values in rapidity- $\phi$ space

Parameters:
coefficientsThe WaveletCoefficients to transform
Returns:
a PixelArray in rapidity- $\phi$ space

Implemented in NewWave::GSLEngine.

virtual WaveletCoefficients NewWave::WaveletEngine::transform ( const PixelArray pixels) const [pure virtual]

Perform the wavelet transformation on a 2-D array of pixels.

Parameters:
pixelsThe 2-D array of pixels
Returns:
A list WaveletCoefficients. No guarantee is made as to their order

Implemented in NewWave::GSLEngine.


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