SlotPowerConfiguration

Provides methods to configure the SlotPower measurement.

class nirfmxtdscdma.slotpower_configuration.SlotPowerConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the SlotPower measurement.

configure_measurement_length(selector_string, measurement_length)[source]

Configures the measurement length for the SlotPower measurement.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
measurement_length (int) –
This parameter specifies the measurement length for the SlotPower measurement. This value is expressed in slots. The SlotPower measurement assumes that there is only one active traffic time slot per subframe, and that the position of this active time slot is the same in each subframe. Additionally, it assumes that there are no pilots present in the received signal.

NI recommends you set a measurement length as a multiple of the number of slots per subframe, that is a multiple of 7. For example, when you set this attribute to 28 slots, the SlotPower measurement would report results for the 4 active time slots within the specified measurement length. In this example, 28 slots = 4 subframes.

The start of the measurement is determined by the TRIGGER_TYPE attribute. Although all the values of the Trigger Type attribute are supported for this measurement, it is recommended to set the Trigger Type attribute to Digital Edge with the following options:
- Digital trigger at the start of active slot, with the TRIGGER_DELAY attribute set to 0 seconds
- Digital trigger at the start of the subframe, with the Trigger Delay attribute configured to a value which is equal to the time offset of the active time slot from the start of the subframe
The table shows the values of the Trigger Delay attribute, when you specify the following active slots values:

Active Slot

Trigger Delay (microseconds)

TS0

0

TS1

950

TS2

1625

TS3

2300

TS4

2975

TS5

3650

TS6

4325

If you cannot provide a digital trigger, you can set Trigger Type attribute to IQ Power Edge to ensure that the measurement starts at the start of an active time slot. To ensure this trigger works properly, NI recommends you complete the following steps:
- Set the IQ_POWER_EDGE_TRIGGER_LEVEL attribute to allow triggering for any of the power levels in the active slots
- Run the RFmx measurement just before generating your signal
If you set the Trigger type attribute to None, the measurement will automatically detect the start of the first burst and measure the traffic slot in that position in every subframe.

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 28. The minimum value is 1.

Returns:

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

Return type:

int

get_measurement_enabled(selector_string)[source]

Gets whether to enable the SlotPower 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 SlotPower 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_length(selector_string)[source]

Gets the measurement length for the SlotPower measurement. This value is expressed in slots. The SlotPower measurement assumes that there is only one active traffic time slot per subframe, and that the position of this active time slot is the same in each subframe. Additionally, it assumes that there are no pilots present in the received signal.

NI recommends you set a measurement length as a multiple of the number of slots per subframe, that is a multiple of 7. For example, when you set this attribute to 28 slots, the SlotPower measurement would report results for the 4 active time slots within the specified measurement length. In this example, 28 slots = 4 subframes.

The start of the measurement is determined by the TRIGGER_TYPE attribute. Although all the values of the Trigger Type attribute are supported for this measurement, it is recommended to set the Trigger Type attribute to Digital Edge with the following options:

Digital trigger at the start of active slot, with the TRIGGER_DELAY attribute set to 0 seconds
Digital trigger at the start of the subframe, with the Trigger Delay attribute configured to a value which is equal to the time offset of the active time slot from the start of the subframe

The table shows the values of the Trigger Delay attribute, when you specify the following active slots values:

Active Slot	Trigger Delay (microseconds)
TS0	0
TS1	950
TS2	1625
TS3	2300
TS4	2975
TS5	3650
TS6	4325

If you cannot provide a digital trigger, you can set Trigger Type attribute to IQ Power Edge to ensure that the measurement starts at the start of an active time slot. To ensure this trigger works properly, NI recommends you complete the following steps:

Set the IQ_POWER_EDGE_TRIGGER_LEVEL attribute to allow triggering for any of the power levels in the active slots
Run the RFmx measurement just before generating your signal

If you set the Trigger type attribute to None, the measurement will automatically detect the start of the first burst and measure the traffic slot in that position in every subframe.

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 28. The minimum value is 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the measurement length for the SlotPower measurement. This value is expressed in slots. The SlotPower measurement assumes that there is only one active traffic time slot per subframe, and that the position of this active time slot is the same in each subframe. Additionally, it assumes that there are no pilots present in the received signal.
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 the RRC filter should be enabled or not.

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 SlotPower measurement.
True (1)	Enables the RRC filter in the SlotPower measurement.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SlotPowerRrcFilterEnabled):: Specifies whether the RRC filter should be enabled or not.
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_spectrum_inverted(selector_string)[source]

Gets whether the spectrum of the signal is inverted.

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 spectrum is not inverted.
True (1)	The spectrum is inverted.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SlotPowerSpectrumInverted):: Specifies whether the spectrum of the signal is inverted.
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_measurement_enabled(selector_string, value)[source]

Sets whether to enable the SlotPower 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 SlotPower 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_length(selector_string, value)[source]

Sets the measurement length for the SlotPower measurement. This value is expressed in slots. The SlotPower measurement assumes that there is only one active traffic time slot per subframe, and that the position of this active time slot is the same in each subframe. Additionally, it assumes that there are no pilots present in the received signal.

NI recommends you set a measurement length as a multiple of the number of slots per subframe, that is a multiple of 7. For example, when you set this attribute to 28 slots, the SlotPower measurement would report results for the 4 active time slots within the specified measurement length. In this example, 28 slots = 4 subframes.

The start of the measurement is determined by the TRIGGER_TYPE attribute. Although all the values of the Trigger Type attribute are supported for this measurement, it is recommended to set the Trigger Type attribute to Digital Edge with the following options:

Digital trigger at the start of active slot, with the TRIGGER_DELAY attribute set to 0 seconds
Digital trigger at the start of the subframe, with the Trigger Delay attribute configured to a value which is equal to the time offset of the active time slot from the start of the subframe

The table shows the values of the Trigger Delay attribute, when you specify the following active slots values:

Active Slot	Trigger Delay (microseconds)
TS0	0
TS1	950
TS2	1625
TS3	2300
TS4	2975
TS5	3650
TS6	4325

If you cannot provide a digital trigger, you can set Trigger Type attribute to IQ Power Edge to ensure that the measurement starts at the start of an active time slot. To ensure this trigger works properly, NI recommends you complete the following steps:

Set the IQ_POWER_EDGE_TRIGGER_LEVEL attribute to allow triggering for any of the power levels in the active slots
Run the RFmx measurement just before generating your signal

If you set the Trigger type attribute to None, the measurement will automatically detect the start of the first burst and measure the traffic slot in that position in every subframe.

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 28. The minimum value is 1.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the measurement length for the SlotPower measurement. This value is expressed in slots. The SlotPower measurement assumes that there is only one active traffic time slot per subframe, and that the position of this active time slot is the same in each subframe. Additionally, it assumes that there are no pilots present in the received signal.

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 the RRC filter should be enabled or not.

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 SlotPower measurement.
True (1)	Enables the RRC filter in the SlotPower measurement.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.SlotPowerRrcFilterEnabled, int) – Specifies whether the RRC filter should be enabled or not.

Returns:

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

Return type:

int

set_spectrum_inverted(selector_string, value)[source]

Sets whether the spectrum of the signal is inverted.

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 spectrum is not inverted.
True (1)	The spectrum is inverted.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.SlotPowerSpectrumInverted, int) – Specifies whether the spectrum of the signal is inverted.

Returns:

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

Return type:

int