ni.com is currently undergoing scheduled maintenance.

Some services may be unavailable at this time. Please contact us for help or try again later.

rfsa c api reference

niRFSA_IsSelfCalValid

  • Updated2024-05-08
  • 2 minute(s) read

niRFSA_IsSelfCalValid

ViStatus niRFSA_IsSelfCalValid(ViSession instrumentHandle, ViBoolean* selfCalValid, ViInt64* validSteps);

Purpose

Indicates which calibration steps contain valid calibration data. To omit steps with valid calibration data from self-calibration, you can pass the validSteps parameter to the stepsToOmit parameter of the niRFSA_SelfCalibrate function.

Supported Devices: PXI-5661, PXIe-5663/5663E/5665/5667/5668

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the niRFSA_init or niRFSA_InitWithOptions function.
Output
Name Type Description
selfCalValid ViBoolean* Returns VI_TRUE if all the calibration data is valid and VI_FALSE if any of the calibration data is invalid.
validSteps ViInt64* Returns valid steps.

Note Note  If two or more calibration steps are valid, this parameter returns a bitwise-OR combination of the calibration steps. For example, if both NIRFSA_VAL_SELF_CAL_IF_FLATNESS and NIRFSA_VAL_SELF_CAL_LO_SELF_CAL steps are valid, NI-RFSA returns the following string: NIRFSA_VAL_SELF_CAL_IF_FLATNESS | NIRFSA_VAL_SELF_CAL_LO_SELF_CAL
NIRFSA_VAL_SELF_CAL_GAIN_REFERENCE Indicates the Gain Reference calibration data is valid. This step measures the changes in gain since the last external calibration was run.
NIRFSA_VAL_SELF_CAL_IF_FLATNESS Indicates the IF Flatness calibration data is valid. This step measures the IF response of the entire system for each of the supported IF filters.
NIRFSA_VAL_SELF_CAL_DIGITIZER_SELF_CAL Indicates the Digitizer Self Cal calibration data is valid. This step calls for digitizer self-calibration if the digitizer is associated with the RF downconverter.
NIRFSA_VAL_SELF_CAL_LO_SELF_CAL Indicates the LO Self Cal calibration data is valid. This step calls for LO self-calibration if the LO source module is associated with the RF downconverter.
NIRFSA_VAL_SELF_CAL_PRESELECTOR_ALIGNMENT Indicates the Preselector Alignment calibration data is valid. This step generates coefficients to align the preselector across the frequency range for your device.

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:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Log in to get a better experience