RFmxInstr_SelfCalibrateRange
- Updated2025-10-13
- 3 minute(s) read
Self-calibrates all configurations within the specified frequency and reference level limits. If there is an open session for NI-RFSG for your device, it may remain open but cannot be used while this function runs. NI recommends that no external signals are present on the RF In port while the calibration is taking place. For more information about Self Calibrate Range, refer to the niRFSA Self Calibrate Range function topic for your device in the NI RF Vector Signal Analyzers Help. On a MIMO session, this function self-calibrates all NI-RFSA devices and associated modules that support self-calibration.
Syntax
int32 __stdcall RFmxInstr_SelfCalibrateRange(niRFmxInstrHandle instrumentHandle, char selectorString[], int32 stepsToOmit, float64 minimumFrequency, float64 maximumFrequency, float64 minimumReferenceLevel, float64 maximumReferenceLevel)
Remarks
This function does not update self-calibration date and temperature. Self-calibration range data is not saved to your device if you restart the system.
Parameters
| Name | Direction | Type | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| instrumentHandle | [in] | niRFmxInstrHandle | This parameter identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function. | ||||||||||||||||||||||
| selectorString | [in] | char[] | Specifies a selector string. Pass an empty string. | ||||||||||||||||||||||
| stepsToOmit | [in] | int32 | This parameter specifies which calibration steps to skip during the self-calibration process. The default value is an empty array, which indicates that all calibration steps are performed. The only valid value for the PXIe-5820/5830/5831/5832/5840/5841/5842 is an empty array.
| ||||||||||||||||||||||
| minimumFrequency | [in] | float64 | This parameter specifies the minimum frequency for the custom self calibration range. This value is expressed in Hz. Note For PXIe-5830/5831/5832, only the applicable ports within the specified frequency range are calibrated. | ||||||||||||||||||||||
| maximumFrequency | [in] | float64 | This parameter specifies the maximum frequency for the custom self calibration range. This value is expressed in Hz. | ||||||||||||||||||||||
| minimumReferenceLevel | [in] | float64 | This parameter specifies the minimum reference level for the custom self calibration range. This value is expressed in dBm. | ||||||||||||||||||||||
| maximumReferenceLevel | [in] | float64 | This parameter specifies the maximum reference level for the custom self calibration range. This value is expressed dBm. |
Returns
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 RFmx 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 RFmxInstr_GetError function.
The general meaning of the status code is as follows:
Value | Meaning |
|---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |