WavesConfiguration

Provides methods to configure the Waves measurement.

class nirfmxvna.waves_configuration.WavesConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the Waves measurement.

configure_wave(selector_string, wave)[source]

Configures the wave to be measured in format a<receiver port number><source port number> or b<receiver port number><source port number>, where ‘a’ specifies that the receiver is reference receiver and ‘b’ specifies that the receiver is test receiver.

Use “wave<n>” as the selector string to configure this method.

Supported devices: NI PXIe-5633

Parameters:

  • selector_string (string) –

    This parameter specifies a selector string comprising of result name, and wave number. “wave0”

    ”signal::sig1/wave0”

    ”result::r1/wave0”

    ”signal::sig1/result::r1/wave0”

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

  • wave (string) – This parameter specifies the wave to be measured in format a<receiver port number><source port number> or b<receiver port number><source port number>, where ‘a’ specifies that the receiver is reference receiver and ‘b’ specifies that the receiver is test receiver.

Returns:

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

Return type:

int

get_format(selector_string)[source]

Gets the format for wave measurement.

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

Use RFmxVNA Waves Fetch Y Data to fetch the waves.

The default value is Magnitude.

Name (Value)

Description

Magnitude (0)

Sets the format for the selected wave to Magnitude. You can specify Wave Magnitude Units.

Phase (1)

Sets the format of the selected wave to Phase. Phase values are expressed in degrees. Phase can be represented in various, mathematically equivalent ways such as phase wrapped between the range [-180, 180) degrees, or phase can be represented in an unwrapped manner. You can specify the phase representation by configuring Wave Phase Trace Type.

Complex (2)

Sets the format for the selected wave as complex numbers in cartesian co-ordinates.

SWR (3)

Sets the format for the selected wave to Standing Wave Ratio (SWR). SWR is a unitless quantity.

Smith Impedance (4)

Sets the format for the selected wave to Smith Impedance. The measured values of the wave are transformed into impedence values. Impedence values are expressed in ohms. You can use these values to plot on a Smith Chart.

Smith Admittance (5)

Sets the format for the selected wave to Smith Admittance. The measured values of the wave are transformed into admittance values. Admittance values are expressed in siemens. You can use these values to plot on an Inverted Smith Chart.

Polar (6)

Sets the format for the selected wave as complex numbers in polar co-ordinates, where the radial axis (i.e., magnitude of the complex numbers) is always in linear scale and angular axis (phase) is represented in degrees and always wrapped between ±180 deg.

Group Delay (7)

Sets the format of the selected wave to Group Delay. Group delay represents the time it takes for the signal to pass through a device under test. The delay is expressed in seconds. Group delay vs. frequency is derived from phase vs. frequency response. At a given frequency point, group delay is computed by selecting two nearby frequency points and taking the ratio of the phase difference to the frequency separation between them. The frequency separation between the two selected points is called the group delay aperture. You can control the aperture by first configuring Waves Group Delay Aperture Mode and once the mode is selected, you can set the aperture by configuring Waves Group Delay Aperture Points, Waves Group Delay Aperture Percentage or Waves Group Delay Aperture Frequency Span. For example, if the number of aperture points is equal to 3, then group delay at a nth frequency point is computed by selecting the (n-1)th frequency point and (n+1)th frequency point.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.WavesFormat):

Specifies the format for 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_group_delay_aperture_frequency_span(selector_string)[source]

Gets the group delay aperture in terms of the frequency separation between the two frequency points selected for group delay computation for all waves for which WAVES_FORMAT attribute is set to Group Delay and WAVES_GROUP_DELAY_APERTURE_MODE attribute is set to Frequency Span.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 50 MHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the group delay aperture in terms of the frequency separation between the two frequency points selected for group delay computation for all waves for which WAVES_FORMAT attribute is set to Group Delay and WAVES_GROUP_DELAY_APERTURE_MODE attribute is set to Frequency Span.

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_group_delay_aperture_mode(selector_string)[source]

