niRFSA_GetScalingCoefficients
- Updated2024-05-08
- 2 minute(s) read
niRFSA_GetScalingCoefficients
ViStatus niRFSA_GetScalingCoefficients(ViSession vi, ViConstString channelList, ViInt32 arraySize, struct niRFSA_coefficientInfo coefficientInfo[], ViInt32* numberOfCoefficientSets);
Purpose
Returns coefficients you can use to convert unscaled data to scaled I/Q data.
Acquired data may be unscaled when sent by a peer-to-peer stream or fetched as unscaled data. Use this function to obtain niRFSA_coefficientInfo structures in the coefficientInfo array that provide gain and offset values you can use to scale this data into the actual I/Q values. The coefficientInfo array returns one element for each channel specified in the channelList parameter. The element order matches the order specified by the channelList parameter. To get the actual I/Q values, scale the unscaled data from an acquisition by multiplying it by the gain value of the appropriate coefficientInfo element then adding the offset from the same element.
 |
Note The coefficients are calculated by NI-RFSA for the current configuration of the device, so they are only valid for acquisitions obtained with the same device configuration. |
To get the required size of the array, call this function with arraySize set to 0 and NULL for the coefficientInfo array. This function returns the required size in the numberOfCoefficientSets parameter.
Supported Devices: PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. vi is obtained from the niRFSA_init or niRFSA_InitWithOptions function. |
| channelList | ViConstString | Identifies which channels to apply settings. Specify an empty string as the value of this parameter. |
| arraySize | ViInt32 | Specifies the size of the array you specify for the coefficientInfo parameter. |
| Output | ||
| Name | Type | Description |
| coefficientInfo | niRFSA_coefficientInfo[] | Specifies the array for storing the coefficient info.
|
| numberOfCoefficientSets | ViInt32* | Returns the number of valid coefficient sets. |
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. Examine the status code from each call to an NI-RFSA function to determine if an error has occurred. To obtain a text description of the status code and additional information about the error condition, call the niRFSA_GetError function. To clear the error information from NI-RFSA, call the niRFSA_ClearError function. The general meaning of the status code is as follows:
|
||||||||