libwt  1.0.0
A C++ library for the continous wavelet transform.
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
wt::WaveletTransform Class Reference

Implements a complex, continious wavelet transform (i.e. More...

#include <wavelettransform.hh>

Inheritance diagram for wt::WaveletTransform:
wt::WaveletAnalysis

Public Member Functions

 WaveletTransform (const Wavelet &wavelet, const RVector &scales, bool subSample=false)
 Constructs a wavelet transform from the given wavelet at the specified scales. More...
 
 WaveletTransform (const Wavelet &wavelet, double *scales, int Nscales, bool subSample=false)
 Constructs a wavelet transform from the given wavelet at the specified scales. More...
 
 WaveletTransform (const WaveletAnalysis &other, bool subSample=false)
 Constructor from other wavelet analysis. More...
 
virtual ~WaveletTransform ()
 Destructor. More...
 
template<class iDerived , class oDerived >
void operator() (const Eigen::DenseBase< iDerived > &signal, Eigen::DenseBase< oDerived > &out)
 Performs the wavelet transform on the given signal and stores the result into the given out matrix. More...
 
- Public Member Functions inherited from wt::WaveletAnalysis
 WaveletAnalysis (const WaveletAnalysis &other)
 Copy constructor. More...
 
virtual ~WaveletAnalysis ()
 Destructor. More...
 
size_t nScales () const
 Returns the number of scales of this wavelet transform. More...
 
const RVector & scales () const
 Returns the scales of the wavelet transform. More...
 
void scales (double *outScales, int Nscales) const
 Returns the (the first Nscales) scales of the wavelet transform stored in outScales. More...
 
const Wavelet & wavelet () const
 Returns the wavelet instance of this transform. More...
 

Protected Member Functions

void init_trafo ()
 Actually initializes the transformation. More...
 
- Protected Member Functions inherited from wt::WaveletAnalysis
 WaveletAnalysis (const Wavelet &wavelet, const RVector &scales)
 Hidden constructor from the specified wavelet and scales. More...
 
 WaveletAnalysis (const Wavelet &wavelet, double *scales, int Nscales)
 Hidden constructor from the specified wavelet and scales. More...
 

Protected Attributes

bool _subSample
 If true, the sub-sampling of the input signal is allowed. More...
 
std::vector< Convolution * > _filterBank
 The list of convolution filters applied for the wavelet transform. More...
 
- Protected Attributes inherited from wt::WaveletAnalysis
Wavelet _wavelet
 The (mother-) wavelet to of the transform. More...
 
RVector _scales
 The scales (in samples) of the transform. More...
 

Detailed Description

Implements a complex, continious wavelet transform (i.e.

[2]).

Constructor & Destructor Documentation

WaveletTransform::WaveletTransform ( const Wavelet &  wavelet,
const RVector &  scales,
bool  subSample = false 
)

Constructs a wavelet transform from the given wavelet at the specified scales.

WaveletTransform::WaveletTransform ( const Wavelet &  wavelet,
double *  scales,
int  Nscales,
bool  subSample = false 
)

Constructs a wavelet transform from the given wavelet at the specified scales.

WaveletTransform::WaveletTransform ( const WaveletAnalysis &  other,
bool  subSample = false 
)

Constructor from other wavelet analysis.

WaveletTransform::~WaveletTransform ( )
virtual

Destructor.

Member Function Documentation

void WaveletTransform::init_trafo ( )
protected

Actually initializes the transformation.

template<class iDerived , class oDerived >
void wt::WaveletTransform::operator() ( const Eigen::DenseBase< iDerived > &  signal,
Eigen::DenseBase< oDerived > &  out 
)
inline

Performs the wavelet transform on the given signal and stores the result into the given out matrix.

The wavelet transformed for the j-th scale is stored in the j-th column of the matrix, hence the matrix must have N rows and K colmums where K is the number of scales and N is the number of samples in signal.

Todo:
Parallelize with OpenMP!

Member Data Documentation

std::vector<Convolution *> wt::WaveletTransform::_filterBank
protected

The list of convolution filters applied for the wavelet transform.

bool wt::WaveletTransform::_subSample
protected

If true, the sub-sampling of the input signal is allowed.


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