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

Base class of all wavelet object containers. More...

#include <wavelet.hh>

Inheritance diagram for wt::Wavelet:
wt::Container wt::Cauchy wt::Morlet

Public Types

typedef WaveletObj ObjectType
 The object type of the container. More...
 
- Public Types inherited from wt::Container
typedef Object ObjectType
 Specifies the object type being held by the container class. More...
 

Public Member Functions

 Wavelet ()
 Emtpy constructor. More...
 
 Wavelet (WaveletObj *obj)
 Constructs a wavelet (container) with the specified wavelet object. More...
 
 Wavelet (const Wavelet &other)
 Copy constructor (reference counting). More...
 
virtual ~Wavelet ()
 Destructor, will distroy the containing wavelet object if this was the last reference to it. More...
 
Waveletoperator= (const Wavelet &other)
 Assignment operator (reference counting). More...
 
CScalar evalAnalysis (const Scalar &t) const
 Evaluates the (unscaled) analysis wavelet at the specified position. More...
 
CScalar evalSynthesis (const Scalar &t) const
 Evaluates the (unscaled) analysis wavelet at the specified position. More...
 
double cutOffTime () const
 Returns the width of the wavelet in time. More...
 
double cutOffFreq () const
 Returns the width of the wavelet in frequencies. More...
 
- Public Member Functions inherited from wt::Container
 Container ()
 Empty constructor. More...
 
 Container (Object *object)
 Packs the given object in a container. More...
 
 Container (const Container &other)
 Copy constructor. More...
 
virtual ~Container ()
 Destructor. More...
 
Containeroperator= (const Container &other)
 Assignment operator. More...
 
template<class T >
bool is ()
 Returns true if the object held by the container is of type T::ObjectType. More...
 
template<class T >
as ()
 Dynamic container cast. More...
 
bool isNull () const
 Returns true if the container is empty (null). More...
 

Protected Attributes

WaveletObj_wavelet
 Holds a reference to the wavelet object. More...
 
- Protected Attributes inherited from wt::Container
Object_object
 The object being managed. More...
 

Detailed Description

Base class of all wavelet object containers.

This container can hold any wavelet object and provides access to the generic methods of these objects.

Member Typedef Documentation

The object type of the container.

Constructor & Destructor Documentation

Wavelet::Wavelet ( )

Emtpy constructor.

Wavelet::Wavelet ( WaveletObj obj)

Constructs a wavelet (container) with the specified wavelet object.

Wavelet::Wavelet ( const Wavelet other)

Copy constructor (reference counting).

Wavelet::~Wavelet ( )
virtual

Destructor, will distroy the containing wavelet object if this was the last reference to it.

Member Function Documentation

double wt::Wavelet::cutOffFreq ( ) const
inline

Returns the width of the wavelet in frequencies.

double wt::Wavelet::cutOffTime ( ) const
inline

Returns the width of the wavelet in time.

CScalar wt::Wavelet::evalAnalysis ( const Scalar &  t) const
inline

Evaluates the (unscaled) analysis wavelet at the specified position.

CScalar wt::Wavelet::evalSynthesis ( const Scalar &  t) const
inline

Evaluates the (unscaled) analysis wavelet at the specified position.

Wavelet & Wavelet::operator= ( const Wavelet other)

Assignment operator (reference counting).

Member Data Documentation

WaveletObj* wt::Wavelet::_wavelet
protected

Holds a reference to the wavelet object.


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