ObwResults

Provides methods to fetch and read the Obw measurement results.

class nirfmxwcdma.obw_results.ObwResults(signal_obj)

Bases: object

Provides methods to fetch and read the Obw measurement results.

fetch_measurement(selector_string, timeout)

Fetches the absolute and relative powers of the carrier for the OBW measurement. The relative power is relative to the total carrier power.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ”result::r1”

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

• timeout (float) – This parameter specifies the time for which the method waits for the measurement to complete. This value is expressed in seconds. 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 bandwidth containing 99% of the total integrated power of the acquired signal, around the center of the carriers.

absolute_power (float):

This parameter returns the carrier power integrated over a bandwidth of 5 MHz. This value is expressed in dBm.

start_frequency (float):

This parameter returns the start frequency of the Occupied Bandwidth parameter.

stop_frequency (float):

This parameter returns the stop frequency of the Occupied Bandwidth parameter.

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 used for the OBW measurement.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ”result::r1”

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

• timeout (float) – This parameter specifies the time for which the method waits for the measurement to complete. This value is expressed in seconds. 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 at each frequency bin. The 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 total integrated power of the acquired signal.

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 and named results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the total integrated power of the acquired signal.

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 containing 99% of the total integrated power of the acquired signal around the center of the carriers.

This value is expressed in Hz.

OBW Results Occupied BW = OBW Results Stop Frequency - OBW Results 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 and named results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the bandwidth containing 99% of the total integrated power of the acquired signal around the center of the carriers.

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_RESULTS_OCCUPIED_BANDWIDTH.

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 and named results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the start frequency of the OBW_RESULTS_OCCUPIED_BANDWIDTH.

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_RESULTS_OCCUPIED_BANDWIDTH.

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 and named results.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the stop frequency of the OBW_RESULTS_OCCUPIED_BANDWIDTH.

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)