OpenWareLaboratory
FirFilter Class Reference
Inheritance diagram for FirFilter:
Collaboration diagram for FirFilter:

Public Member Functions

void copyCoefficients (FloatArray newCoefficients)
 Copies coefficient values from an array. More...
 
void copyState (FloatArray newState)
 Copies state values from an array. More...
 
 FirFilter ()
 
 FirFilter (FloatArray cfs, FloatArray ste, size_t bsize)
 
FloatArray getCoefficients ()
 
FloatArray getState ()
 
float process (float input)
 
void process (FloatArray buffer)
 
void process (FloatArray source, FloatArray destination)
 
void processBlock (FloatArray buffer)
 
void processBlock (FloatArray source, FloatArray destination)
 
void setCoefficients (FloatArray newCoefficients)
 Sets coefficients to point to a different set of values. More...
 
void setState (FloatArray newState)
 Sets state to point to a different set of values. More...
 
 ~FirFilter ()
 

Static Public Member Functions

static FirFiltercreate (size_t taps, size_t blocksize)
 
static void destroy (FirFilter *filter)
 

Detailed Description

Definition at line 7 of file FirFilter.h.

Constructor & Destructor Documentation

◆ FirFilter() [1/2]

FirFilter::FirFilter ( )
inline

Definition at line 39 of file FirFilter.h.

Referenced by create().

◆ FirFilter() [2/2]

FirFilter::FirFilter ( FloatArray  cfs,
FloatArray  ste,
size_t  bsize 
)
inline

Definition at line 41 of file FirFilter.h.

References SimpleArray< T >::getData(), and SimpleArray< T >::getSize().

◆ ~FirFilter()

FirFilter::~FirFilter ( )
inline

Definition at line 50 of file FirFilter.h.

Member Function Documentation

◆ copyCoefficients()

void FirFilter::copyCoefficients ( FloatArray  newCoefficients)
inline

Copies coefficient values from an array.

Definition at line 93 of file FirFilter.h.

References ASSERT, SimpleArray< T >::copyFrom(), and SimpleArray< T >::getSize().

◆ copyState()

void FirFilter::copyState ( FloatArray  newState)
inline

Copies state values from an array.

Definition at line 112 of file FirFilter.h.

References ASSERT, SimpleArray< T >::copyFrom(), and SimpleArray< T >::getSize().

◆ create()

static FirFilter* FirFilter::create ( size_t  taps,
size_t  blocksize 
)
inlinestatic

Definition at line 117 of file FirFilter.h.

References FloatArray::clear(), FloatArray::create(), and FirFilter().

◆ destroy()

static void FirFilter::destroy ( FirFilter filter)
inlinestatic

Definition at line 124 of file FirFilter.h.

References FloatArray::destroy().

◆ getCoefficients()

FloatArray FirFilter::getCoefficients ( )
inline

Definition at line 79 of file FirFilter.h.

◆ getState()

FloatArray FirFilter::getState ( )
inline

Definition at line 98 of file FirFilter.h.

◆ process() [1/3]

float FirFilter::process ( float  input)
inlinevirtual

Reimplemented from SignalProcessor.

Definition at line 53 of file FirFilter.h.

Referenced by processBlock().

◆ process() [2/3]

void FirFilter::process ( FloatArray  buffer)
inline

Definition at line 59 of file FirFilter.h.

References ASSERT, SimpleArray< T >::getData(), and SimpleArray< T >::getSize().

◆ process() [3/3]

void FirFilter::process ( FloatArray  source,
FloatArray  destination 
)
inlinevirtual

Reimplemented from SignalProcessor.

Definition at line 64 of file FirFilter.h.

References ASSERT, SimpleArray< T >::getData(), and SimpleArray< T >::getSize().

◆ processBlock() [1/2]

void FirFilter::processBlock ( FloatArray  buffer)
inline

Definition at line 71 of file FirFilter.h.

References process().

◆ processBlock() [2/2]

void FirFilter::processBlock ( FloatArray  source,
FloatArray  destination 
)
inline

Definition at line 75 of file FirFilter.h.

References process().

◆ setCoefficients()

void FirFilter::setCoefficients ( FloatArray  newCoefficients)
inline

Sets coefficients to point to a different set of values.

Definition at line 86 of file FirFilter.h.

◆ setState()

void FirFilter::setState ( FloatArray  newState)
inline

Sets state to point to a different set of values.

Definition at line 105 of file FirFilter.h.


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