XCORE SDK
XCORE Software Development Kit
Public Attributes | List of all members
dcoe_chan_state_t Struct Reference

DC Offset Elimination (DCOE) State. More...

#include <dc_elimination.h>

Public Attributes

int64_t prev_y
 

Detailed Description

DC Offset Elimination (DCOE) State.

This is the required state information for a single channel to which the DC offset elimination filter is to be applied.

To apply the DC offset elimination filter to multiple channels simultaneously, an array of dcoe_chan_state_t should be used.

dcoe_state_init() is used once to initialize an array of state objects, and dcoe_filter() is used on each consecutive sample to apply the filter and get the resulting output sample.

DC offset elimination is an IIR filter. The state must persist between time steps.

Use in lib_mic_array

Typical users of lib_mic_array will not need to directly use this type or any functions which take it as a parameter.

The C++ class template mic_array::DcoeSampleFilter, if used in an application's mic array unit, will allocate, initialize and apply the DCOE filter automatically.

With MicArray Prefabs

The MicArray prefab mic_array::prefab::BasicMicArray has a bool template parameter USE_DCOE which indicates whether the mic_array::DcoeSampleFilter should be used. If true, DCOE will be enabled.

For more information about MicArray prefabs, see [../../getting_started.html].

With Vanilla API

When using the 'vanilla' API, DCOE is enabled by default. To disable DCOE when using this API, add a preprocessor definition to the compiler flags, setting MIC_ARRAY_CONFIG_USE_DC_ELIMINATION to 0.

For more information about the vanilla API, see [../../vanilla_api.html].

Member Data Documentation

◆ prev_y

int64_t dcoe_chan_state_t::prev_y

Previous output sample value.


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