TxpConfiguration

Provides methods to configure the Txp measurement.

class nirfmxspecan.txp_configuration.TxpConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the Txp measurement.

configure_averaging(selector_string, averaging_enabled, averaging_count, averaging_type)[source]

Configures averaging for the transmit power (TXP) measurement.

Parameters:

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

  • averaging_enabled (enums.TxpAveragingEnabled, int) –

    This parameter specifies whether to enable averaging for the measurement. The default value is False.

    Name (Value)

    Description

    False (0)

    The measurement is performed on a single acquisition.

    True (1)

    The measurement uses the value of the Averaging Count parameter to calculate the number of acquisitions over which the measurement is averaged.

  • averaging_count (int) – This parameter specifies the number of acquisitions used for averaging when you set the Averaging Enabled parameter to True. The default value is 10.

  • averaging_type (enums.TxpAveragingType, int) –

    This parameter specifies the averaging type for averaging the power over multiple acquisitions. The averaged power trace is used for the measurement. Refer to the Averaging section of the Spectrum topic for more information about averaging types. The default value is RMS.

    Name (Value)

    Description

    RMS (0)

    The power trace is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.

    Log (1)

    The power trace is averaged in a logarithmic scale.

    Scalar (2)

    The square root of the power trace is averaged.

    Max (3)

    The peak power in the power trace at each sample instance is retained from one acquisition to the next.

    Min (4)

    The least power in the power trace at each sample instance is retained from one acquisition to the next.

Returns:

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

Return type:

int

configure_measurement_interval(selector_string, measurement_interval)[source]

Specifies the acquisition time, in seconds, for the transmit power (TXP) measurement.

Parameters:

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

  • measurement_interval (float) – This parameter specifies the acquisition time, in seconds, for the measurement. The default value is 1 ms.

Returns:

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

Return type:

int

configure_rbw_filter(selector_string, rbw, rbw_filter_type, rrc_alpha)[source]

Configures the resolution bandwidth (RBW) filter to measure the power of the signal as seen through this filter.

Parameters:

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

  • rbw (float) – This parameter specifies the bandwidth, in Hz, of the resolution bandwidth (RBW) filter used to measure the signal. The default value is 100 kHz.

  • rbw_filter_type (enums.TxpRbwFilterType, int) –

    This parameter specifies the shape of the digital RBW filter. The default value is Gaussian.

    Name (Value)

    Description

    None (1)

    The measurement does not use any RBW filtering.

    Gaussian (2)

    The RBW filter has a Gaussian response.

    Flat (3)

    The RBW filter has a flat response.

    RRC (4)

    The RRC filter with the roll-off specified by RRC Alpha parameter is used as the RBW filter.

  • rrc_alpha (float) – This parameter specifies the roll-off factor for the root-raised-cosine (RRC) filter. The default value is 0.1.

Returns:

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

Return type:

int

configure_threshold(selector_string, threshold_enabled, threshold_level, threshold_type)[source]

Configures the threshold level for the samples that need to be considered for the transmit power (TXP) measurement. Enable the threshold when analyzing burst signals or signals with dead time.

Parameters:

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

  • threshold_enabled (enums.TxpThresholdEnabled, int) –

    This parameter specifies whether to enable thresholding of the acquired samples to be used for the measurement. The default value is False.

    Name (Value)

    Description

    False (0)

    All samples are considered for the measurement.

    True (1)

    The samples above the threshold level specified in the Threshold Level parameter are considered for the measurement.

  • threshold_level (float) – This parameter specifies either the relative or absolute threshold power level based on the value of the Threshold Type parameter. The default value is -20 dB.

  • threshold_type (enums.TxpThresholdType, int) –

    This parameter specifies the reference for the power level used for thresholding. The default value is Relative.

    Name (Value)

    Description

    Relative (0)

    The threshold is relative to the peak power, in dB, of the acquired samples.

    Absolute (1)

    The threshold is the absolute power, in dBm.

