PvtConfiguration

Provides methods to configure the Pvt measurement.

class nirfmxnr.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 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. The number of acquisitions is obtained by the Averaging Count parameter.

  • 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 spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.

    Log (1)

    The power spectrum is averaged in 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 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 for performing the PVT measurement. The default value is ** Normal**.

    Name (Value)

    Description

    Normal (0)

    The measurement is performed using a single acquisition. Use this method when a high dynamic range is not required.

    Dynamic Range (1)

    The measurement is performed using two acquisitions. Use this method when a higher dynamic range is desirable over the measurement speed. Supported Devices: PXIe-5644R/5645R/5646R, PXIe-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

configure_off_power_exclusion_periods(selector_string, off_power_exclusion_before, off_power_exclusion_after)[source]

Configures the time excluded from the off region before and after the burst.

Parameters:

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

  • off_power_exclusion_before (float) – This parameter specifies the time excluded from the Off region before the burst. This value is expressed in seconds. The default value is 0.

  • off_power_exclusion_after (float) – This parameter specifies the time excluded from the Off region after the burst. This value is expressed in seconds. The default value is 0.

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 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 measurement averaging type.

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.

Log (1)

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

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PvtAveragingType):

Specifies the measurement averaging type.

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

Gets the measurement interval when the PVT_MEASUREMENT_INTERVAL_AUTO attribute is set to False. 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 10 ms.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the measurement interval when the PVT_MEASUREMENT_INTERVAL_AUTO attribute is set to False. 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_interval_auto(selector_string)[source]

Gets whether the measurement interval is computed by the measurement or configured by the user through PVT_MEASUREMENT_INTERVAL attribute.

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.

Setting this attribute to FALSE is supported for downlink only. The default value is True. Refer to measurement guidelines details in the NR Power Vs Time concept help for more information.

Name (Value)

Description

False (0)

Measurement Interval is defined by the Measurement Interval attribute.

True (1)

Measurement Inteval is computed by the measurement.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PvtMeasurementIntervalAuto):

Specifies whether the measurement interval is computed by the measurement or configured by the user through PVT_MEASUREMENT_INTERVAL 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_measurement_method(selector_string)[source]

Gets the PVT measurement method.

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 measurement is performed using a single acquisition. Use this method when a high dynamic range is not required.

Dynamic Range (1)

The measurement is performed using two acquisitions. Use this method when a higher dynamic range is desirable over the measurement speed.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PvtMeasurementMethod):

Specifies the PVT measurement method.

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 inside the 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 inside the 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_off_power_exclusion_after(selector_string)[source]

Gets the time excluded from the OFF region after the burst and at the end for uplink and downlink, respectively. The 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. Refer to measurement guidelines details in the NR Power Vs Time concept help for more information.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the time excluded from the OFF region after the burst and at the end for uplink and downlink, respectively. The 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_off_power_exclusion_before(selector_string)[source]

Gets the time excluded from the OFF region before the burst and at the beginning for uplink and downlink, respectively. The 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. Refer to measurement guidelines details in the NR Power Vs Time concept help for more information.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the time excluded from the OFF region before the burst and at the beginning for uplink and downlink, respectively. The 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)

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 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 measurement averaging type.

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.

Log (1)

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

  • selector_string (string) – Pass an empty string.

  • value (enums.PvtAveragingType, int) – Specifies the measurement averaging type.

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 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 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_interval(selector_string, value)[source]

Sets the measurement interval when the PVT_MEASUREMENT_INTERVAL_AUTO attribute is set to False. 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 10 ms.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the measurement interval when the PVT_MEASUREMENT_INTERVAL_AUTO attribute is set to False. 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_interval_auto(selector_string, value)[source]

Sets whether the measurement interval is computed by the measurement or configured by the user through PVT_MEASUREMENT_INTERVAL attribute.

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.

Setting this attribute to FALSE is supported for downlink only. The default value is True. Refer to measurement guidelines details in the NR Power Vs Time concept help for more information.

Name (Value)

Description

False (0)

Measurement Interval is defined by the Measurement Interval attribute.

True (1)

Measurement Inteval is computed by the measurement.
Parameters:
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 PVT measurement method.

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 measurement is performed using a single acquisition. Use this method when a high dynamic range is not required.

Dynamic Range (1)

The measurement is performed using two acquisitions. Use this method when a higher dynamic range is desirable over the measurement speed.
Parameters:
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 inside the 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 inside the 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_off_power_exclusion_after(selector_string, value)[source]

Sets the time excluded from the OFF region after the burst and at the end for uplink and downlink, respectively. The 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. Refer to measurement guidelines details in the NR Power Vs Time concept help for more information.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the time excluded from the OFF region after the burst and at the end for uplink and downlink, respectively. The 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_off_power_exclusion_before(selector_string, value)[source]

Sets the time excluded from the OFF region before the burst and at the beginning for uplink and downlink, respectively. The 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. Refer to measurement guidelines details in the NR Power Vs Time concept help for more information.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the time excluded from the OFF region before the burst and at the beginning for uplink and downlink, respectively. The 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