XCORE SDK
XCORE Software Development Kit
|
DC Offset Elimination (DCOE) State. More...
#include <dc_elimination.h>
Public Attributes | |
int64_t | prev_y |
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.
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.
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].
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].
int64_t dcoe_chan_state_t::prev_y |
Previous output sample value.