Returns:

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

Return type:

int

configure_vbw_filter(selector_string, vbw_auto, vbw, vbw_to_rbw_ratio)[source]

Configures VBW settings including the VBW mode, video bandwidth (VBW), and the VBW to RBW ratio.

Parameters:

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

  • vbw_auto (enums.TxpVbwFilterAutoBandwidth, int) –

    This parameter specifies whether the VBW is expressed directly or computed based on VBW to RBW ratio. The default value is True.

    Name (Value)

    Description

    False (0)

    Specify the video bandwidth in the VBW parameter. The VBW to RBW Ratio parameter is disregarded in this mode.

    True (1)

    Specify video bandwidth in terms of the VBW to RBW ratio. The value of the video bandwidth is then computed by using the TXP VBW to RBW Ratio attribute and the TXP RBW attribute. The value of the VBW parameter is disregarded in this mode.

  • vbw (float) – This parameter specifies the video bandwidth when you set the VBW Auto parameter to False. This value is expressed in Hz. The default value is 30KHz.

  • vbw_to_rbw_ratio (float) – This parameter specifies the VBW to RBW Ratio when you set the VBW Auto parameter to True. The default value is 3.

Returns:

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

Return type:

int

get_all_traces_enabled(selector_string)[source]

Gets whether to enable the traces to be stored and retrieved after performing 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 traces to be stored and retrieved after performing 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_averaging_count(selector_string)[source]

Gets the number of acquisitions used for averaging when you set the AVERAGING_ENABLED attribute to 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 you set the AVERAGING_ENABLED attribute to 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)[source]

Gets whether to enable averaging for 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.

Name (Value)

Description

False (0)

The measurement is performed on a single acquisition.

True (1)

The TXP measurement uses the TXP Averaging Count attribute as the number of acquisitions over which the TXP measurement is averaged.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.TxpAveragingEnabled):

Specifies whether to enable averaging for 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_averaging_type(selector_string)[source]

Gets the averaging type for the TXP measurement. The averaged power trace is used for the 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 RMS.

Name (Value)

Description

RMS (0)

The power trace is linearly averaged.

Log (1)

The power trace is averaged in a logarithmic scale.

Scalar (2)

The square root of the power trace is averaged.

Max (3)

The maximum instantaneous power in the power trace is retained from one acquisition to the next.

Min (4)

The minimum instantaneous power in the power trace is retained from one acquisition to the next.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.TxpAveragingType):

Specifies the averaging type for the TXP measurement. The averaged power trace is used for the 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)[source]

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)[source]

Gets the acquisition time for the 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.001.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the acquisition time for the 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)[source]

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

The number of threads can range from 1 to the number of physical cores. The number of threads you set may not be used in calculations. The actual number of threads used depends on the problem size, system resources, data availability, and other considerations.

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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the maximum number of threads used for parallelism 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_rbw_filter_alpha(selector_string)[source]

Gets the roll-off factor for the root-raised-cosine (RRC) filter.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the roll-off factor for the root-raised-cosine (RRC) filter.

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_rbw_filter_bandwidth(selector_string)[source]

Gets the bandwidth of the resolution bandwidth (RBW) filter used to measure the signal. This value is expressed in Hz.

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 100 kHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the bandwidth of the resolution bandwidth (RBW) filter used to measure the signal. 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 (attr_val, error_code)

get_rbw_filter_type(selector_string)[source]

Gets the shape of the digital resolution bandwidth (RBW) filter.

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

Name (Value)

Description

Gaussian (1)

The RBW filter has a Gaussian response.

Flat (2)

The RBW filter has a flat response.

None (5)

The measurement does not use any RBW filtering.

RRC (6)

The RRC filter with the roll-off specified by the TXP RBW RRC Alpha attribute is used as the RBW filter.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.TxpRbwFilterType):

