XCORE SDK
XCORE Software Development Kit
Public Member Functions | Protected Attributes | List of all members
mic_array::DcoeSampleFilter< MIC_COUNT > Class Template Reference

Filter which applies DC Offset Elimination (DCOE). More...

#include <SampleFilter.hpp>

Public Member Functions

void Init ()
 Initialize the filter states. More...
 
void Filter (int32_t sample[MIC_COUNT])
 Apply DCOE filter on samples. More...
 

Protected Attributes

dcoe_chan_state_t state [MIC_COUNT]
 State of DCOE filters.
 

Detailed Description

template<unsigned MIC_COUNT>
class mic_array::DcoeSampleFilter< MIC_COUNT >

Filter which applies DC Offset Elimination (DCOE).

Template Parameters
MIC_COUNTNumber of microphone channels.

Member Function Documentation

◆ Filter()

template<unsigned MIC_COUNT>
void mic_array::DcoeSampleFilter< MIC_COUNT >::Filter ( int32_t  sample[MIC_COUNT])

Apply DCOE filter on samples.

sample is an array of samples to be filtered, and is updated in-place.

The filter states must have been initialized with a call to Init() prior to calling this function.

Parameters
sampleSamples to be filtered. Updated in-place.

◆ Init()

template<unsigned MIC_COUNT>
void mic_array::DcoeSampleFilter< MIC_COUNT >::Init

Initialize the filter states.

The filter states must be initialized prior to calls to Filter().


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