32b/filter_so.h File Reference

Contains the public interface to the second-order filter (FILTER_SO) module routines. More...

#include "sw/modules/types/src/types.h"
#include "sw/modules/iqmath/src/32b/IQmathLib.h"

Go to the source code of this file.

Data Structures
struct	_FILTER_SO_
	Defines the second-order filter (FILTER_SO) object. More...

Typedefs
typedef struct _FILTER_SO_	FILTER_SO_Obj
	Defines the second-order filter (FILTER_SO) object. More...
typedef struct _FILTER_SO_Obj_ *	FILTER_SO_Handle
	Defines the second-order filter (FILTER_SO) handle. More...

Functions
static _iq	FILTER_SO_get_a1 (FILTER_SO_Handle handle)
	Gets the second-order filter denominator coefficient a1. More...
static _iq	FILTER_SO_get_a2 (FILTER_SO_Handle handle)
	Gets the second-order filter denominator coefficient a2. More...
static _iq	FILTER_SO_get_b0 (FILTER_SO_Handle handle)
	Gets the second-order filter numerator coefficient b0. More...
static _iq	FILTER_SO_get_b1 (FILTER_SO_Handle handle)
	Gets the second-order filter numerator coefficient b1. More...
static _iq	FILTER_SO_get_b2 (FILTER_SO_Handle handle)
	Gets the second-order filter numerator coefficient b2. More...
static _iq	FILTER_SO_get_x1 (FILTER_SO_Handle handle)
	Gets the second-order filter input value at time sample n=-1. More...
static _iq	FILTER_SO_get_x2 (FILTER_SO_Handle handle)
	Gets the second-order filter input value at time sample n=-2. More...
static _iq	FILTER_SO_get_y1 (FILTER_SO_Handle handle)
	Gets the second-order filter output value at time sample n=-1. More...
static _iq	FILTER_SO_get_y2 (FILTER_SO_Handle handle)
	Gets the second-order filter output value at time sample n=-2. More...
void	FILTER_SO_getDenCoeffs (FILTER_SO_Handle handle, _iq *pa1, _iq *pa2)
	Gets the second-order filter denominator coefficients. More...
void	FILTER_SO_getInitialConditions (FILTER_SO_Handle handle, _iq *px1, _iq *px2, _iq *py1, _iq *py2)
	Gets the initial conditions of the second-order filter. More...
void	FILTER_SO_getNumCoeffs (FILTER_SO_Handle handle, _iq *pb0, _iq *pb1, _iq *pb2)
	Gets the second-order filter numerator coefficients. More...
FILTER_SO_Handle	FILTER_SO_init (void *pMemory, const size_t numBytes)
	Initializes the second-order filter. More...
static _iq	FILTER_SO_run (FILTER_SO_Handle handle, const _iq inputValue)
	Runs a second-order filter of the form y[n] = b0*x[n] + b1*x[n-1] + b2*x[n-2] - a1*y[n-1] - a2*y[n-2]. More...
static _iq	FILTER_SO_run_form_0 (FILTER_SO_Handle handle, const _iq inputValue)
	Runs a simplified second-order filter of the form y[n] = b0*x[n] - a1*y[n-1] - a2*y[n-2]. More...
static _iq	FILTER_SO_run_form_1 (FILTER_SO_Handle handle, const _iq inputValue)
	Runs a second-order filter of the form y[n] = b0*x[n] + b1*x[n-1] - a1*y[n-1] - a2*y[n-2]. More...
static void	FILTER_SO_set_a1 (FILTER_SO_Handle handle, const _iq a1)
	Sets the second-order filter denominator coefficient a1. More...
static void	FILTER_SO_set_a2 (FILTER_SO_Handle handle, const _iq a2)
	Sets the second-order filter denominator coefficient a2. More...
static void	FILTER_SO_set_b0 (FILTER_SO_Handle handle, const _iq b0)
	Sets the second-order filter numerator coefficient b0. More...
static void	FILTER_SO_set_b1 (FILTER_SO_Handle handle, const _iq b1)
	Sets the second-order filter numerator coefficient b1. More...
static void	FILTER_SO_set_b2 (FILTER_SO_Handle handle, const _iq b2)
	Sets the second-order filter numerator coefficient b2. More...
static void	FILTER_SO_set_x1 (FILTER_SO_Handle handle, const _iq x1)
	Sets the second-order filter input value at time sample n=-1. More...
static void	FILTER_SO_set_x2 (FILTER_SO_Handle handle, const _iq x2)
	Sets the second-order filter input value at time sample n=-2. More...
static void	FILTER_SO_set_y1 (FILTER_SO_Handle handle, const _iq y1)
	Sets the second-order filter output value at time sample n=-1. More...
static void	FILTER_SO_set_y2 (FILTER_SO_Handle handle, const _iq y2)
	Sets the second-order filter output value at time sample n=-2. More...
void	FILTER_SO_setDenCoeffs (FILTER_SO_Handle handle, const _iq a1, const _iq a2)
	Sets the second-order filter denominator coefficients. More...
void	FILTER_SO_setInitialConditions (FILTER_SO_Handle handle, const _iq x1, const _iq x2, const _iq y1, const _iq y2)
	Sets the initial conditions of the second-order filter. More...
void	FILTER_SO_setNumCoeffs (FILTER_SO_Handle handle, const _iq b0, const _iq b1, const _iq b2)
	Sets the second-order filter numerator coefficients. More...

Detailed Description

Contains the public interface to the second-order filter (FILTER_SO) module routines.

(C) Copyright 2012, Texas Instruments, Inc.

Definition in file 32b/filter_so.h.