Functions

General Description

API functions for Filter 3p3z block.

Each function of the API accepts a pointer to a filter context instance as first parameter. The filter context index is self-contained. No additional local or global static data is needed for filter operation. This makes the implementation reentrant.

Before using the filter, it must be initialized (Filter3p3zInit) and reset (Filter3p3zReset). Further, the filter_3p3z_context_t::config part of the context must be correctly set by the application.

The Filter3p3z is called on each input data sample. It has two inputs in (Q0.15) for setpoint and signal and it returns a pointer to the result value (Q0.23).

Functions
void	Filter3p3zReset (filter_3p3z_context_t *const context)
	3p3z filter reset Resets the internal module context More...
void	Filter3p3zInit (filter_3p3z_context_t *const context)
	3p3z filter init Initializes the 3p3z filter More...
void	Filter3p3z (filter_3p3z_context_t *const context, int16_t const dIn0_0q15, int16_t const dIn1_0q15, int32_t *dOut_0q23)
	3p3z filter Executes the 3p3z filter equation: More...

Function Documentation

Filter3p3zReset()

void Filter3p3zReset

(

filter_3p3z_context_t *const

context

)

3p3z filter reset Resets the internal module context

Parameters

[in]

context

: Pointer to the context structure

Filter3p3zInit()

void Filter3p3zInit

(

filter_3p3z_context_t *const

context

)

3p3z filter init Initializes the 3p3z filter

Parameters

[in]

context

: Pointer to the context structure

Filter3p3z()

void Filter3p3z	(	filter_3p3z_context_t *const	context,
		int16_t const	dIn0_0q15,
		int16_t const	dIn1_0q15,
		int32_t *	dOut_0q23
	)

3p3z filter Executes the 3p3z filter equation:

Parameters

[in]	context	: Pointer to the context structure
[in]	dIn0_0q15	: Normalized setpoint (Q0.15)
[in]	dIn1_0q15	: Normalized signal (Q0.15)
[in]	dOut_0q23	: Pointer to output value (Q0.23)