panwave
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
panwave::Wavelet Class Reference

#include <Wavelet.h>

Public Types

enum  WaveletType : uint8_t { Daubechies = 1, Symlet, Coiflet }
 

Public Member Functions

size_t Length () const
 

Static Public Member Functions

static void GetWaveletCoefficients (Wavelet *wavelet, WaveletType type, size_t vanishing_moment)
 
static size_t GetWaveletMinimumP (WaveletType type)
 
static size_t GetWaveletMaximumP (WaveletType type)
 

Public Attributes

std::vector< double > lowpassDecompositionFilter_
 
std::vector< double > highpassDecompositionFilter_
 
std::vector< double > lowpassReconstructionFilter_
 
std::vector< double > highpassReconstructionFilter_
 

Detailed Description

Container for a set of wavelet filters.
Manually fill out the filters or use GetWaveletCoefficients to load well-known wavelet filter values.

See also
GetWaveletCoefficients

Member Function Documentation

◆ GetWaveletCoefficients()

void panwave::Wavelet::GetWaveletCoefficients ( Wavelet wavelet,
WaveletType  type,
size_t  vanishing_moment 
)
static

Load the wavelet filter coefficients for a well-known wavelet.

Parameters
waveletDestination wavelet instance. Filter coefficients will be overwritten with well-known values.
typeWavelet type to load well-knwon values.
vanishing_momentWavelet vanishing_moment value to load well-known values. The vanishing_moment value must be within the supported range. Use GetWaveletMinimumP and GetWaveletMaximumP to find the range.
See also
WaveletType
GetWaveletMinimumP
GetWaveletMaximumP

◆ GetWaveletMaximumP()

size_t panwave::Wavelet::GetWaveletMaximumP ( WaveletType  type)
static

Return the maximum wavelet vanishing_moment value supported for well-known wavelet filter coefficients of a type of wavelet.

Parameters
typeWavelet type to get the maximum vanishing_moment value.
See also
WaveletType
GetWaveletCoefficients

◆ GetWaveletMinimumP()

size_t panwave::Wavelet::GetWaveletMinimumP ( WaveletType  type)
static

Return the minimum wavelet vanishing_moment value supported for well-known wavelet filter coefficients of a type of wavelet.

Parameters
typeWavelet type to get the minimum vanishing_moment value.
See also
WaveletType
GetWaveletCoefficients

◆ Length()

size_t panwave::Wavelet::Length ( ) const

The length of the wavelet. This is equivalent to the length of each wavelet filter. We expect all wavelet filters to be of the same length.


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