dsp::WindowingFunction< FloatType > Struct Template Reference

A class which provides multiple windowing functions useful for filter design and spectrum analyzers. More...

Public Types

enum  WindowingMethod {
  rectangular = 0, triangular, hann, hamming,
  blackman, blackmanHarris, flatTop, kaiser,
  numWindowingMethods
}
 

Public Member Functions

 WindowingFunction (size_t size, WindowingMethod, bool normalize=true, FloatType beta=0)
 
void fillWindowingTables (size_t size, WindowingMethod type, bool normalize=true, FloatType beta=0) noexcept
 Fills the content of an array with a given windowing method table. More...
 
void multiplyWithWindowingTable (FloatType *samples, size_t size) noexcept
 Multiply the content of a buffer with the given window. More...
 

Static Public Member Functions

static void fillWindowingTables (FloatType *samples, size_t size, WindowingMethod, bool normalize=true, FloatType beta=0) noexcept
 Fills the content of an array with a given windowing method table. More...
 
static const char * getWindowingMethodName (WindowingMethod) noexcept
 Returns the name of a given windowing method. More...
 

Detailed Description

template<typename FloatType>
struct dsp::WindowingFunction< FloatType >

A class which provides multiple windowing functions useful for filter design and spectrum analyzers.

Member Enumeration Documentation

◆ WindowingMethod

template<typename FloatType >
enum dsp::WindowingFunction::WindowingMethod
Enumerator
rectangular 
triangular 
hann 
hamming 
blackman 
blackmanHarris 
flatTop 
kaiser 
numWindowingMethods 

Constructor & Destructor Documentation

◆ WindowingFunction()

template<typename FloatType >
dsp::WindowingFunction< FloatType >::WindowingFunction ( size_t  size,
WindowingMethod  ,
bool  normalize = true,
FloatType  beta = 0 
)

Member Function Documentation

◆ fillWindowingTables() [1/2]

template<typename FloatType >
void dsp::WindowingFunction< FloatType >::fillWindowingTables ( size_t  size,
WindowingMethod  type,
bool  normalize = true,
FloatType  beta = 0 
)
noexcept

Fills the content of an array with a given windowing method table.

◆ fillWindowingTables() [2/2]

template<typename FloatType >
static void dsp::WindowingFunction< FloatType >::fillWindowingTables ( FloatType *  samples,
size_t  size,
WindowingMethod  ,
bool  normalize = true,
FloatType  beta = 0 
)
staticnoexcept

Fills the content of an array with a given windowing method table.

◆ multiplyWithWindowingTable()

template<typename FloatType >
void dsp::WindowingFunction< FloatType >::multiplyWithWindowingTable ( FloatType *  samples,
size_t  size 
)
noexcept

Multiply the content of a buffer with the given window.

◆ getWindowingMethodName()

template<typename FloatType >
static const char* dsp::WindowingFunction< FloatType >::getWindowingMethodName ( WindowingMethod  )
staticnoexcept

Returns the name of a given windowing method.


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