VAPOR3 3.9.4
Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
VAPoR::WaveFiltBase Class Reference

A base class for wavelet family filters. More...

#include <WaveFiltBase.h>

Inheritance diagram for VAPoR::WaveFiltBase:
VAPoR::WaveFiltBior VAPoR::WaveFiltCoif VAPoR::WaveFiltDaub VAPoR::WaveFiltHaar VAPoR::WaveFiltInt

Public Member Functions

 WaveFiltBase ()
 
virtual ~WaveFiltBase ()
 
int GetLength () const
 
const double * GetLowDecomFilCoef () const
 Return scaling (low pass) decompostion filter coefficients.
 
const double * GetLowReconFilCoef () const
 Return scaling (low pass) reconstruction filter coefficients.
 
const double * GetHighDecomFilCoef () const
 Return wavelet (high pass) decompostion filter coefficients.
 
const double * GetHighReconFilCoef () const
 Return wavelet (high pass) decompostion filter coefficients.
 
virtual bool issymmetric () const
 
virtual bool isint () const
 
virtual bool IsNormalized () const
 

Protected Member Functions

void wrev (const double *sigIn, double *sigOut, int sigLength) const
 
void qmf_even (const double *sigIn, double *sigOut, int sigLength) const
 
void qmf_wrev (const double *sigIn, double *sigOut, int sigLength) const
 
void verbatim_copy (const double *sigIn, double *sigOut, int sigLength) const
 

Protected Attributes

int _filterLength
 
double * _lowDecomFilCoef
 
double * _lowReconFilCoef
 
double * _hiDecomFilCoef
 
double * _hiReconFilCoef
 

Static Protected Attributes

static const int MAX_FILTER_SIZE = 32
 

Detailed Description

A base class for wavelet family filters.

Author
John Clyne
Version
$Revision$
Date
$Date$

The WaveFiltBase class is a base class for building classes of wavelet families that can be implemented as FIR filters. A wavelet family class contains scaling and wavelet coefficients that define a particular wavelet. All filters are normalized unless IsNormalized returns false.

Definition at line 21 of file WaveFiltBase.h.

Constructor & Destructor Documentation

◆ WaveFiltBase()

VAPoR::WaveFiltBase::WaveFiltBase ( )

◆ ~WaveFiltBase()

virtual VAPoR::WaveFiltBase::~WaveFiltBase ( )
virtual

Member Function Documentation

◆ GetHighDecomFilCoef()

const double * VAPoR::WaveFiltBase::GetHighDecomFilCoef ( ) const
inline

Return wavelet (high pass) decompostion filter coefficients.

Definition at line 46 of file WaveFiltBase.h.

◆ GetHighReconFilCoef()

const double * VAPoR::WaveFiltBase::GetHighReconFilCoef ( ) const
inline

Return wavelet (high pass) decompostion filter coefficients.

Definition at line 49 of file WaveFiltBase.h.

◆ GetLength()

int VAPoR::WaveFiltBase::GetLength ( ) const
inline

Return the number of coefficients in both the scaling and wavelet FIR filter.

This method returns the number of elements in the arrays returned by the classes filter retrieval methods

Return values
filterlength
See also
GetLowDecomFilCoef(), GetLowReconFilCoef(), GetHighDecomFilCoef() GetHighReconFilCoef()

Definition at line 37 of file WaveFiltBase.h.

◆ GetLowDecomFilCoef()

const double * VAPoR::WaveFiltBase::GetLowDecomFilCoef ( ) const
inline

Return scaling (low pass) decompostion filter coefficients.

Definition at line 40 of file WaveFiltBase.h.

◆ GetLowReconFilCoef()

const double * VAPoR::WaveFiltBase::GetLowReconFilCoef ( ) const
inline

Return scaling (low pass) reconstruction filter coefficients.

Definition at line 43 of file WaveFiltBase.h.

◆ isint()

virtual bool VAPoR::WaveFiltBase::isint ( ) const
inlinevirtual

Returns true if the wavelet is an integer transform

Reimplemented in VAPoR::WaveFiltInt.

Definition at line 57 of file WaveFiltBase.h.

◆ IsNormalized()

virtual bool VAPoR::WaveFiltBase::IsNormalized ( ) const
inlinevirtual

Returns true wavelet transform is normalized

Reimplemented in VAPoR::WaveFiltInt.

Definition at line 61 of file WaveFiltBase.h.

◆ issymmetric()

virtual bool VAPoR::WaveFiltBase::issymmetric ( ) const
inlinevirtual

Returns true if the wavelet is symmetric (or antisymmetric)

Reimplemented in VAPoR::WaveFiltBior, and VAPoR::WaveFiltInt.

Definition at line 53 of file WaveFiltBase.h.

◆ qmf_even()

void VAPoR::WaveFiltBase::qmf_even ( const double *  sigIn,
double *  sigOut,
int  sigLength 
) const
protected

◆ qmf_wrev()

void VAPoR::WaveFiltBase::qmf_wrev ( const double *  sigIn,
double *  sigOut,
int  sigLength 
) const
protected

◆ verbatim_copy()

void VAPoR::WaveFiltBase::verbatim_copy ( const double *  sigIn,
double *  sigOut,
int  sigLength 
) const
protected

◆ wrev()

void VAPoR::WaveFiltBase::wrev ( const double *  sigIn,
double *  sigOut,
int  sigLength 
) const
protected

Member Data Documentation

◆ _filterLength

int VAPoR::WaveFiltBase::_filterLength
protected

Definition at line 65 of file WaveFiltBase.h.

◆ _hiDecomFilCoef

double* VAPoR::WaveFiltBase::_hiDecomFilCoef
protected

Definition at line 68 of file WaveFiltBase.h.

◆ _hiReconFilCoef

double* VAPoR::WaveFiltBase::_hiReconFilCoef
protected

Definition at line 69 of file WaveFiltBase.h.

◆ _lowDecomFilCoef

double* VAPoR::WaveFiltBase::_lowDecomFilCoef
protected

Definition at line 66 of file WaveFiltBase.h.

◆ _lowReconFilCoef

double* VAPoR::WaveFiltBase::_lowReconFilCoef
protected

Definition at line 67 of file WaveFiltBase.h.

◆ MAX_FILTER_SIZE

const int VAPoR::WaveFiltBase::MAX_FILTER_SIZE = 32
staticprotected

Definition at line 64 of file WaveFiltBase.h.


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