Classes | Public Member Functions | Friends

ForIA::Wavelet::Coefficient Class Reference

Represents a wavelet coefficient at a particular scale and translation param. More...

#include <Wavelet.hh>

List of all members.

Classes

struct  ByAmplitudeDown
 Used to sort Wavelet coefficients by decreasing amplitude. More...

Public Member Functions

 Coefficient ()
unsigned int scale () const
 The scale parameter of this wavelet coefficient.
double translation () const
double translationMax () const
double translationMin () const
double magnitude () const
unsigned int arrayPosition () const
 The array index (used for making 1-D plots, but interpretation is subtle!)
unsigned int level () const
unsigned int index () const
 The index within the frequency band. This is related to the translation parameter.

Friends

class Wavelet

Detailed Description

Represents a wavelet coefficient at a particular scale and translation param.

Definition at line 27 of file Wavelet.hh.


Constructor & Destructor Documentation

ForIA::Wavelet::Coefficient::Coefficient (  ) [inline]

Definition at line 31 of file Wavelet.hh.


Member Function Documentation

unsigned int ForIA::Wavelet::Coefficient::arrayPosition (  ) const [inline]

The array index (used for making 1-D plots, but interpretation is subtle!)

Definition at line 70 of file Wavelet.hh.

unsigned int ForIA::Wavelet::Coefficient::index (  ) const [inline]

The index within the frequency band. This is related to the translation parameter.

Definition at line 77 of file Wavelet.hh.

unsigned int ForIA::Wavelet::Coefficient::level (  ) const [inline]

The "level" of the frequency band to which this coefficient belongs See FrequencyBand

Definition at line 74 of file Wavelet.hh.

double ForIA::Wavelet::Coefficient::magnitude (  ) const [inline]

The amplitude of this wavelet coefficient hmm, need to rename this as it can be negative!

Definition at line 67 of file Wavelet.hh.

unsigned int ForIA::Wavelet::Coefficient::scale (  ) const [inline]

The scale parameter of this wavelet coefficient.

Definition at line 34 of file Wavelet.hh.

double ForIA::Wavelet::Coefficient::translation (  ) const [inline]

The translation parameter of this wavelet coefficient

Note: in the discrete wavelet transform the translation sampling is dependent on the scale. At the smallest scale of 2 there are N/2 points sampled from the translation axis (where N is the length of the input data sequence). At the maximum scale there will only be one sample taken from the translation axis, which ought to correspond to averaging the signal

The value returned here is the centre of the sampled translation region.

Definition at line 47 of file Wavelet.hh.

double ForIA::Wavelet::Coefficient::translationMax (  ) const [inline]

The upper bound of the sampled translation range See note on translation()

Definition at line 57 of file Wavelet.hh.

double ForIA::Wavelet::Coefficient::translationMin (  ) const [inline]

The lower bound of the sampled translation range See note on translation()

Definition at line 61 of file Wavelet.hh.


Friends And Related Function Documentation

friend class Wavelet [friend]

Definition at line 88 of file Wavelet.hh.


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