panwave
Classes | Public Member Functions | List of all members
panwave::WaveletPacketTreeBase Class Referenceabstract

#include <WaveletPacketTreeBase.h>

Inheritance diagram for panwave::WaveletPacketTreeBase:
Inheritance graph
[legend]

Classes

struct  WaveletPacketTreeNodeData
 

Public Member Functions

 WaveletPacketTreeBase (const WaveletPacketTreeBase &)=delete
 
 WaveletPacketTreeBase (const WaveletPacketTreeBase &&)=delete
 
WaveletPacketTreeBaseoperator= (const WaveletPacketTreeBase &)=delete
 
WaveletPacketTreeBaseoperator= (const WaveletPacketTreeBase &&)=delete
 
virtual void Decompose ()=0
 
virtual void Reconstruct (size_t level)=0
 
virtual void SetRootSignal (const std::vector< double > *signal)=0
 
virtual const std::vector< double > * GetRootSignal ()=0
 
virtual size_t GetWaveletLevelCount () const =0
 

Detailed Description

Base class for all wavelet packet tree specialization types.
This abstract class is an interface to hold methods common to various wavelet packet trees.

Member Function Documentation

◆ Decompose()

virtual void panwave::WaveletPacketTreeBase::Decompose ( )
pure virtual

Perform a wavelet packet tree decomposition.
Starting with the root node, decomposes recursively every node in the tree stopping at the leaf nodes.
This is not a sparse decomposition, all nodes will have decomposed signal data after executing.

See also
SetRootSignal

Implemented in panwave::StationaryWaveletPacketTree, and panwave::WaveletPacketTree.

◆ GetRootSignal()

virtual const std::vector<double>* panwave::WaveletPacketTreeBase::GetRootSignal ( )
pure virtual

◆ GetWaveletLevelCount()

virtual size_t panwave::WaveletPacketTreeBase::GetWaveletLevelCount ( ) const
pure virtual

Get the number of wavelet levels this tree is capable of isolating and reconstructing.

Implemented in panwave::WaveletPacketTreeTemplateBase< k >.

◆ Reconstruct()

virtual void panwave::WaveletPacketTreeBase::Reconstruct ( size_t  level)
pure virtual

Reconstruct an isolated wavelet level.
Beginning at the leaf nodes, recursively reconstruct up all levels of the tree stopping at the root node.
Upon completion, the root signal will contain the reconstructed signal.

Parameters
levelThe wavelet level we should isolate and reconstruct.
See also
GetRootSignal

Implemented in panwave::StationaryWaveletPacketTree, and panwave::WaveletPacketTree.

◆ SetRootSignal()

virtual void panwave::WaveletPacketTreeBase::SetRootSignal ( const std::vector< double > *  signal)
pure virtual

Set the root node signal.
This signal data is used during decomposition to construct all signal values in the tree.

Parameters
signalValues from signal are copied into the root node.
See also
Decompose

Implemented in panwave::WaveletPacketTreeTemplateBase< k >, panwave::WaveletPacketTreeTemplateBase< 2 >, and panwave::WaveletPacketTreeTemplateBase< 4 >.


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