TxpResults

Provides methods to fetch and read the Txp measurement results.

class nirfmxwlan.txp_results.TxpResults(signal_obj)

Bases: object

Provides methods to fetch and read the Txp measurement results.

fetch_measurement(selector_string, timeout)

Returns the average power and the peak power of the signal over which power measurements are performed.

Use “segment<n>/chain<k>” as the selector string to read results from this method.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name, segment number, and chain number.

  Example:

  ”segment0/chain0”

  ”result::r1/segment0/chain0”

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

• timeout (float) – This parameter specifies the timeout 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. This value is expressed in seconds. The default value is 10.

Returns:

average_power_mean (float):

This parameter returns the average power of the acquired signal. This value is expressed in dBm. When you set the AVERAGING_ENABLED attribute to True, this parameter returns the mean of the average power computed for each averaging count.

peak_power_maximum (float):

This parameter returns the peak power of the acquired signal. This value is expressed in dBm. When you set the TXP Averaging Enabled attribute to True, this parameter returns the maximum of the peak power computed for each averaging count.

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)

Returns the power versus time trace.

Use “segment<n>/chain<k>” as the selector string to read results from this method.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name, segment number, and chain number.

  Example:

  ”segment0/chain0”

  ”result::r1/segment0/chain0”

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

• timeout (float) – This parameter specifies the timeout 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. This value is expressed in seconds. The default value is 10.

• power (numpy.float32) – This parameter returns an array of measured signal power. This value is expressed in dBm.

Returns:

x0 (float):

This parameter returns the trace start time. This value is expressed in seconds.

dx (float):

This parameter returns the sampling interval. This value is expressed 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_maximum(selector_string)

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

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

Gets the average power of the acquired signal. This value is expressed in dBm.

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

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the average power of the acquired signal. 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_average_power_minimum(selector_string)

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

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. This value is expressed in dBm.

When you set the AVERAGING_ENABLED attribute to True, this attribute returns the maximum value of the peak power computed for each averaging count.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the peak power of the acquired signal. 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_peak_power_mean(selector_string)

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

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)