SlotPhaseConfiguration

Provides methods to configure the SlotPhase measurement.

class nirfmxlte.slotphase_configuration.SlotPhaseConfiguration(signal_obj)

Bases: object

Provides methods to configure the SlotPhase measurement.

configure_synchronization_mode_and_interval(selector_string, synchronization_mode, measurement_offset, measurement_length)

Configures the Synchronization Mode, Measurement Offset, and Measurement Length parameters of SlotPhase measurement.

Parameters:

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

• synchronization_mode (enums.SlotPhaseSynchronizationMode, int) –

  This parameter specifies whether the measurement is performed from the frame or the slot boundary. The default value is Slot.

  Name (Value)	Description
  Frame (0)	The frame boundary in the acquired signal is detected, and the measurement is performed over the number of slots specified by the Measurement Length parameter, starting at the offset from the boundary specified by the Measurement Offset parameter. When you set the Trigger Type attribute to Digital Edge, the measurement expects a trigger at the frame boundary.
  Slot (1)	The slot boundary the acquired signal is detected, and the measurement is performed over the number of slots specified by the Measurement Length parameter, starting at the offset from the boundary specified by the Measurement Offset parameter. When you set the Trigger Type attribute to Digital Edge, the measurement expects a trigger at any slot boundary.

• measurement_offset (int) – This parameter specifies the measurement offset to skip from the synchronization boundary. The synchronization boundary is specified by the Synchronization Mode parameter. This value is expressed in slots. The default value is 0. Valid values are 0 to 19, inclusive.

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

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 SlotPhase 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 SlotPhase 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 local oscillator and the digital-to-analog converter. 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.SlotPhaseCommonClockSourceEnabled):

Specifies whether the same Reference Clock is used for local oscillator and the digital-to-analog converter. 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_exclusion_period_enabled(selector_string)

Gets whether to exclude some portions of the slots when calculating the phase. This attribute is valid only when there is a power change at the slot boundary. Refer to section 6.5.2.1A of the 3GPP 36.521-1 specification for more information about the exclusion.

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)	Phase is calculated on complete slots.
True (1)	Phase is calculated on truncated slots. The power changes at the slot boundaries are detected by the measurement, and the defined 3GPP specification period is excluded from the slots being measured.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SlotPhaseExclusionPeriodEnabled):

Specifies whether to exclude some portions of the slots when calculating the phase. This attribute is valid only when there is a power change at the slot boundary. Refer to section 6.5.2.1A of the 3GPP 36.521-1 specification for more information about the exclusion.

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 SlotPhase 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 SlotPhase 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 slots to be measured. This value is expressed in slots.

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 20.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

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

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 synchronization boundary. This value is expressed in slots. The synchronization boundary is specified by the SLOTPHASE_SYNCHRONIZATION_MODE 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.

The default value is 0. Valid values are 0 to 19, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the measurement offset to skip from the synchronization boundary. This value is expressed in slots. The synchronization boundary is specified by the SLOTPHASE_SYNCHRONIZATION_MODE 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_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.SlotPhaseSpectrumInverted):

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)

get_synchronization_mode(selector_string)

Gets whether the measurement is performed from the frame or the slot boundary.

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 Slot.

Name (Value)	Description
Frame (0)	The frame boundary in the acquired signal is detected, and the measurement is performed over the number of slots specified by the SlotPhase Meas Length attribute, starting at the offset from the boundary specified by the SlotPhase Meas Offset attribute. When the Trigger Type attribute is set to Digital, the measurement expects a trigger at the frame boundary.
Slot (1)	The slot boundary in the acquired signal is detected, and the measurement is performed over the number of slots specified by the SlotPhase Meas Length attribute, starting at the offset from the boundary specified by the SlotPhase Meas Offset attribute. When the Trigger Type attribute is set to Digital, the measurement expects a trigger at any slot boundary.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SlotPhaseSynchronizationMode):

Specifies whether the measurement is performed from the frame or the slot boundary.

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 SlotPhase 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 SlotPhase 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 local oscillator and the digital-to-analog converter. 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.SlotPhaseCommonClockSourceEnabled, int) – Specifies whether the same Reference Clock is used for local oscillator and the digital-to-analog converter. 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_exclusion_period_enabled(selector_string, value)

Sets whether to exclude some portions of the slots when calculating the phase. This attribute is valid only when there is a power change at the slot boundary. Refer to section 6.5.2.1A of the 3GPP 36.521-1 specification for more information about the exclusion.

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)	Phase is calculated on complete slots.
True (1)	Phase is calculated on truncated slots. The power changes at the slot boundaries are detected by the measurement, and the defined 3GPP specification period is excluded from the slots being measured.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.SlotPhaseExclusionPeriodEnabled, int) – Specifies whether to exclude some portions of the slots when calculating the phase. This attribute is valid only when there is a power change at the slot boundary. Refer to section 6.5.2.1A of the 3GPP 36.521-1 specification for more information about the exclusion.

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 SlotPhase 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 SlotPhase 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 slots to be measured. This value is expressed in slots.

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 20.

Parameters:

• selector_string (string) – Pass an empty string.

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

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 synchronization boundary. This value is expressed in slots. The synchronization boundary is specified by the SLOTPHASE_SYNCHRONIZATION_MODE 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.

The default value is 0. Valid values are 0 to 19, inclusive.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the measurement offset to skip from the synchronization boundary. This value is expressed in slots. The synchronization boundary is specified by the SLOTPHASE_SYNCHRONIZATION_MODE attribute.

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.SlotPhaseSpectrumInverted, 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

set_synchronization_mode(selector_string, value)

Sets whether the measurement is performed from the frame or the slot boundary.

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 Slot.

Name (Value)	Description
Frame (0)	The frame boundary in the acquired signal is detected, and the measurement is performed over the number of slots specified by the SlotPhase Meas Length attribute, starting at the offset from the boundary specified by the SlotPhase Meas Offset attribute. When the Trigger Type attribute is set to Digital, the measurement expects a trigger at the frame boundary.
Slot (1)	The slot boundary in the acquired signal is detected, and the measurement is performed over the number of slots specified by the SlotPhase Meas Length attribute, starting at the offset from the boundary specified by the SlotPhase Meas Offset attribute. When the Trigger Type attribute is set to Digital, the measurement expects a trigger at any slot boundary.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.SlotPhaseSynchronizationMode, int) – Specifies whether the measurement is performed from the frame or the slot boundary.

Returns:

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

Return type:

int