PvtConfiguration

Provides methods to configure the Pvt measurement.

class nirfmxtdscdma.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 PVT measurement. The default value is False.

    Name (value)

    Description

    False (0)

    The measurement is performed on a single acquisition.

    True (1)

    The PVT measurement uses the value of the Averaging Count parameter as the number of acquisitions over which the PVT 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.PvtAveragingType, int) –

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

    Name (value)

    Description

    RMS (0)

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

    Log (1)

    The power spectrum is averaged on a logarithmic scale.

Returns:

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

Return type:

int

configure_measurement_method(selector_string, measurement_method)[source]

Configures the measurement method 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.

  • measurement_method (enums.PvtMeasurementMethod, int) –

    This parameter specifies the method used for performing the PVT measurement. The default value is Normal.

    Name (value)

    Description

    Normal (0)

    The PVT measurement acquires the spectrum using the same signal analyzer setting across frequency bands. Use this method when a higher measurement speed is preferred over a higher dynamic range.

    Dynamic Range (1)

    The PVT measurement acquires the spectrum using the hardware-specific optimizations for different frequency bands. Use this method to get the best dynamic range. Supported Devices: PXIe-5644R/5645R/5646R/5840/5841/5842/5860.

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.

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 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 PVT measurement uses the value of the PVT Averaging Count attribute as the number of acquisitions over which the PVT measurement is averaged.
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 averaging multiple spectrum acquisitions. The averaged spectrum is used 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 RMS.

Name (Value)

Description

RMS (0)

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

Log (1)

The power spectrum is averaged on a logarithmic scale.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PvtAveragingType):

Specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used 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_measurement_enabled(selector_string)[source]

Gets whether to enable the power versus time (PVT) measurement (Transmit ON/off time mask) according to the 3GPP TS 34.122 specification.

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 (Transmit ON/off time mask) according to the 3GPP TS 34.122 specification.

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

Gets the method for performing 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 Normal.

Name (Value)

Description

Normal (0)

The PVT measurement acquires the spectrum using the same signal analyzer setting across frequency bands. Use this method when a higher measurement speed is preferred over a higher dynamic range.

Dynamic Range (1)

The PVT measurement acquires the spectrum using the hardware-specific optimizations for different frequency bands. Use this method to get the best dynamic range.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PvtMeasurementMethod):

Specifies the method for 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_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_number_of_segments(selector_string)[source]

Gets the number of segments defined for the power versus time (PVT) measurement.

You do not need to use a selector string to 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 6.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns the number of segments defined 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_rrc_filter_enabled(selector_string)[source]

Gets whether to enable the RRC filter. Use this attribute to disable the filter if the received signal is already RRC-filtered.

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)

Disables the RRC filter in the measurement.

True (1)

Enables the RRC filter in the measurement.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PvtRrcFilterEnabled):

Specifies whether to enable the RRC filter. Use this attribute to disable the filter if the received signal is already RRC-filtered.

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

Gets the start time of a specific power versus time (PVT) measurement segment. This value is expressed in seconds. The start time is defined relative to the burst start.

Use “segment<n>” as the Selector String to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the start time of a specific power versus time (PVT) measurement segment. This value is expressed in seconds. The start time is defined relative to the burst start.

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

Gets the stop time of a specific power versus time (PVT) measurement segment. This value is expressed in seconds. The start time is defined relative to the burst start.

Use “segment<n>” as the Selector String to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the stop time of a specific power versus time (PVT) measurement segment. This value is expressed in seconds. The start time is defined relative to the burst start.

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.

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 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 PVT measurement uses the value of the PVT Averaging Count attribute as the number of acquisitions over which the PVT measurement is averaged.
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 averaging multiple spectrum acquisitions. The averaged spectrum is used 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 RMS.

Name (Value)

Description

RMS (0)

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

Log (1)

The power spectrum is averaged on a logarithmic scale.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.PvtAveragingType, int) – Specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used 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_measurement_enabled(selector_string, value)[source]

Sets whether to enable the power versus time (PVT) measurement (Transmit ON/off time mask) according to the 3GPP TS 34.122 specification.

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 (Transmit ON/off time mask) according to the 3GPP TS 34.122 specification.

Returns:

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

Return type:

int

set_measurement_method(selector_string, value)[source]

Sets the method for performing 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 Normal.

Name (Value)

Description

Normal (0)

The PVT measurement acquires the spectrum using the same signal analyzer setting across frequency bands. Use this method when a higher measurement speed is preferred over a higher dynamic range.

Dynamic Range (1)

The PVT measurement acquires the spectrum using the hardware-specific optimizations for different frequency bands. Use this method to get the best dynamic range.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.PvtMeasurementMethod, int) – Specifies the method for 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_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_rrc_filter_enabled(selector_string, value)[source]

Sets whether to enable the RRC filter. Use this attribute to disable the filter if the received signal is already RRC-filtered.

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)

Disables the RRC filter in the measurement.

True (1)

Enables the RRC filter in the measurement.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.PvtRrcFilterEnabled, int) – Specifies whether to enable the RRC filter. Use this attribute to disable the filter if the received signal is already RRC-filtered.

Returns:

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

Return type:

int