niFgen_CalAdjustFlatness
- Updated2023-02-21
- 2 minute(s) read
ViStatus niFgen_CalAdjustFlatness (ViSession vi, ViConstString channelName, ViInt32 configuration, ViReal64 requestedAmplitude, ViReal64[] frequencies, ViReal64[] measuredAmplitudes, ViInt32 numberOfMeasurements);
Purpose
During external calibration, the device is configured with the different analog settings. Measurements are taken of the resulting output voltage across different frequencies. The configuration data, as well as the measurements, are passed to this function so that NI-FGEN can calculate the appropriate calibration constants and, when the calibration session is committed, store them in the onboard EEPROM.
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. vi is obtained from the niFgen_InitExtCal function and identifies a particular instrument session. |
| channelName | ViConstString | Specifies the name of the channel being calibrated.
Default Value: "0" |
| configuration | ViInt32 | Specifies the analog path configuration of the device for this stage of calibration. Refer to the calibration procedure for your device for information on which configurations must be calibrated. |
| requestedAmplitude | ViReal64 | Specifies the amplitude, in volts, that was used to configure NI-FGEN to generate the sine tones at different frequencies. |
| frequencies | ViReal64[] | Specifies the frequencies of the output waveform in hertz. |
| measuredAmplitudes | ViReal64[] | Specifies the actual (measured) amplitudes of the output waveform in volts. |
| numberofMeasurements | ViInt32 | Specifies the number of measurements to take. |
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:
|