niFgen_ConfigureCustomFIRFilterCoefficients
ViStatus niFgen_ConfigureCustomFIRFilterCoefficients (ViSession vi, ViConstString channelName, ViInt32 numberofCoefficients, ViReal64[] coefficientsArray);
Purpose
Sets the FIR filter coefficients used by the NI 5441 onboard signal processing block. The values are coerced to the closest settings achievable by the signal generator.
Refer to FIR Filter for more information about FIR filter coefficients.
 |
Note The signal generator must not be in the Generating state when you call this function. |
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. vi is obtained from the niFgen_init or the niFgen_InitWithOptions functions and identifies a particular instrument session. |
| channelName | ViConstString | Specifies the channel name for which you want to configure the operation mode.
Defined Value: "0" |
| numberofCoefficients | ViInt32 | Specifies the number of coefficients. The NI 5441 requires 95. |
| coefficientsArray | ViReal64[] | Specifies the array of data the onboard signal processor uses for the FIR filter coefficients. For the NI 5441, provide a symmetric array of 95 coefficients to this parameter. The array must have at least as many elements as the value that you specify in the numberOfCoefficients parameter. The coefficients should range between -1.00 and +1.00. |
Return Value
| Name | Type | Description | ||||||||
| Status | ViStatus | Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. You can examine the status code from each call to an NI-FGEN function to determine if an error occurred.
To obtain a text description of the status code, call the niFgen_error_message function. To obtain additional information about the error condition, call the niFgen_GetError function. To clear the error information from NI-FGEN, call the niFgen_ClearError function. The general meaning of the status code is as follows:
|