Gets the aperture mode to be used for the computation of group delay for all waves for which WAVES_FORMAT attribute is set to Group Delay.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Points.

Name (Value)

Description

Points (0)

Sets group delay aperture mode to Points. You can specify the aperture in terms of the number of frequency points by configuring Waves Group Delay Aperture Points.

Percentage (1)

Sets group delay aperture mode to Percentage. You can specify the aperture in terms of the frequency separation expressed in percentage by configuring Waves Group Delay Aperture Percentage.

Frequency Span (2)

Sets group delay aperture to Frequency Span. You can specify the aperture in terms of the frequency separation by configuring Waves Group Delay Aperture Frequency Span.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.WavesGroupDelayApertureMode):

Specifies the aperture mode to be used for the computation of group delay for all waves for which WAVES_FORMAT attribute is set to Group Delay.

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_group_delay_aperture_percentage(selector_string)[source]

Gets the group delay aperture in terms of the frequency separation between the two frequency points selected for group delay computation, where separation is expressed as a percentage of the total measurement frequency range for all waves for which WAVES_FORMAT attribute is set to Group Delay and WAVES_GROUP_DELAY_APERTURE_MODE attribute is set to Percentage.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 5 %.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the group delay aperture in terms of the frequency separation between the two frequency points selected for group delay computation, where separation is expressed as a percentage of the total measurement frequency range for all waves for which WAVES_FORMAT attribute is set to Group Delay and WAVES_GROUP_DELAY_APERTURE_MODE attribute is set to Percentage.

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_group_delay_aperture_points(selector_string)[source]

Gets the group delay aperture in terms of the number of frequency points that separates the two frequency points for all waves for which WAVES_FORMAT attribute is set to Group Delay and WAVES_GROUP_DELAY_APERTURE_MODE attribute is set to Points. You must set the value of this attribute between 2 and the total number of frequency points in the measurement frequency range.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 11.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the group delay aperture in terms of the number of frequency points that separates the two frequency points for all waves for which WAVES_FORMAT attribute is set to Group Delay and WAVES_GROUP_DELAY_APERTURE_MODE attribute is set to Points. You must set the value of this attribute between 2 and the total number of frequency points in the measurement frequency range.

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_magnitude_units(selector_string)[source]

Gets the magnitude units for all waves for which WAVES_FORMAT attribute is set to Magnitude.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is dBm.

Name (Value)

Description

dBm (0)

Sets wave magnitude units to dBm.

dBmV (1)

Sets wave magnitude units to dBmV.

dBuV (2)

Sets wave magnitude units to dBuV.

dBmA (3)

Sets wave magnitude units to dBmA.

W (4)

Sets wave magnitude units to watts.

V (5)

Sets wave magnitude units to volts.

A (6)

Sets wave magnitude units to ampere.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.WavesMagnitudeUnits):

Specifies the magnitude units for all waves for which WAVES_FORMAT attribute is set to Magnitude.

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_measurement_enabled(selector_string)[source]

Gets whether to enable the Waves measurement.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is False.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (bool):

Specifies whether to enable the 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)

get_number_of_waves(selector_string)[source]

Gets the number of waves to be measured.

If you increase this attribute value from N to N+K, then existing N Waves are not affected but K new Waves are added. If you reduce number of Waves from N to N-K, then last K Waves are deleted without affecting the remaining N-K Waves. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the number of waves to be measured.

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_phase_trace_type(selector_string)[source]

Gets the phase type for all waves for which WAVES_FORMAT attribute is set to Phase. Phase can be represented in two mathematically equivalent ways viz. phase wrapped between the range [-180, 180) degrees, and phase can be represented in an unwrapped manner.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Wrapped.

Name (Value)

Description

Wrapped (0)

The reported wave phase is wrapped between -180 degress to +180 degrees.

Unwrapped (1)

The reported wave phase is unwrapped.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.WavesPhaseTraceType):

Specifies the phase type for all waves for which WAVES_FORMAT attribute is set to Phase. Phase can be represented in two mathematically equivalent ways viz. phase wrapped between the range [-180, 180) degrees, and phase can be represented in an unwrapped manner.

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_receiver(selector_string)[source]

