rfsa c api reference

niRFSA_SelfCalibrateRange

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

niRFSA_SelfCalibrateRange

ViStatus niRFSA_SelfCalibrateRange (ViSession Instrument_Handle,ViInt64 Steps_To_Omit, ViReal64 Min_Frequency, ViReal64 Max_Frequency, ViReal64 Min_Reference_Level, ViReal64 Max_Reference_Level);

Purpose

Self-calibrates all configurations within the specified frequency and reference level limits.

Self-calibration range data is valid until you restart the system or call the niRFSA_ClearSelfCalibrateRange function.

NI recommends that no external signals are present on the RF In port while the calibration is taking place.

Note Note  This function does not update self-calibration date and temperature.

For best results, NI recommends that you perform a complete self-calibration without omitting any steps. However, if certain aspects of performance are less important for your application, you can omit that step for faster execution.

Note Note  If there is an existing NI-RFSG session open for the same PXIe-5820/5830/5831/5832/5840/5841/5842 while this function runs, it may remain open but cannot be used for operations that access the hardware, for example niRFSG_Commit or niRFSG_Initiate.
Note Note  If there is an existing NI-RFSG session open for the same PXIe-5644/5645/5646, it may remain open but cannot be used while this function runs.

Supported Devices: PXIe-5644/5645/5646, 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.
stepsToOmit ViInt64 Specifies which calibration steps to skip as part of the self-calibration process. A value of 0 specifies all supported calibration steps are performed.
Note Note  To omit two or more calibration steps, specify a bitwise-OR combination of the following constants. For example, if you wanted to omit NIRFSA_VAL_SELF_CAL_AMPLITUDE_ACCURACY and NIRFSA_VAL_SELF_CAL_LO_SELF_CAL, you would pass the following string to the niRFSA_SelfCalibrate function: NIRFSA_VAL_SELF_CAL_AMPLITUDE_ACCURACY | NIRFSA_VAL_SELF_CAL_LO_SELF_CAL
NIRFSA_VAL_SELF_CAL_OMIT_NONE No step is omitted during self-calibration.
NIRFSA_VAL_SELF_CAL_PRESELECTOR_ALIGNMENT Not used by this function.
NIRFSA_VAL_SELF_CAL_GAIN_REFERENCE Not used by this function.
NIRFSA_VAL_SELF_CAL_IF_FLATNESS Not used by this function.
NIRFSA_VAL_SELF_CAL_DIGITIZER_SELF_CAL Not used by this function.
NIRFSA_VAL_SELF_CAL_LO_SELF_CAL Omits the Local Oscillator (LO) Self Cal step. If you omit this step and the niRFSA_IsSelfCalValid function indicates the calibration data for this step is invalid, the LO phase-locked loop (PLL) may fail to lock.
NIRFSA_VAL_SELF_CAL_AMPLITUDE_ACCURACY Omits the Amplitude Accuracy step. If you omit this step, the absolute accuracy of the device is not adjusted.
NIRFSA_VAL_SELF_CAL_RESIDUAL_LO_POWER Omits the Residual LO Power step. If you omit this step, the Residual LO Power performance is not adjusted.
NIRFSA_VAL_SELF_CAL_IMAGE_SUPPRESSION Omits the Image Suppression step. If you omit this step, the Residual Sideband Image Performance is not adjusted.
NIRFSA_VAL_SELF_CAL_SYNTHESIZER_ALIGNMENT Omits the Synthesizer Alignment step. If you omit this step, the LO PLL is not adjusted. This step is not valid for the PXIe-5820.
NIRFSA_VAL_SELF_CAL_DC_OFFSET Omits the DC Offset step. This step applies only to the PXIe-5820.
minFrequency ViReal64 Specifies the minimum RF frequency in Hz.
maxFrequency ViReal64 Specifies the maximum RF frequency in Hz.
minReferenceLevel ViReal64 Specifies the minimum reference level in dBm.
maxReferenceLevel ViReal64 Specifies the maximum reference level in dBm.

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