Specifies the shape of the digital resolution bandwidth (RBW) filter.

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_threshold_enabled(selector_string)[source]

Gets whether to enable thresholding of the acquired samples to be used for 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.

Name (Value)

Description

False (0)

All the acquired samples are considered for the TXP measurement.

True (1)

The samples above the threshold level specified in the TXP Threshold Level attribute are considered for the TXP measurement.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.TxpThresholdEnabled):

Specifies whether to enable thresholding of the acquired samples to be used for 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_threshold_level(selector_string)[source]

Gets either the relative or absolute threshold power level based on the value of the THRESHOLD_TYPE attribute.

The default value is -20.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies either the relative or absolute threshold power level based on the value of the THRESHOLD_TYPE attribute.

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_threshold_type(selector_string)[source]

Gets the reference for the power level used for thresholding.

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

Name (Value)

Description

Relative (0)

The threshold is relative to the peak power of the acquired samples.

Absolute (1)

The threshold is the absolute power, in dBm.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.TxpThresholdType):

Specifies the reference for the power level used for thresholding.

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_vbw_filter_auto_bandwidth(selector_string)[source]

Gets whether the video bandwidth (VBW) is expressed directly or computed based on the VBW to RBW ratio.

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

Name (Value)

Description

False (0)

Specify the video bandwidth in the TXP VBW attribute. The TXP VBW to RBW Ratio attribute is disregarded in this mode.

True (1)

Specify video bandwidth in terms of the VBW to RBW ratio. The value of the video bandwidth is then computed by using the TXP VBW to RBW Ratio attribute and the TXP RBW attribute. The value of the TXP VBW attribute is disregarded in this mode.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.TxpVbwFilterAutoBandwidth):

Specifies whether the video bandwidth (VBW) is expressed directly or computed based on the VBW to RBW ratio.

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_vbw_filter_bandwidth(selector_string)[source]

Gets the video bandwidth when you set the VBW_FILTER_AUTO_BANDWIDTH attribute to False.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the video bandwidth when you set the VBW_FILTER_AUTO_BANDWIDTH attribute to False.

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_vbw_filter_vbw_to_rbw_ratio(selector_string)[source]

Gets the VBW to RBW Ratio when you set the VBW_FILTER_AUTO_BANDWIDTH attribute to 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 3.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the VBW to RBW Ratio when you set the VBW_FILTER_AUTO_BANDWIDTH attribute to 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)

set_all_traces_enabled(selector_string, value)[source]

Sets whether to enable the traces to be stored and retrieved after performing 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 traces to be stored and retrieved after performing 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_averaging_count(selector_string, value)[source]

Sets the number of acquisitions used for averaging when you set the AVERAGING_ENABLED attribute to 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 you set the AVERAGING_ENABLED attribute to 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)[source]

Sets whether to enable averaging for 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.

Name (Value)

Description

False (0)

The measurement is performed on a single acquisition.

True (1)

The TXP measurement uses the TXP Averaging Count attribute as the number of acquisitions over which the TXP measurement is averaged.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.TxpAveragingEnabled, int) – Specifies whether to enable averaging for 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_averaging_type(selector_string, value)[source]

Sets the averaging type for the TXP measurement. The averaged power trace is used for the 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 RMS.

Name (Value)

Description

RMS (0)

The power trace is linearly averaged.

Log (1)

The power trace is averaged in a logarithmic scale.

Scalar (2)

The square root of the power trace is averaged.

Max (3)

The maximum instantaneous power in the power trace is retained from one acquisition to the next.

Min (4)

The minimum instantaneous power in the power trace is retained from one acquisition to the next.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.TxpAveragingType, int) – Specifies the averaging type for the TXP measurement. The averaged power trace is used for the 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)[source]

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)[source]

Sets the acquisition time for the 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.001.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the acquisition time for the 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)[source]

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

