SlotPowerConfiguration

Provides methods to configure the SlotPower measurement.

class nirfmxlte.slotpower_configuration.SlotPowerConfiguration(signal_obj)

Bases: object

Provides methods to configure the SlotPower measurement.

configure_measurement_interval(selector_string, measurement_offset, measurement_length)

Configures the Measurement Offset and Measurement Length parameters of SlotPower measurement.

Parameters:

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

• measurement_offset (int) – This parameter specifies the measurement offset to skip from the frame boundary or the marker (external trigger) location. This value is expressed in subframes. The default value is 0.

• measurement_length (int) – This parameter specifies the number of subframes to be measured. This value is expressed in subframes. The default value is 10.

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)

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

Gets whether the same Reference Clock is used for the local oscillator and the digital-to-analog converter in the transmitter. When the same Reference Clock is used, the carrier frequency offset is proportional to Sample Clock error.

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)	The Sample Clock error is estimated independently.
True (1)	The Sample Clock error is estimated from carrier frequency offset.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SlotPowerCommonClockSourceEnabled):

Specifies whether the same Reference Clock is used for the local oscillator and the digital-to-analog converter in the transmitter. When the same Reference Clock is used, the carrier frequency offset is proportional to Sample Clock error.

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)

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)

Gets the number of subframes to be measured. This value is expressed in 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 10.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the number of subframes to be measured. This value is expressed in subframe.

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_offset(selector_string)

Gets the measurement offset to skip from the frame boundary or the marker (external trigger) location. This value is expressed in 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 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the measurement offset to skip from the frame boundary or the marker (external trigger) location. This value is expressed in subframe.

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)

Gets whether the spectrum of the measured signal is inverted. The inversion happens when the I and the Q components of the baseband complex signal are swapped.

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 of the measured signal is not inverted.
True (1)	The measured signal is inverted and the measurement corrects the signal by swapping the I and the Q components.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SlotPowerSpectrumInverted):

Specifies whether the spectrum of the measured signal is inverted. The inversion happens when the I and the Q components of the baseband complex signal are swapped.

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)

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

Sets whether the same Reference Clock is used for the local oscillator and the digital-to-analog converter in the transmitter. When the same Reference Clock is used, the carrier frequency offset is proportional to Sample Clock error.

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)	The Sample Clock error is estimated independently.
True (1)	The Sample Clock error is estimated from carrier frequency offset.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.SlotPowerCommonClockSourceEnabled, int) – Specifies whether the same Reference Clock is used for the local oscillator and the digital-to-analog converter in the transmitter. When the same Reference Clock is used, the carrier frequency offset is proportional to Sample Clock error.

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)

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)

Sets the number of subframes to be measured. This value is expressed in 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 10.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the number of subframes to be measured. This value is expressed in subframe.

Returns:

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

Return type:

int

set_measurement_offset(selector_string, value)

Sets the measurement offset to skip from the frame boundary or the marker (external trigger) location. This value is expressed in 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 0.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the measurement offset to skip from the frame boundary or the marker (external trigger) location. This value is expressed in subframe.

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)

Sets whether the spectrum of the measured signal is inverted. The inversion happens when the I and the Q components of the baseband complex signal are swapped.

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 of the measured signal is not inverted.
True (1)	The measured signal is inverted and the measurement corrects the signal by swapping the I and the Q components.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.SlotPowerSpectrumInverted, int) – Specifies whether the spectrum of the measured signal is inverted. The inversion happens when the I and the Q components of the baseband complex signal are swapped.

Returns:

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

Return type:

int