TxpConfiguration

Provides methods to configure the Txp measurement.

class nirfmxnr.txp_configuration.TxpConfiguration(signal_obj)

Bases: object

Provides methods to configure the Txp measurement.

get_all_traces_enabled(selector_string)

Enables the traces to be stored and retrieved after the TXP measurement is performed.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (bool):

Enables the traces to be stored and retrieved after the TXP measurement is performed.

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

Gets the number of acquisitions used for averaging when TXP_AVERAGING_ENABLED is True.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the number of acquisitions used for averaging when TXP_AVERAGING_ENABLED is True.

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

Gets whether to enable averaging for TXP measurement.

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

Name (Value)	Description
False (0)	The number of acquisitions is 1.
True (1)	The measurement uses the Averaging Count for the number of acquisitions over which the measurement is averaged.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.TxpAveragingEnabled):

Specifies whether to enable averaging for TXP measurement.

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

Gets whether to enable the TXP measurement.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (bool):

Specifies whether to enable the TXP measurement.

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

Gets the measurement interval. This value is expressed in seconds.

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 1 ms.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the measurement 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 (attr_val, error_code)

get_measurement_offset(selector_string)

Gets the measurement offset to skip from the start of acquired waveform for TXP measurement. This value is expressed in seconds.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the measurement offset to skip from the start of acquired waveform for TXP measurement. 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 (attr_val, error_code)

get_number_of_analysis_threads(selector_string)

Gets the maximum number of threads used for parallelism inside TXP measurement.

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 number of threads must range from 1 to the number of physical cores. The default value is 1.

The number of threads set used in calculations is not guaranteed. The actual number of threads used depends on the problem size, system resources, data availability, and other considerations.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the maximum number of threads used for parallelism inside TXP measurement.

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)

set_all_traces_enabled(selector_string, value)

Enables the traces to be stored and retrieved after the TXP measurement is performed.

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

Parameters:

• selector_string (string) – Pass an empty string.

• value (bool) – Enables the traces to be stored and retrieved after the TXP measurement is performed.

Returns:

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

Return type:

int

set_averaging_count(selector_string, value)

Sets the number of acquisitions used for averaging when TXP_AVERAGING_ENABLED is True.

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

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the number of acquisitions used for averaging when TXP_AVERAGING_ENABLED is True.

Returns:

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

Return type:

int

set_averaging_enabled(selector_string, value)

Sets whether to enable averaging for TXP measurement.

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

Name (Value)	Description
False (0)	The number of acquisitions is 1.
True (1)	The measurement uses the Averaging Count for the number of acquisitions over which the measurement is averaged.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.TxpAveragingEnabled, int) – Specifies whether to enable averaging for TXP measurement.

Returns:

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

Return type:

int

set_measurement_enabled(selector_string, value)

Sets whether to enable the TXP measurement.

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

Parameters:

• selector_string (string) – Pass an empty string.

• value (bool) – Specifies whether to enable the TXP measurement.

Returns:

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

Return type:

int

set_measurement_interval(selector_string, value)

Sets the measurement interval. This value is expressed in seconds.

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 1 ms.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the measurement interval. This value is expressed in seconds.

Returns:

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

Return type:

int

set_measurement_offset(selector_string, value)

Sets the measurement offset to skip from the start of acquired waveform for TXP measurement. This value is expressed in seconds.

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

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the measurement offset to skip from the start of acquired waveform for TXP measurement. This value is expressed in seconds.

Returns:

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

Return type:

int

set_number_of_analysis_threads(selector_string, value)

Sets the maximum number of threads used for parallelism inside TXP measurement.

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 number of threads must range from 1 to the number of physical cores. The default value is 1.

The number of threads set used in calculations is not guaranteed. The actual number of threads used depends on the problem size, system resources, data availability, and other considerations.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the maximum number of threads used for parallelism inside TXP measurement.

Returns:

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

Return type:

int