NI-RFPM API Reference

Table of Contents

NI-RFPM Fetch Source Offset With Settings And Settling Time VI

  • Updated2023-12-28
  • 6 minute(s) read

NI-RFPM Fetch Source Offset With Settings And Settling Time VI

Installed With: NI-RFPM

Fetches the stored source offset and settling time for a single frequency, power, and path setting for a specified port. When the De-embedding Enabled property is set to TRUE and the De-embedding S2P Path property is set to the correct de-embedding files, the power level is defined at the DUT reference plane.

This VI does not support the mmWave subsystem.

NI-RFPM Fetch Source Offset With Settings And Settling Time

cio.gif

instrument handle identifies your instrument session. instrument handle is obtained from the NI-RFPM Init With Resources VI and identifies a particular instrument session.

cu32.gif

Source Path specifies the source path used to fetch the source offset data.

Unspecified (default) NI-RFPM searches across all paths for offset data that matches the requested parameters.
Direct NI-RFPM uses the direct path through the STS device.
Gain NI-RFPM uses the amplified path through the STS device.
Loop NI-RFPM uses the path through the bypass loop of the STS device.
Two Tone NI-RFPM uses the path through the bypass loop of the NI-RFPM Switch but retrieves calibration and settling time data specific to the two-tone generation solution that can optionally be installed in the loop path.
Note  Internal termination is only useful when combined with Loop or Two Tone. If internal termination is used with Direct or Gain, no signal is present out of the STS RF Subsystem.
cdbl.gif

frequency specifies the frequency to fetch the source offset data for. This value is expressed in Hz.

cdbl.gif

power specifies the power to fetch the source offset data for. When the De-embedding Enabled property is set to TRUE and the De-embedding S2P Path property is set to the correct de-embedding files, the power level is defined at the DUT reference plane. This value is expressed in decibels milliwatt (dBm).

ci32.gif

Optimization Method specifies what to optimize for when picking the path to use through RFPM. This only applies if Source Path is set to Unspecified. The default value is Normal.

Normal Look up the NI-RFPM path to use based on the peak power so you can use state freeze to achieve the best absolute amplitude accuracy.
Optimize for Dynamic Range Look up the NI-RFPM path based on average power since this optimizes dynamic range which benefits EVM and other measurements at the cost of maintaining the state freeze and absolute amplitude accuracy.
cstr.gif

Port specifies the port to fetch the source offset for.

cu32.gif

Power Level Type specifies if power and Calibrated Power represent average envelope power or peak envelope power. The default value is Peak.

Calibrated Power represents average waveform power.

Peak Both power and Calibrated Power represent peak waveform power.
Average Both power and Calibrated Power represent average waveform power.
cdbl.gif

PAPR specifies the peak to average envelope power ratio, in decibels, of the generated waveform. The default value is 0. Valid values are 0 to positive infinity.

cdbl.gif

Runtime Scaling specifies the runtime scaling, also called pre-filter gain, in decibels, to use with the generated waveform. The default value is 0. Valid values are negative infinity to 0.

cerrcodeclst.gif

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs. Right-click the error in control on the front panel and select Explain Error or Explain Warning from the shortcut menu for more information about the error.

cbool.gif

The status boolean is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ci32.gif

The code input identifies the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

cstr.gif

The source string describes the origin of the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

iio.gif

instrument handle out passes a reference to your instrument session to the next VI. instrument handle out is obtained from the NI-RFPM Init With Resources VI and identifies a particular instrument session.

idbl.gif

Source Offset returns the source offset for the specified settings. This value is expressed as loss in decibels. The source offset corresponds to the loss of the path between the VST generator and the DUT reference plane, taking into account de-embedding when enabled.

istr.gif

Switch Path String returns the path of the STS device that the offset applies to.

idbl.gif

Calibrated Power specifies the calibrated power level of the NI-RFPM source port in dBm. When NI-RFPM de-embedding is enabled, the power level is defined at the DUT reference plane.

idbl.gif

Settling Time returns the time, in seconds, required for the signal at the specified NI-RFPM Switch source path output channel to settle within the specified source amplitude settling.

idbl.gif

Digital Gain returns temperature corrected digital gain, in decibels.

Digital gain represents the difference between the calibrated power and user-requested power, with automatic adjustments for temperature. Use this value to adjust the output power of the NI-RFPM device while keeping the analog path fixed, for example, at the calibrated power level. Refer to the NI-RFSA Digital Gain (dB) property for more details.

ierrcodeclst.gif

The error out cluster passes error or warning information out of a VI to be used by other VIs. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

ibool.gif

The status boolean is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ii32.gif

The code output identifies the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

istr.gif

The source string describes the origin of the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

Log in to get a better experience