PvtConfiguration

Provides methods to configure the Pvt measurement.

class nirfmxgsm.pvt_configuration.PvtConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the Pvt measurement.

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

Configures averaging for the power versus time (PVT) 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.PvtAveragingEnabled, 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 is averaged over multiple acquisitions.
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.PvtAveragingType, int) –

This parameter specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for the measurement. The default value is RMS.

Name (Value)	Description
RMS (0)	The power at each sample interval is linearly averaged from an acquisition to the next acquisition.
Log (1)	The power at each sample interval is averaged on logarithmic scale from an acquisition to the next acquisition.
Max (3)	The peak power at each sample interval is retained from an acquisition to the next acquisition.
Min (4)	The lowest power at each sample interval is retained from an acquisition to the next acquisition.

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 power versus time (PVT) measurement.

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 power versus time (PVT) 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 PVT_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 PVT_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 power versus time (PVT) 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 measurement is averaged over multiple acquisitions.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PvtAveragingEnabled):: Specifies whether to enable averaging for the power versus time (PVT) 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 multiple acquisitions.

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 at each sample interval is linearly averaged from one acquisition to the next acquisition.
Log (1)	The power at each sample interval is averaged on a logarithmic scale from one acquisition to the next acquisition.
Max (3)	The peak power at each sample interval is retained from one acquisition to the next acquisition.
Min (4)	The lowest power at each sample interval is retained from one acquisition to the next acquisition.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PvtAveragingType):: Specifies the averaging type for 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_trace_enabled(selector_string)[source]

Gets whether the maximum power trace is enabled. When PVT_AVERAGING_ENABLED attribute is set to True, the peak power at each sample interval is retained from one acquisition to the next acquisition. You can use the RFmxGSM PVT Fetch Maximum Power Trace method to fetch the maximum power trace.

This attribute is applicable only when you set the PVT_AVERAGING_TYPE attribute to RMS or Log.

The default value is FALSE.

Name (Value)	Description
False (0)	Disables computation of the PVT Maximum Power Trace.
True (1)	Enables computation of the PVT Maximum Power Trace.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PvtMaximumPowerTraceEnabled):: Specifies whether the maximum power trace is enabled. When PVT_AVERAGING_ENABLED attribute is set to True, the peak power at each sample interval is retained from one acquisition to the next acquisition. You can use the RFmxGSM PVT Fetch Maximum Power Trace method to fetch the maximum 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 (attr_val, error_code)

get_measurement_enabled(selector_string)[source]

Gets whether to enable the power versus time (PVT) 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 power versus time (PVT) 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_minimum_power_trace_enabled(selector_string)[source]

Gets whether the minimum power trace is enabled. When PVT_AVERAGING_ENABLED attribute is set to True, the lowest power at each sample interval is retained from one acquisition to the next acquisition. You can use the RFmxGSM PVT Fetch Minimum Power Trace method to fetch the minimum power trace.

This attribute is applicable only when you set the PVT_AVERAGING_TYPE attribute to RMS or Log.

The default value is FALSE.

Name (Value)	Description
False (0)	Disables computation of the PVT Minimum Power Trace.
True (1)	Enables computation of the PVT Minimum Power Trace.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PvtMinimumPowerTraceEnabled):: Specifies whether the minimum power trace is enabled. When PVT_AVERAGING_ENABLED attribute is set to True, the lowest power at each sample interval is retained from one acquisition to the next acquisition. You can use the RFmxGSM PVT Fetch Minimum Power Trace method to fetch the minimum 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 (attr_val, error_code)

get_number_of_analysis_threads(selector_string)[source]

Gets the maximum number of threads used for parallelism for the power versus time (PVT) 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 the power versus time (PVT) 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_bandwidth(selector_string)[source]

Gets the RBW Filter Bandwidth in Hz

The default value is 500 kHz

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the RBW Filter Bandwidth 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)

set_all_traces_enabled(selector_string, value)[source]

Sets whether to enable the traces to be stored and retrieved after performing the power versus time (PVT) measurement.

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 power versus time (PVT) 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 PVT_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 PVT_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 power versus time (PVT) 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 measurement is averaged over multiple acquisitions.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.PvtAveragingEnabled, int) – Specifies whether to enable averaging for the power versus time (PVT) 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 multiple acquisitions.

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 at each sample interval is linearly averaged from one acquisition to the next acquisition.
Log (1)	The power at each sample interval is averaged on a logarithmic scale from one acquisition to the next acquisition.
Max (3)	The peak power at each sample interval is retained from one acquisition to the next acquisition.
Min (4)	The lowest power at each sample interval is retained from one acquisition to the next acquisition.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.PvtAveragingType, int) – Specifies the averaging type for multiple acquisitions.

Returns:

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

Return type:

int

set_maximum_power_trace_enabled(selector_string, value)[source]

Sets whether the maximum power trace is enabled. When PVT_AVERAGING_ENABLED attribute is set to True, the peak power at each sample interval is retained from one acquisition to the next acquisition. You can use the RFmxGSM PVT Fetch Maximum Power Trace method to fetch the maximum power trace.

This attribute is applicable only when you set the PVT_AVERAGING_TYPE attribute to RMS or Log.

The default value is FALSE.

Name (Value)	Description
False (0)	Disables computation of the PVT Maximum Power Trace.
True (1)	Enables computation of the PVT Maximum Power Trace.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.PvtMaximumPowerTraceEnabled, int) – Specifies whether the maximum power trace is enabled. When PVT_AVERAGING_ENABLED attribute is set to True, the peak power at each sample interval is retained from one acquisition to the next acquisition. You can use the RFmxGSM PVT Fetch Maximum Power Trace method to fetch the maximum power trace.

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 power versus time (PVT) 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 power versus time (PVT) measurement.

Returns:

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

Return type:

int

set_minimum_power_trace_enabled(selector_string, value)[source]

Sets whether the minimum power trace is enabled. When PVT_AVERAGING_ENABLED attribute is set to True, the lowest power at each sample interval is retained from one acquisition to the next acquisition. You can use the RFmxGSM PVT Fetch Minimum Power Trace method to fetch the minimum power trace.

This attribute is applicable only when you set the PVT_AVERAGING_TYPE attribute to RMS or Log.

The default value is FALSE.

Name (Value)	Description
False (0)	Disables computation of the PVT Minimum Power Trace.
True (1)	Enables computation of the PVT Minimum Power Trace.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.PvtMinimumPowerTraceEnabled, int) – Specifies whether the minimum power trace is enabled. When PVT_AVERAGING_ENABLED attribute is set to True, the lowest power at each sample interval is retained from one acquisition to the next acquisition. You can use the RFmxGSM PVT Fetch Minimum Power Trace method to fetch the minimum power trace.

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 the power versus time (PVT) 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 the power versus time (PVT) 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_bandwidth(selector_string, value)[source]

Sets the RBW Filter Bandwidth in Hz

The default value is 500 kHz

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the RBW Filter Bandwidth in Hz

Returns:

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

Return type:

int