Gets whether to measure the wave on the reference receiver or the test receiver of the Wave Receiver Port.

Incident and scattered waves are denoted by “a_<receiver port name>_<source port name>” and “b_<receiver port name>_<source port name>” respectively. On a receiver port, the a and b waves are measured using Reference receiver and Test receiver respectively.

For example, to measure “b21”, set this attribute to Test (0), WAVES_RECEIVER_PORT to “port2” and WAVES_SOURCE_PORT to “port1”.

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

The default value is Test.

Name (Value)

Description

Test (0)

Measures the wave on the test receiver.

Reference (1)

Measures the wave on the reference receiver.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.WavesReceiver):

Specifies whether to measure the wave on the reference receiver or the test receiver of the Wave Receiver Port.

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_receiver_port(selector_string)[source]

Gets the receiver port name for wave measurement.

Incident and scattered waves are denoted by “a_<receiver port name>_<source port name>” and “b_<receiver port name>_<source port name>” respectively. On a receiver port, the a and b waves are measured using Reference receiver and Test receiver respectively.

For example, to measure “b21”, set WAVES_RECEIVER to Test (0), set this attribute to “port2” and WAVES_SOURCE_PORT to “port1”.

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

The default value is “port1”.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (string):

Specifies the receiver port name for 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_source_port(selector_string)[source]

Gets the source port name for wave measurement.

Incident and scattered waves are denoted by “a_<receiver port name>_<source port name>” and “b_<receiver port name>_<source port name>” respectively. On a receiver port, the a and b waves are measured using Reference receiver and Test receiver respectively.

For example, to measure “b21”, set WAVES_RECEIVER to Test (0), WAVES_RECEIVER_PORT to “port2” and set this attribute to “port1”.

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

The default value is “port1”.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (string):

Specifies the source port name for 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_wave(selector_string)[source]

Returns the wave being measured in format a(receiver port number)(source port number) or b(receiver port number)(source port number), where “a” specifies that the receiver is reference receiver and “b” specifies that the receiver is test receiver.

Use “wave(n)” as the selector string for this method.

Supported devices: NI PXIe-5633

Parameters:

selector_string (string) –

This parameter specifies a selector string comprising of result name, and wave number. "wave0"

"signal::sig1/wave0"

"result::r1/wave0"

"signal::sig1/result::r1/wave0"

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

Returns:

wave (string):

This parameter returns the wave being measured in format a<receiver port number><source port number> or b<receiver port number><source port number>, where “a” specifies that the receiver is reference receiver and “b” specifies that the receiver is test receiver.

error_code (int):

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

Return type:

Tuple (wave, error_code)

set_format(selector_string, value)[source]

Sets the format for wave measurement.

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

Use RFmxVNA Waves Fetch Y Data to fetch the waves.

The default value is Magnitude.

Name (Value)

Description

Magnitude (0)

Sets the format for the selected wave to Magnitude. You can specify Wave Magnitude Units.

Phase (1)

Sets the format of the selected wave to Phase. Phase values are expressed in degrees. Phase can be represented in various, mathematically equivalent ways such as phase wrapped between the range [-180, 180) degrees, or phase can be represented in an unwrapped manner. You can specify the phase representation by configuring Wave Phase Trace Type.

Complex (2)

Sets the format for the selected wave as complex numbers in cartesian co-ordinates.

SWR (3)

Sets the format for the selected wave to Standing Wave Ratio (SWR). SWR is a unitless quantity.

Smith Impedance (4)

Sets the format for the selected wave to Smith Impedance. The measured values of the wave are transformed into impedence values. Impedence values are expressed in ohms. You can use these values to plot on a Smith Chart.

Smith Admittance (5)

Sets the format for the selected wave to Smith Admittance. The measured values of the wave are transformed into admittance values. Admittance values are expressed in siemens. You can use these values to plot on an Inverted Smith Chart.

Polar (6)

