TxpResults

Provides methods to fetch and read the Txp measurement results.

class nirfmxnr.txp_results.TxpResults(signal_obj)

Bases: object

Provides methods to fetch and read the Txp measurement results.

fetch_measurement(selector_string, timeout)

Fetches the average power and peak power of the the signal over which power measurments are performed.

Use “carrier<k>” or “subblock<n>/carrier<k>” as the selector string to read this result.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of the result name. The default is “” (empty string).

  Example:

  ”result::r1”

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

• timeout (float) – This parameter specifies the timeout 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.

Returns:

average_power_mean (float):

This parameter returns the average power of the the signal over which power measurments are performed. This value is expressed in dBm.

peak_power_maximum (float):

This parameter returns the peak power of the the signal over which power measurments are performed. 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 (average_power_mean, peak_power_maximum, error_code)

fetch_power_trace(selector_string, timeout, power)

Fetches power versus time trace.

Use “carrier<k>” or “subblock<n>/carrier<k>” as the selector string to read this result.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of the result name. The default is “” (empty string).

  Example:

  ”result::r1”

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

• timeout (float) – This parameter specifies the timeout 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.

• power (numpy.float32) – This parameter returns the measured average power at each time instance, in dBm.

Returns:

x0 (float):

This parameter returns the start time, in seconds.

dx (float):

This parameter returns the sample duration, in seconds.

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

Gets the average power of the acquired signal.

When you set the TXP_AVERAGING_ENABLED attribute to True, it returns the max of the peak power computed for each averaging count.

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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the average 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_peak_power_maximum(selector_string)

Gets the peak power of the acquired signal.

When you set the TXP_AVERAGING_ENABLED attribute to True, it returns the mean of the average power computed for each averaging count.

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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the peak 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)