ObwResults

Provides methods to fetch and read the Obw measurement results.

class nirfmxtdscdma.obw_results.ObwResults(signal_obj)

Bases: object

Provides methods to fetch and read the Obw measurement results.

fetch_measurement(selector_string, timeout)

Returns the OBW measurement.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name. Examples:

  ””

  ”signal::sig1”

  ”result::r1”

  ”signal::sig1/result::r1”

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

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. This value is expressed in seconds. 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:

occupied_bandwidth (float):

This parameter returns the OBW. This value is expressed in Hz. The OBW is calculated using the following formula: OBW = Stop Frequency - Start Frequency.

absolute_power (float):

This parameter returns the total integrated power of the averaged spectrum acquired by the OBW measurement. This value is expressed in dBm.

start_frequency (float):

This parameter returns the start frequency of the OBW. This value is expressed in Hz.

stop_frequency (float):

This parameter returns the stop frequency of the OBW. This value is expressed in Hz.

error_code (int):

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

Return type:

Tuple (occupied_bandwidth, absolute_power, start_frequency, stop_frequency, error_code)

fetch_spectrum(selector_string, timeout, spectrum)

Fetches the spectrum trace used for the OBW measurement.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name. Examples:

  ””

  ”signal::sig1”

  ”result::r1”

  ”signal::sig1/result::r1”

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

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. This value is expressed in seconds. 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.

• spectrum (numpy.float32) – This parameter returns the averaged power measured at each frequency bin. This value is expressed in dBm.

Returns:

x0 (float):

This parameter returns the start frequency. This value is expressed in Hz.

dx (float):

This parameter returns the frequency bin spacing. This value is expressed in Hz.

error_code (int):

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

Return type:

Tuple (x0, dx, error_code)

get_absolute_power(selector_string)

Gets the absolute power measured in the OBW. This value is expressed in dBm.

You do not need to use a selector string to read this result for the default signal and result instances. Refer to the Selector String topic for information about the string syntax for named signals.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the absolute power measured in the OBW. This value is expressed in dBm.

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_occupied_bandwidth(selector_string)

Gets the bandwidth that occupies 99% of the total signal power. This value is expressed in Hz.

You do not need to use a selector string to read this result for the default signal and result instances. Refer to the Selector String topic for information about the string syntax for named signals.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the bandwidth that occupies 99% of the total signal power. This value is expressed in Hz.

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_start_frequency(selector_string)

Gets the start frequency of the OBW. This value is expressed in Hz.

The OBW is calculated using the following formula:

OBW = Stop Frequency - Start Frequency

You do not need to use a selector string to read this result for the default signal and result instances. Refer to the Selector String topic for information about the string syntax for named signals.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the start frequency of the OBW. This value is expressed in Hz.

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_stop_frequency(selector_string)

Gets the stop frequency of the OBW. This value is expressed in Hz.

The OBW is calculated using the following formula:

OBW = Stop Frequency - Start Frequency

You do not need to use a selector string to read this result for the default signal and result instances. Refer to the Selector String topic for information about the string syntax for named signals.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the stop frequency of the OBW. This value is expressed in Hz.

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)