Sets the format for the selected wave as complex numbers in polar co-ordinates, where the radial axis (i.e., magnitude of the complex numbers) is always in linear scale and angular axis (phase) is represented in degrees and always wrapped between ±180 deg.

Group Delay (7)

Sets the format of the selected wave to Group Delay. Group delay represents the time it takes for the signal to pass through a device under test. The delay is expressed in seconds. Group delay vs. frequency is derived from phase vs. frequency response. At a given frequency point, group delay is computed by selecting two nearby frequency points and taking the ratio of the phase difference to the frequency separation between them. The frequency separation between the two selected points is called the group delay aperture. You can control the aperture by first configuring Waves Group Delay Aperture Mode and once the mode is selected, you can set the aperture by configuring Waves Group Delay Aperture Points, Waves Group Delay Aperture Percentage or Waves Group Delay Aperture Frequency Span. For example, if the number of aperture points is equal to 3, then group delay at a nth frequency point is computed by selecting the (n-1)th frequency point and (n+1)th frequency point.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.WavesFormat, int) – Specifies the format for wave measurement.

Returns:

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

Return type:

int

set_group_delay_aperture_frequency_span(selector_string, value)[source]

Sets the group delay aperture in terms of the frequency separation between the two frequency points selected for group delay computation for all waves for which WAVES_FORMAT attribute is set to Group Delay and WAVES_GROUP_DELAY_APERTURE_MODE attribute is set to Frequency Span.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 50 MHz.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the group delay aperture in terms of the frequency separation between the two frequency points selected for group delay computation for all waves for which WAVES_FORMAT attribute is set to Group Delay and WAVES_GROUP_DELAY_APERTURE_MODE attribute is set to Frequency Span.

Returns:

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

Return type:

int

set_group_delay_aperture_mode(selector_string, value)[source]

Sets the aperture mode to be used for the computation of group delay for all waves for which WAVES_FORMAT attribute is set to Group Delay.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Points.

Name (Value)

Description

Points (0)

Sets group delay aperture mode to Points. You can specify the aperture in terms of the number of frequency points by configuring Waves Group Delay Aperture Points.

Percentage (1)

Sets group delay aperture mode to Percentage. You can specify the aperture in terms of the frequency separation expressed in percentage by configuring Waves Group Delay Aperture Percentage.

Frequency Span (2)

Sets group delay aperture to Frequency Span. You can specify the aperture in terms of the frequency separation by configuring Waves Group Delay Aperture Frequency Span.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.WavesGroupDelayApertureMode, int) – Specifies the aperture mode to be used for the computation of group delay for all waves for which WAVES_FORMAT attribute is set to Group Delay.

Returns:

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

Return type:

int

set_group_delay_aperture_percentage(selector_string, value)[source]

Sets the group delay aperture in terms of the frequency separation between the two frequency points selected for group delay computation, where separation is expressed as a percentage of the total measurement frequency range for all waves for which WAVES_FORMAT attribute is set to Group Delay and WAVES_GROUP_DELAY_APERTURE_MODE attribute is set to Percentage.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 5 %.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the group delay aperture in terms of the frequency separation between the two frequency points selected for group delay computation, where separation is expressed as a percentage of the total measurement frequency range for all waves for which WAVES_FORMAT attribute is set to Group Delay and WAVES_GROUP_DELAY_APERTURE_MODE attribute is set to Percentage.

Returns:

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

Return type:

int

set_group_delay_aperture_points(selector_string, value)[source]

Sets the group delay aperture in terms of the number of frequency points that separates the two frequency points for all waves for which WAVES_FORMAT attribute is set to Group Delay and WAVES_GROUP_DELAY_APERTURE_MODE attribute is set to Points. You must set the value of this attribute between 2 and the total number of frequency points in the measurement frequency range.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 11.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the group delay aperture in terms of the number of frequency points that separates the two frequency points for all waves for which WAVES_FORMAT attribute is set to Group Delay and WAVES_GROUP_DELAY_APERTURE_MODE attribute is set to Points. You must set the value of this attribute between 2 and the total number of frequency points in the measurement frequency range.

