SlotPhaseConfiguration

Provides methods to configure the SlotPhase measurement.

class nirfmxcdma2k.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, Measurement Offset, and Measurement Length parameters 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 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 specified by the Measurement Length parameter starting at the Measurement Offset slots from the frame boundary.

    Slot (1)

    The slot boundary is detected, and the measurement is performed over the number of slots specified by the Measurement Length parameter starting at the 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.

  • measurement_length (int) – This parameter specifies the duration of the SlotPhase measurement. This value is expressed in slots. The default value is 16.

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

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. The synchronization boundary is specified by the SLOTPHASE_SYNCHRONIZATION_MODE attribute. 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 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the measurement offset to skip from the synchronization boundary. The synchronization boundary is specified by the SLOTPHASE_SYNCHRONIZATION_MODE attribute. 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_receive_filter_enabled(selector_string)[source]

Gets whether to enable the received filter for the SlotPhase measurement. Use this attribute to disable the filter, if the received signal is already 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 received filtering for the SlotPhase measurement.

True (1)

Enables received filtering for the SlotPhase measurement.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SlotPhaseReceiveFilterEnabled):

Specifies whether to enable the received filter for the SlotPhase measurement. Use this attribute to disable the filter, if the received signal is already 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 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 measured spectrum is not inverted.

True (1)

The measured spectrum is inverted.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SlotPhaseSpectrumInverted):

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)

get_synchronization_mode(selector_string)[source]

Gets whether the measurement is performed from the frame or 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 specified by the SlotPhase Meas Length attribute starting at the SlotPhase measurement offset slots from the frame boundary.

Slot (1)

The slot boundary is detected, and the measurement is performed over the number of slots specified by the SlotPhase Meas Length attribute starting at the SlotPhase measurement 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 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_duration(selector_string)[source]

Gets the region to exclude for computing the individual slot phase discontinuity values. This value is expressed in seconds.

The transient duration is applied equally on either side of a slot boundary, that is at the start and end of each slot. If you set the transient duration to zero, there is no transient period and the entire slot data is used to determine the phase error best fit line which is used to compute the phase discontinuity at the slot boundaries.

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 0 to 0.0002, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the region to exclude for computing the individual slot phase discontinuity values. 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)

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

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. The synchronization boundary is specified by the SLOTPHASE_SYNCHRONIZATION_MODE attribute. 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 0.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the measurement offset to skip from the synchronization boundary. The synchronization boundary is specified by the SLOTPHASE_SYNCHRONIZATION_MODE attribute. 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_receive_filter_enabled(selector_string, value)[source]

Sets whether to enable the received filter for the SlotPhase measurement. Use this attribute to disable the filter, if the received signal is already 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 received filtering for the SlotPhase measurement.

True (1)

Enables received filtering for the SlotPhase measurement.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.SlotPhaseReceiveFilterEnabled, int) – Specifies whether to enable the received filter for the SlotPhase measurement. Use this attribute to disable the filter, if the received signal is already 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 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 measured spectrum is not inverted.

True (1)

The measured 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 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 specified by the SlotPhase Meas Length attribute starting at the SlotPhase measurement offset slots from the frame boundary.

Slot (1)

The slot boundary is detected, and the measurement is performed over the number of slots specified by the SlotPhase Meas Length attribute starting at the SlotPhase measurement offset slots from the slot boundary.
Parameters:
Returns:

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

Return type:

int

set_transient_duration(selector_string, value)[source]

Sets the region to exclude for computing the individual slot phase discontinuity values. This value is expressed in seconds.

The transient duration is applied equally on either side of a slot boundary, that is at the start and end of each slot. If you set the transient duration to zero, there is no transient period and the entire slot data is used to determine the phase error best fit line which is used to compute the phase discontinuity at the slot boundaries.

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 0 to 0.0002, inclusive.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the region to exclude for computing the individual slot phase discontinuity values. 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