CxWindFIR_Filtering
Advanced Analysis Library Only
AnalysisLibErrType CxWindFIR_Filtering (NIComplexNumber inputArray[], ssize_t numberOfElements, int numberOfCoeffs, int filterType, double samplingFrequency, double lowerCutoff, double upperCutoff, int windowType, double windowParameter, NIComplexNumber outputArray[]);
Purpose
Filters the complex array using the set of windowed FIR filter coefficients.
Parameters
| Input | ||||||||||||||||||||||||||||||||||||||||||||||||||
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
| inputArray | NIComplexNumber [] | Array containing the raw data to filter. | ||||||||||||||||||||||||||||||||||||||||||||||||
| numberOfElements | ssize_t | Number of elements in the input array inputArray. | ||||||||||||||||||||||||||||||||||||||||||||||||
| numberOfCoeffs | int | The total number of FIR filter coefficients. | ||||||||||||||||||||||||||||||||||||||||||||||||
| filterType | int | The type of filter. filterType must be one of the following values:
|
||||||||||||||||||||||||||||||||||||||||||||||||
| samplingFrequency | double | The frequency in Hertz at which you want to sample inputArray. This value must be greater than 0. | ||||||||||||||||||||||||||||||||||||||||||||||||
| lowerCutoff | double | The cutoff frequency for LOWPASS or HIGHPASS filters, or the low cutoff frequency for BANDPASS or BANDSTOP filters, in Hertz. This value must be 0 < lowerCutoff < upperCutoff < 0.5 * samplingFrequency. | ||||||||||||||||||||||||||||||||||||||||||||||||
| upperCutoff | double | The high cutoff frequency for BANDPASS or BANDSTOP filters, in Hertz. This parameter is not referenced if filterType is LOWPASS or HIGHPASS. This value must be 0 < lowerCutoff < upperCutoff < 0.5 * samplingFrequency. | ||||||||||||||||||||||||||||||||||||||||||||||||
| windowType | int | The type of window to apply. windowType must be one of the following values:
|
||||||||||||||||||||||||||||||||||||||||||||||||
| windowParameter | double | The window parameter. This parameter is referenced only if windowType is one of the following values:
|
||||||||||||||||||||||||||||||||||||||||||||||||
| Output | ||||||||||||||||||||||||||||||||||||||||||||||||||
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
| outputArray | NIComplexNumber [] | Filtered data. This array must be at least (numberOfElements + numberOfCoeffs – 1) elements long. | ||||||||||||||||||||||||||||||||||||||||||||||||
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 2012 and later