IIRCascadeFiltering
Advanced Analysis Library Only
AnalysisLibErrType IIRCascadeFiltering (double xArray[], ssize_t numberOfElements, IIRFilterPtr filterInformation, double yArray[]);
Purpose
Filters the input sequence using the cascade IIR filter specified by the filterInformation structure. Each of the IIR cascaded stages is second order for lowpass and highpass filters, and fourth order for bandpass and bandstop filters.
filterInformation is the pointer to the filter structure that contains the filter coefficients and the internal filter information. You must allocate this structure by calling AllocIIRFilterPtr and then calling one of the cascade IIR design functions before you call IIRCascadeFiltering.
The filterInformation structure contains the internal filter state information for the filtering operation so you can call IIRCascadeFiltering in a loop to continually filter new input array data and produce new output filtered data.
If you finish filtering one set of input data and want to filter a completely new data set, call ResetIIRFilter before you call IIRCascadeFiltering with the new data. ResetIIRFilter causes the internal filter state information to clear before the next filtering operation.
Parameters
| Input | ||
| Name | Type | Description |
| xArray | double [] | Array that contains the raw data to filter. |
| numberOfElements | ssize_t | The number of points in both the input and output arrays. |
| filterInformation | IIRFilterPtr | Pointer to the filter structure that contains the filter coefficients and the internal filter information. You must allocate this structure by calling AllocIIRFilterPtr and then calling one of the cascade IIR design functions before calling this function. |
| Output | ||
| Name | Type | Description |
| yArray | double [] | Array that contains the output of the IIR filtering operation. The size of this array must be at least numberOfElements. |
Return Value
| Name | Type | Description |
| status | AnalysisLibErrType | A value that specifies the type of error that occurred. Refer to analysis.h for definitions of these constants. |
Additional Information
Library: Advanced Analysis Library
Include file: analysis.h
LabWindows/CVI compatibility: LabWindows/CVI 4.0 and later
Examples
Refer to the following examples that use the IIRCascadeFiltering function:
- analysis\iirfiltr.cws
Open example - analysis\transmit.cws
Open example