NI-RFPM API Reference

Table of Contents

NI-RFPM Fetch Single S-Parameter Measurement VI

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

NI-RFPM Fetch Single S-Parameter Measurement VI

Installed With: NI-RFPM

Fetches a single S-parameter measurement result from the last completed measurement.

NI-RFPM Fetch Single S-Parameter Measurement Double

Fetches a single double-precision floating point S-parameter measurement result from the last completed measurement, along with frequency points and port powers.

NI-RFPM Fetch Single S-Parameter Measurement Double

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.

cstr.gif

Stimulus Port specifies the stimulus port, which is the second number of the S-parameter. Stimulus Port uses absolute port numbers.

ci32.gif

format specifies the format in which to fetch the data.

Log Magnitude (dB) NI-RFPM fetches the data in log magnitude format. NI-RFPM log magnitude data is presented in decibels (dB).
Linear Magnitude NI-RFPM fetches the data in linear magnitude format. NI-RFPM linear magnitude data is presented as peak voltage (Vp).
Phase (deg) NI-RFPM fetches the data in phase format. NI-RFPM phase data is presented in degrees of phase shift of the response with respect to the stimulus. Phase data is presented in a wrapped format (+/-180 degree segments).
cstr.gif

Response Port specifies the response port, which is the first number of the S-parameter. Response Port uses absolute port numbers.

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.

cdbl.gif

Timeout specifies the time to wait for the operation to complete before returning an error, expressed in seconds.

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.

i1ddbl.gif

data returns the measurement data as a 1-D double array of S-parameter measurements per measurement point in the specified format.

i1ddbl.gif

frequency returns a 1-D double array of frequencies for each measurement point, in Hz.

i1ddbl.gif

powerreturns a 1-D double array of power levels used at the stimulus port for each measurement point, in dBm.

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.

NI-RFPM Fetch Single S-Parameter Measurement Complex

Fetches a single complex double-precision floating point S-parameter measurement result from the last completed measurement, along with frequency points and port powers.

NI-RFPM Fetch Single S-Parameter Measurement Complex

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.

cstr.gif

Stimulus Port specifies the stimulus port, which is the second number of the S-parameter. Stimulus Port uses absolute port numbers.

ci32.gif

format specifies the format in which to fetch the data, which is coefficient.

Coefficient NI-RFPM fetches the data as 1-D IQ complex data array.
cstr.gif

Response Port specifies the response port, which is the first number of the S-parameter. Response Port uses absolute port numbers.

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.

cdbl.gif

Timeout specifies the time to wait for the operation to complete before returning an error, expressed in seconds.

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.

c1dcdb.gif

data returns the measurement data as a 1-D IQ complex data array.

i1ddbl.gif

frequency returns a 1-D double array of frequencies for each measurement point, in Hz.

i1ddbl.gif

powerreturns a 1-D double array of power levels used at the stimulus port for each measurement point, in dBm.

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