SlotPhaseConfiguration

Provides methods to configure the SlotPhase measurement.

class nirfmxwcdma.slotphase_configuration.SlotPhaseConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the SlotPhase measurement.

configure_synchronization_mode_and_interval(selector_string, synchronization_mode, measurement_offset, measurement_length)[source]

Configures the synchronization mode, the measurement offset, and the measurement length of the 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 is detected, and the measurement is performed over the number of slots expressed by the Measurement Length parameter starting at Measurement Offset slots from the frame boundary.

    Slot (1)

    The slot boundary is detected and the measurement is performed over the number of slots expressed by the Measurement Length parameter starting at Measurement Offset slots from the slot boundary.

  • measurement_offset (int) –

    This parameter specifies the measurement offset to skip from the synchronization boundary. This value is expressed in slots. The synchronization boundary is specified by the Synchronization Mode parameter.

    The default value is 0. The valid values are any value greater than or equal to 0.

  • measurement_length (int) –

    This parameter specifies the duration of the SlotPhase measurement. This value is expressed in slots.

    The default value is 15. The valid values are any value greater than or equal to 1.

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

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

Gets the duration of the SlotPhase measurement. 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 15. The valid values are any value greater than or equal to 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the duration of the SlotPhase measurement. 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)[source]

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. The valid values are any value greater than or equal to 0.

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_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.SlotPhaseRrcFilterEnabled):

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

Gets whether the signal spectrum 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.SlotPhaseSpectrumInverted):

Specifies whether the signal spectrum 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)

get_synchronization_mode(selector_string)[source]

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 is detected, and the measurement is performed over the number of slots expressed by the SlotPhase Meas Length attribute starting at SlotPhase Meas Offset slots from the frame boundary.

Slot (1)

The slot boundary is detected and the measurement is performed over the number of slots expressed by the SlotPhase Meas Length attribute starting at SlotPhase Meas Offset slots from the 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)

get_transient_removal_enabled(selector_string)[source]

Gets whether the SlotPhase measurement excludes 25 microseconds from the start and end of each slot while computing the linear-fit chip phase error, which is used to compute phase discontinuities at the slot boundaries.

Transients are expected to be present at the slot boundaries, where the mean power of the received signal can change.

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 measurement considers an entire slot for the chip phase error linear-fit calculation, which is used to compute the phase discontinuity at the slot boundaries.

True (1)

The measurement considers each slot excluding 25 microseconds at the start and end of the slot, for the chip phase error linear-fit line calculation, which is extrapolated to compute the phase discontinuity at the slot boundaries.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SlotPhaseTransientRemovalEnabled):

Specifies whether the SlotPhase measurement excludes 25 microseconds from the start and end of each slot while computing the linear-fit chip phase error, which is used to compute phase discontinuities at the slot boundaries.

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

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

Sets the duration of the SlotPhase measurement. 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 15. The valid values are any value greater than or equal to 1.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the duration of the SlotPhase measurement. 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)[source]

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. The valid values are any value greater than or equal to 0.

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_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.SlotPhaseRrcFilterEnabled, 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

set_spectrum_inverted(selector_string, value)[source]

Sets whether the signal spectrum 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:
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)[source]

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 is detected, and the measurement is performed over the number of slots expressed by the SlotPhase Meas Length attribute starting at SlotPhase Meas Offset slots from the frame boundary.

Slot (1)

The slot boundary is detected and the measurement is performed over the number of slots expressed by the SlotPhase Meas Length attribute starting at SlotPhase Meas Offset slots from the 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

set_transient_removal_enabled(selector_string, value)[source]

Sets whether the SlotPhase measurement excludes 25 microseconds from the start and end of each slot while computing the linear-fit chip phase error, which is used to compute phase discontinuities at the slot boundaries.

Transients are expected to be present at the slot boundaries, where the mean power of the received signal can change.

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 measurement considers an entire slot for the chip phase error linear-fit calculation, which is used to compute the phase discontinuity at the slot boundaries.

True (1)

The measurement considers each slot excluding 25 microseconds at the start and end of the slot, for the chip phase error linear-fit line calculation, which is extrapolated to compute the phase discontinuity at the slot boundaries.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.SlotPhaseTransientRemovalEnabled, int) – Specifies whether the SlotPhase measurement excludes 25 microseconds from the start and end of each slot while computing the linear-fit chip phase error, which is used to compute phase discontinuities at the slot boundaries.

Returns:

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

Return type:

int