Returns:

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

Return type:

int

set_magnitude_units(selector_string, value)[source]

Sets the magnitude units for all waves for which WAVES_FORMAT attribute is set to Magnitude.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is dBm.

Name (Value)

Description

dBm (0)

Sets wave magnitude units to dBm.

dBmV (1)

Sets wave magnitude units to dBmV.

dBuV (2)

Sets wave magnitude units to dBuV.

dBmA (3)

Sets wave magnitude units to dBmA.

W (4)

Sets wave magnitude units to watts.

V (5)

Sets wave magnitude units to volts.

A (6)

Sets wave magnitude units to ampere.
Parameters:
Returns:

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

Return type:

int

set_measurement_enabled(selector_string, value)[source]

Sets whether to enable the Waves measurement.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is False.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (bool) – Specifies whether to enable the Waves measurement.

Returns:

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

Return type:

int

set_number_of_waves(selector_string, value)[source]

Sets the number of waves to be measured.

If you increase this attribute value from N to N+K, then existing N Waves are not affected but K new Waves are added. If you reduce number of Waves from N to N-K, then last K Waves are deleted without affecting the remaining N-K Waves. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 1.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the number of waves to be measured.

Returns:

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

Return type:

int

set_phase_trace_type(selector_string, value)[source]

Sets the phase type for all waves for which WAVES_FORMAT attribute is set to Phase. Phase can be represented in two mathematically equivalent ways viz. phase wrapped between the range [-180, 180) degrees, and phase can be represented in an unwrapped manner.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Wrapped.

Name (Value)

Description

Wrapped (0)

The reported wave phase is wrapped between -180 degress to +180 degrees.

Unwrapped (1)

The reported wave phase is unwrapped.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.WavesPhaseTraceType, int) – Specifies the phase type for all waves for which WAVES_FORMAT attribute is set to Phase. Phase can be represented in two mathematically equivalent ways viz. phase wrapped between the range [-180, 180) degrees, and phase can be represented in an unwrapped manner.

Returns:

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

Return type:

int

set_receiver(selector_string, value)[source]

Sets whether to measure the wave on the reference receiver or the test receiver of the Wave Receiver Port.

Incident and scattered waves are denoted by “a_<receiver port name>_<source port name>” and “b_<receiver port name>_<source port name>” respectively. On a receiver port, the a and b waves are measured using Reference receiver and Test receiver respectively.

For example, to measure “b21”, set this attribute to Test (0), WAVES_RECEIVER_PORT to “port2” and WAVES_SOURCE_PORT to “port1”.

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

The default value is Test.

Name (Value)

Description

Test (0)

Measures the wave on the test receiver.

Reference (1)

Measures the wave on the reference receiver.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.WavesReceiver, int) – Specifies whether to measure the wave on the reference receiver or the test receiver of the Wave Receiver Port.

Returns:

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

Return type:

int

set_receiver_port(selector_string, value)[source]

Sets the receiver port name for wave measurement.

Incident and scattered waves are denoted by “a_<receiver port name>_<source port name>” and “b_<receiver port name>_<source port name>” respectively. On a receiver port, the a and b waves are measured using Reference receiver and Test receiver respectively.

For example, to measure “b21”, set WAVES_RECEIVER to Test (0), set this attribute to “port2” and WAVES_SOURCE_PORT to “port1”.

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

The default value is “port1”.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (string) – Specifies the receiver port name for wave measurement.

Returns:

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

Return type:

int

set_source_port(selector_string, value)[source]

Sets the source port name for wave measurement.

Incident and scattered waves are denoted by “a_<receiver port name>_<source port name>” and “b_<receiver port name>_<source port name>” respectively. On a receiver port, the a and b waves are measured using Reference receiver and Test receiver respectively.

For example, to measure “b21”, set WAVES_RECEIVER to Test (0), WAVES_RECEIVER_PORT to “port2” and set this attribute to “port1”.

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

The default value is “port1”.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (string) – Specifies the source port name for wave measurement.

Returns:

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

Return type:

int