WavesResults

Provides methods to fetch and read the Waves measurement results.

class nirfmxvna.waves_results.WavesResults(signal_obj)

Bases: object

Provides methods to fetch and read the Waves measurement results.

fetch_x_data(selector_string, timeout)

Fetches an array of frequency values when you perform wave measurement with SWEEP_TYPE attribute set to List or Linear or Segment. It fetches an array of time values when you perform wave measurement with SWEEP_TYPE attribute set to CW Time.

Parameters:

• selector_string (string) –

  This parameter specifies a selector string comprising of result name.

  Example:

  ””

  ”result::r1”

• timeout (float) – This parameter specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement.A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

x (float):

This parameter returns X-Axis Data.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (x, error_code)

fetch_y_data(selector_string, timeout)

Fetches the wave data for all WAVES_FORMAT types.

Use “wave<n>” as the selector string to read results from this method.

For different WAVES_FORMAT, the data is returned as follows:

Waves Format	Y1	Y2
Magnitude (0)	Magnitude of the wave data	Empty array
Phase (1)	Phase of the wave data	Empty array
Complex (2)	Real part of the complex wave data	Imaginary part of the complex wave data
SWR (3)	Standing wave ratio computed from the wave data	Empty array
Smith Impedance (4)	Real part of the complex impedance computed from the wave data	Imaginary part of the complex impedance computed from the wave data
Smith Admittance (5)	Real part of the complex admittance computed from the wave data	Imaginary part of the complex admittance computed from the wave data
Polar (6)	Magnitude of the wave data	Phase of the wave data
Group Delay (7)	Group delay computed from the wave data	Empty array

Parameters:

• selector_string (string) –

  This parameter specifies a selector string comprising of result name, and S-Parameter number.

  Example:

  ”sparam0”

  ”result::r1/sparam0”

  You can use the build_s_parameter_string() method to build the selector string.

• timeout (float) – This parameter specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement.A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

y1 (float):

This parameter returns Y1 data array. You can refer to the method description for interpreting Y data based on WAVES_FORMAT type.

y2 (float):

This parameter returns Y2 data array. You can refer to the method description for interpreting Y data based on WAVES_FORMAT type.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (y1, y2, error_code)

get_correction_level(selector_string)

Gets the level of error correction applied to the specified wave measurement.

Use “wave<n>” as the selector string to read this attribute.

Name (value)	Description
Uncorrected	Correction is not applied to the configured wave.
Wave	1-Port correction is applied to the configured Wave.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (string):

Returns the level of error correction applied to the specified wave measurement.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_correction_state(selector_string)

Gets the error correction state of the VNA Waves measurement.

Use “wave<n>” as the selector string to read this attribute.

Name (Value)	Description
None (0)	Error correction is not applied.
Corrected (1)	Error correction is applied without interpolation using the error terms from the calset.
Interpolated (2)	Error correction is applied with error terms for at least one sweep point interpolated from the calset error terms.
Settings Modified (3)	Settings during the measurment differ from those used during calibration.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.WavesCorrectionState):

Returns the error correction state of the VNA Waves measurement.

error_code (int):

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)