TxpResults

Provides methods to fetch and read the Txp measurement results.

class nirfmxspecan.txp_results.TxpResults(signal_obj)

Bases: object

Provides methods to fetch and read the Txp measurement results.

fetch_measurement(selector_string, timeout)

Returns the powers measured using the TXP 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 timeout, in seconds, 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. The default value is 10.

Returns:

average_mean_power (float):

This parameter returns the mean power, in dBm, of the signal. Only the samples above the threshold are used by the measurement when you set the THRESHOLD_ENABLED attribute to True. When you set the AVERAGING_ENABLED attribute to True, the mean power is measured on the power trace averaged over multiple acquisitions.

peak_to_average_ratio (float):

This parameter returns the ratio of the peak power of the signal to the mean power. Only the samples above the threshold are used by the measurement when you set the TXP Threshold Enabled attribute to True. When you set the TXP Averaging Enabled attribute to True, the peak and mean powers are measured using the power trace averaged over multiple acquisitions.

maximum_power (float):

This parameter returns the maximum power, in dBm, of the averaged power trace.

minimum_power (float):

This parameter returns the minimum power, in dBm, of the averaged power trace.

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_mean_power, peak_to_average_ratio, maximum_power, minimum_power, error_code)

fetch_power_trace(selector_string, timeout, power)

Fetches the power trace used for the transmit power (TxP) 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 timeout, in seconds, 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. The default value is 10.

• power (numpy.float32) – This parameter returns the measured average power, in units specified by POWER_UNITS attribute, at each time instance.

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

Gets the mean power of the signal. This value is expressed in dBm. Only the samples above the threshold are used by the measurement when you set the THRESHOLD_ENABLED attribute to True. When you set the AVERAGING_ENABLED attribute to True, the mean power is measured using the power trace averaged over multiple acquisitions.

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 mean power of the signal. This value is expressed in dBm. Only the samples above the threshold are used by the measurement when you set the THRESHOLD_ENABLED attribute to True. When you set the AVERAGING_ENABLED attribute to True, the mean power is measured using the power trace averaged over multiple acquisitions.

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

Gets the maximum power of the averaged power trace. This value is expressed in dBm.

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 maximum power of the averaged power trace. 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_minimum_power(selector_string)

Gets the minimum power of the averaged power trace. This value is expressed in dBm.

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 minimum power of the averaged power trace. 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_to_average_ratio(selector_string)

Gets the ratio of the peak power of the signal to the mean power. Only the samples above the threshold are used by the measurement when you set the THRESHOLD_ENABLED attribute to True. When you set the AVERAGING_ENABLED attribute to True, the peak and mean powers are measured using the power trace averaged over multiple acquisitions.

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 ratio of the peak power of the signal to the mean power. Only the samples above the threshold are used by the measurement when you set the THRESHOLD_ENABLED attribute to True. When you set the AVERAGING_ENABLED attribute to True, the peak and mean powers are measured using the power trace averaged over multiple acquisitions.

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)

read(selector_string, timeout)

Configures hardware for acquisition, performs measurement on acquired data, and returns the transmit power (TXP) measurement results.

Parameters:

• selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

• timeout (float) – This parameter specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. The default value is 10.

Returns:

average_mean_power (float):

This parameter returns the mean power, in dBm, of the signal. Only the samples above the threshold are used by the measurement when you set the THRESHOLD_ENABLED attribute to True. When you set the AVERAGING_ENABLED attribute to True, the mean power is measured on the power trace averaged over multiple acquisitions.

peak_to_average_ratio (float):

This parameter returns the ratio of the peak power of the signal to the mean power. Only the samples above the threshold are used by the measurement when you set the TXP Threshold Enabled attribute to True. When you set the TXP Averaging Enabled attribute to True, the peak and mean powers are measured using the power trace averaged over multiple acquisitions.

maximum_power (float):

This parameter returns the maximum power, in dBm, of the averaged power trace.

minimum_power (float):

This parameter returns the minimum power, in dBm, of the averaged power trace.

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_mean_power, peak_to_average_ratio, maximum_power, minimum_power, error_code)