MotorWare f2806x Module API Documentation
Data Structures | Typedefs | Functions
32b/filter_fo.h File Reference

Contains the public interface to the first-order filter (FILTER_FO) 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_FO_
 Defines the first-order filter (FILTER_FO) object. More...
 

Typedefs

typedef struct _FILTER_FO_ FILTER_FO_Obj
 Defines the first-order filter (FILTER_FO) object. More...
 
typedef struct _FILTER_FO_Obj_FILTER_FO_Handle
 Defines the first-order filter (FILTER_FO) handle. More...
 

Functions

static _iq FILTER_FO_get_a1 (FILTER_FO_Handle handle)
 Gets the first-order filter denominator coefficient a1. More...
 
static _iq FILTER_FO_get_b0 (FILTER_FO_Handle handle)
 Gets the first-order filter numerator coefficient b0. More...
 
static _iq FILTER_FO_get_b1 (FILTER_FO_Handle handle)
 Gets the first-order filter numerator coefficient b1. More...
 
static _iq FILTER_FO_get_x1 (FILTER_FO_Handle handle)
 Gets the first-order filter input value at time sample n=-1. More...
 
static _iq FILTER_FO_get_y1 (FILTER_FO_Handle handle)
 Gets the first-order filter output value at time sample n=-1. More...
 
void FILTER_FO_getDenCoeffs (FILTER_FO_Handle handle, _iq *pa1)
 Gets the first-order filter denominator coefficients. More...
 
void FILTER_FO_getInitialConditions (FILTER_FO_Handle handle, _iq *px1, _iq *py1)
 Gets the initial conditions of the first-order filter. More...
 
void FILTER_FO_getNumCoeffs (FILTER_FO_Handle handle, _iq *pb0, _iq *pb1)
 Gets the first-order filter numerator coefficients. More...
 
FILTER_FO_Handle FILTER_FO_init (void *pMemory, const size_t numBytes)
 Initializes the first-order filter. More...
 
static _iq FILTER_FO_run (FILTER_FO_Handle handle, const _iq inputValue)
 Runs a first-order filter of the form y[n] = b0*x[n] + b1*x[n-1] - a1*y[n-1]. More...
 
static _iq FILTER_FO_run_form_0 (FILTER_FO_Handle handle, const _iq inputValue)
 Runs a first-order filter of the form y[n] = b0*x[n] - a1*y[n-1]. More...
 
static void FILTER_FO_set_a1 (FILTER_FO_Handle handle, const _iq a1)
 Sets the first-order filter denominator coefficient a1. More...
 
static void FILTER_FO_set_b0 (FILTER_FO_Handle handle, const _iq b0)
 Sets the first-order filter numerator coefficient b0. More...
 
static void FILTER_FO_set_b1 (FILTER_FO_Handle handle, const _iq b1)
 Sets the first-order filter numerator coefficient b1. More...
 
static void FILTER_FO_set_x1 (FILTER_FO_Handle handle, const _iq x1)
 Sets the first-order filter input value at time sample n=-1. More...
 
static void FILTER_FO_set_y1 (FILTER_FO_Handle handle, const _iq y1)
 Sets the first-order filter output value at time sample n=-1. More...
 
void FILTER_FO_setDenCoeffs (FILTER_FO_Handle handle, const _iq a1)
 Sets the first-order filter denominator coefficients. More...
 
void FILTER_FO_setInitialConditions (FILTER_FO_Handle handle, const _iq x1, const _iq y1)
 Sets the initial conditions of the first-order filter. More...
 
void FILTER_FO_setNumCoeffs (FILTER_FO_Handle handle, const _iq b0, const _iq b1)
 Sets the first-order filter numerator coefficients. More...
 

Detailed Description

Contains the public interface to the first-order filter (FILTER_FO) module routines.

(C) Copyright 2012, Texas Instruments, Inc.

Definition in file 32b/filter_fo.h.