The number of threads can range from 1 to the number of physical cores. The number of threads you set may not be used in calculations. The actual number of threads used depends on the problem size, system resources, data availability, and other considerations.

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.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the maximum number of threads used for parallelism 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_rbw_filter_alpha(selector_string, value)[source]

Sets the roll-off factor for the root-raised-cosine (RRC) filter.

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

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the roll-off factor for the root-raised-cosine (RRC) filter.

Returns:

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

Return type:

int

set_rbw_filter_bandwidth(selector_string, value)[source]

Sets the bandwidth of the resolution bandwidth (RBW) filter used to measure the signal. This value is expressed in Hz.

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 100 kHz.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the bandwidth of the resolution bandwidth (RBW) filter used to measure the signal. This value is expressed in Hz.

Returns:

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

Return type:

int

set_rbw_filter_type(selector_string, value)[source]

Sets the shape of the digital resolution bandwidth (RBW) filter.

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

Name (Value)

Description

Gaussian (1)

The RBW filter has a Gaussian response.

Flat (2)

The RBW filter has a flat response.

None (5)

The measurement does not use any RBW filtering.

RRC (6)

The RRC filter with the roll-off specified by the TXP RBW RRC Alpha attribute is used as the RBW filter.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.TxpRbwFilterType, int) – Specifies the shape of the digital resolution bandwidth (RBW) filter.

Returns:

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

Return type:

int

set_threshold_enabled(selector_string, value)[source]

Sets whether to enable thresholding of the acquired samples to be used for 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.

Name (Value)

Description

False (0)

All the acquired samples are considered for the TXP measurement.

True (1)

The samples above the threshold level specified in the TXP Threshold Level attribute are considered for the TXP measurement.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.TxpThresholdEnabled, int) – Specifies whether to enable thresholding of the acquired samples to be used for 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_threshold_level(selector_string, value)[source]

Sets either the relative or absolute threshold power level based on the value of the THRESHOLD_TYPE attribute.

The default value is -20.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies either the relative or absolute threshold power level based on the value of the THRESHOLD_TYPE attribute.

Returns:

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

Return type:

int

set_threshold_type(selector_string, value)[source]

Sets the reference for the power level used for thresholding.

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

Name (Value)

Description

Relative (0)

The threshold is relative to the peak power of the acquired samples.

Absolute (1)

The threshold is the absolute power, in dBm.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.TxpThresholdType, int) – Specifies the reference for the power level used for thresholding.

Returns:

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

Return type:

int

set_vbw_filter_auto_bandwidth(selector_string, value)[source]

Sets whether the video bandwidth (VBW) is expressed directly or computed based on the VBW to RBW ratio.

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

Name (Value)

Description

False (0)

Specify the video bandwidth in the TXP VBW attribute. The TXP VBW to RBW Ratio attribute is disregarded in this mode.

True (1)

Specify video bandwidth in terms of the VBW to RBW ratio. The value of the video bandwidth is then computed by using the TXP VBW to RBW Ratio attribute and the TXP RBW attribute. The value of the TXP VBW attribute is disregarded in this mode.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.TxpVbwFilterAutoBandwidth, int) – Specifies whether the video bandwidth (VBW) is expressed directly or computed based on the VBW to RBW ratio.

Returns:

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

Return type:

int

set_vbw_filter_bandwidth(selector_string, value)[source]

Sets the video bandwidth when you set the VBW_FILTER_AUTO_BANDWIDTH attribute to False.

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

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the video bandwidth when you set the VBW_FILTER_AUTO_BANDWIDTH attribute to False.

Returns:

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

Return type:

int

set_vbw_filter_vbw_to_rbw_ratio(selector_string, value)[source]

Sets the VBW to RBW Ratio when you set the VBW_FILTER_AUTO_BANDWIDTH attribute to 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 3.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the VBW to RBW Ratio when you set the VBW_FILTER_AUTO_BANDWIDTH attribute to True.

Returns:

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

Return type:

int