PavtConfiguration

Provides methods to configure the Pavt measurement.

class nirfmxspecan.pavt_configuration.PavtConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the Pavt measurement.

configure_measurement_bandwidth(selector_string, measurement_bandwidth)[source]

Configures the measurement bandwidth.

Parameters:

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

  • measurement_bandwidth (float) – This parameter specifies the bandwidth over which the signal is measured. This value is expressed in Hz. The default value is 10 MHz.

Returns:

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

Return type:

int

configure_measurement_interval(selector_string, measurement_offset, measurement_length)[source]

Configures the measurement offset and measurement length for the segments.

Parameters:

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

  • measurement_offset (float) – This parameter specifies the time offset from the start of the segment for which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid only when you set the MEASUREMENT_INTERVAL_MODE attribute to Uniform. The default value is 0.

  • measurement_length (float) – This parameter specifies the duration within each segment over which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid when you set the MEASUREMENT_INTERVAL_MODE attribute to Uniform. The default value is 1 millisecond.

Returns:

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

Return type:

int

configure_measurement_interval_mode(selector_string, measurement_interval_mode)[source]

Configures the measurement interval mode.

Parameters:

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

  • measurement_interval_mode (enums.PavtMeasurementIntervalMode, int) –

    This parameter specifies the mode of configuring the measurement interval. The default value is Uniform.

    Name (Value)

    Description

    Uniform (0)

    The time offset from the start of segment and the duration over which the measurement is performed is uniform for all segments and is given by the PAVT Meas Offset attribute and the PAVT Meas Length attribute respectively.

    Variable (1)

    The time offset from the start of segment and the duration over which the measurement is performed is configured separately for each segment and is given by the PAVT Segment Meas Offset attribute and the PAVT Segment Meas Length attribute respectively.

Returns:

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

Return type:

int

configure_measurement_location_type(selector_string, measurement_location_type)[source]

Configures the measurement location type for the segments.

Parameters:

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

  • measurement_location_type (enums.PavtMeasurementLocationType, int) –

    This parameter specifies whether the location at which the segment is measured is indicated by time or trigger. The default value is Time.

    Name (Value)

    Description

    Time (0)

    The measurement is performed over a single record across multiple segments separated in time. The measurement locations of the segments are specified by the PAVT Segment Start Time attribute. The number of segments is equal to the number of segment start times.

    Trigger (1)

    The measurement is performed across segments obtained in multiple records, where each record is obtained when a trigger is received. The number of segments is equal to the number of triggers (records).

Returns:

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

Return type:

int

configure_number_of_segments(selector_string, number_of_segments)[source]

Configures the number of segments.

Parameters:

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

  • number_of_segments (int) – This parameter specifies the number of segments to be measured. The default 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

configure_segment_measurement_interval(selector_string, segment_measurement_offset, segment_measurement_length)[source]

Configures the segment measurement offset and length for the segments.

Parameters:

  • selector_string (string) –

    This parameter specifies a Selector String comprising of segment number.

    Example:

    ”segment0”

    You can use the build_segment_string() method to build the selector string.

  • segment_measurement_offset (float) – This parameter specifies the time offset from the start of the segment for which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid only when you set the MEASUREMENT_INTERVAL_MODE attribute to Variable. The default value is 0.

  • segment_measurement_length (float) – This parameter specifies the duration within each segment over which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid when you set the MEASUREMENT_INTERVAL_MODE attribute to Variable. The default value is 1 millisecond.

Returns:

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

Return type:

int

configure_segment_measurement_interval_array(selector_string, segment_measurement_offset, segment_measurement_length)[source]

Configures an array of segment measurement offsets and lengths for the segments.

Parameters:

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

  • segment_measurement_offset (float) – This parameter specifies the time offset from the start of the segment for which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid only when you set the MEASUREMENT_INTERVAL_MODE attribute to Variable. The default value is 0.

  • segment_measurement_length (float) – This parameter specifies the duration within each segment over which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid when you set the MEASUREMENT_INTERVAL_MODE attribute to Variable. The default value is 1 millisecond.

Returns:

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

Return type:

int

configure_segment_start_time_list(selector_string, segment_start_time)[source]

Configures the list of the segment start times.

Parameters:

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

  • segment_start_time (float) – This parameter specifies the start time of measurement of the segments. This value is expressed in seconds. You can use this parameter only when you set the MEASUREMENT_LOCATION_TYPE attribute to Time.

Returns:

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

Return type:

int

configure_segment_start_time_step(selector_string, number_of_segments, segment0_start_time, segment_interval)[source]

Configures the list of the segment start times based on Segment0 Start Time and Segment Interval. This method is used when the segments to be measured have equal duration.

Parameters:

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

  • number_of_segments (int) – This parameter specifies the number of segments to be measured. The default value is 1.

  • segment0_start_time (float) – This parameter specifies the start time for segment0. This value is expressed in seconds.

  • segment_interval (float) – This parameter specifies the difference in the start times between consecutive segments. 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

configure_segment_type(selector_string, segment_type)[source]

Configures the segment type.

Parameters:

  • selector_string (string) –

    This parameter specifies a Selector String comprising of segment number.

    Example:

    ”segment0”

    You can use the build_segment_string() method to build the selector string.

  • segment_type (enums.PavtSegmentType, int) –

    This parameter specifies the type of segment. The default value is Phase and Amplitude.

    Name (Value)

    Description

    Phase and Amplitude (0)

    Phase and amplitude is measured in this segment.

    Amplitude (1)

    Amplitude is measured in this segment.

    Frequency Error Measurement (2)

    Frequency error is measured in this segment.

Returns:

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

Return type:

int

configure_segment_type_array(selector_string, segment_type)[source]

Configures an array of segment types.

Parameters:

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

  • segment_type (enums.PavtSegmentType, int) –

    This parameter specifies the type of segment. The default value is Phase and Amplitude.

    Name (Value)

    Description

    Phase and Amplitude (0)

    Phase and amplitude is measured in this segment.

    Amplitude (1)

    Amplitude is measured in this segment.

    Frequency Error Measurement (2)

    Frequency error is measured in this segment.

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

Gets whether to enable frequency offset correction for the 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.

Name (Value)

Description

False (0)

Disables the frequency offset correction.

True (1)

Enables the frequency offset correction. The measurement computes and corrects any frequency offset between the reference and the acquired waveforms.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PavtFrequencyOffsetCorrectionEnabled):

Specifies whether to enable frequency offset correction for the 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_frequency_tracking_enabled(selector_string)[source]

Gets whether to enable frequency offset correction per segment for the measurement. While you set this attribute to True, ensure that the FREQUENCY_OFFSET_CORRECTION_ENABLED attribute is set to True and the SEGMENT_TYPE attribute is set to Phase and Amplitude.

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)

Disables the drift correction for the measurement.

True (1)

Enables the drift correction. The measurement corrects and reports the frequency offset per segment.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PavtFrequencyTrackingEnabled):

Specifies whether to enable frequency offset correction per segment for the measurement. While you set this attribute to True, ensure that the FREQUENCY_OFFSET_CORRECTION_ENABLED attribute is set to True and the SEGMENT_TYPE attribute is set to Phase and Amplitude.

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

Gets the bandwidth over which the signal is measured. This value is expressed in Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the bandwidth over which the signal is measured. This value is expressed in Hz.

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 Phase Amplitude Versus Time (PAVT) 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 Phase Amplitude Versus Time (PAVT) 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_interval_mode(selector_string)[source]

Gets the mode of configuring the measurement interval.

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

Name (Value)

Description

Uniform (0)

The time offset from the start of segment and the duration over which the measurement is performed is uniform for all segments and is given by the PAVT Meas Offset attribute and the PAVT Meas Length attribute respectively.

Variable (1)

The time offset from the start of segment and the duration over which the measurement is performed is configured separately for each segment and is given by the PAVT Segment Meas Offset attribute and the PAVT Segment Meas Length attribute respectively.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PavtMeasurementIntervalMode):

Specifies the mode of configuring the measurement interval.

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 within the segment over which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid only when you set the MEASUREMENT_INTERVAL_MODE attribute to Uniform.

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 1 millisecond.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the duration within the segment over which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid only when you set the MEASUREMENT_INTERVAL_MODE attribute to Uniform.

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

Gets whether the location at which the segment is measured is indicated by time or trigger.

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

Name (Value)

Description

Time (0)

The measurement is performed over a single record across multiple segments separated in time. The measurement locations of the segments are specified by the PAVT Segment Start Time attribute. The number of segments is equal to the number of segment start times.

Trigger (1)

The measurement is performed across segments obtained in multiple records, where each record is obtained when a trigger is received. The number of segments is equal to the number of triggers (records).
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PavtMeasurementLocationType):

Specifies whether the location at which the segment is measured is indicated by time or trigger.

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 time offset from the start of the segment for which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid only when you set the MEASUREMENT_INTERVAL_MODE attribute to Uniform.

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 (float):

Specifies the time offset from the start of the segment for which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid only when you set the MEASUREMENT_INTERVAL_MODE attribute to Uniform.

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

Gets the number of segments to be measured.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the number of segments to be measured.

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

Gets whether the phase measurement results are unwrapped or wrapped.

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)

Phase measurement results are wrapped within +/-180 degrees.

True (1)

Phase measurement results are unwrapped.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PavtPhaseUnwrapEnabled):

Specifies whether the phase measurement results are unwrapped or wrapped.

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

Gets the duration within each segment over which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid when you set the MEASUREMENT_INTERVAL_MODE attribute to Variable.

Use “segment<n>” as the Selector String to configure or read this attribute.

The default value is 1 millisecond.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the duration within each segment over which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid when you set the MEASUREMENT_INTERVAL_MODE attribute to Variable.

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

Gets the time offset from the start of the segment for which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid only when you set the MEASUREMENT_INTERVAL_MODE attribute to Variable.

Use “segment<n>” as the Selector String to configure or read this attribute.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the time offset from the start of the segment for which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid only when you set the MEASUREMENT_INTERVAL_MODE attribute to Variable.

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

Gets the start time of measurement of the segments. This value is expressed in seconds. You can use this attribute only when you set the MEASUREMENT_LOCATION_TYPE attribute to Time.

Use “segment<n>” as the Selector String to configure or read this attribute.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the start time of measurement of the segments. This value is expressed in seconds. You can use this attribute only when you set the MEASUREMENT_LOCATION_TYPE attribute to Time.

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

Gets the type of segment.

Use “segment<n>” as the Selector String to configure or read this attribute.

The default value is Phase and Amplitude.

Name (Value)

Description

Phase and Amplitude (0)

Phase and amplitude is measured in this segment.

Amplitude (1)

Amplitude is measured in this segment.

Frequency Error Measurement (2)

Frequency error is measured in this segment.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PavtSegmentType):

Specifies the type of segment.

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 PAVT 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 PAVT measurement.

Returns:

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

Return type:

int

set_frequency_offset_correction_enabled(selector_string, value)[source]

Sets whether to enable frequency offset correction for the 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.

Name (Value)

Description

False (0)

Disables the frequency offset correction.

True (1)

Enables the frequency offset correction. The measurement computes and corrects any frequency offset between the reference and the acquired waveforms.
Parameters:
Returns:

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

Return type:

int

set_frequency_tracking_enabled(selector_string, value)[source]

Sets whether to enable frequency offset correction per segment for the measurement. While you set this attribute to True, ensure that the FREQUENCY_OFFSET_CORRECTION_ENABLED attribute is set to True and the SEGMENT_TYPE attribute is set to Phase and Amplitude.

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)

Disables the drift correction for the measurement.

True (1)

Enables the drift correction. The measurement corrects and reports the frequency offset per segment.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.PavtFrequencyTrackingEnabled, int) – Specifies whether to enable frequency offset correction per segment for the measurement. While you set this attribute to True, ensure that the FREQUENCY_OFFSET_CORRECTION_ENABLED attribute is set to True and the SEGMENT_TYPE attribute is set to Phase and Amplitude.

Returns:

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

Return type:

int

set_measurement_bandwidth(selector_string, value)[source]

Sets the bandwidth over which the signal is measured. This value is expressed in Hz.

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

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the bandwidth over which the signal is measured. This value is expressed in Hz.

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 Phase Amplitude Versus Time (PAVT) 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 Phase Amplitude Versus Time (PAVT) 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_interval_mode(selector_string, value)[source]

Sets the mode of configuring the measurement interval.

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

Name (Value)

Description

Uniform (0)

The time offset from the start of segment and the duration over which the measurement is performed is uniform for all segments and is given by the PAVT Meas Offset attribute and the PAVT Meas Length attribute respectively.

Variable (1)

The time offset from the start of segment and the duration over which the measurement is performed is configured separately for each segment and is given by the PAVT Segment Meas Offset attribute and the PAVT Segment Meas Length attribute respectively.
Parameters:
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 within the segment over which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid only when you set the MEASUREMENT_INTERVAL_MODE attribute to Uniform.

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 1 millisecond.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the duration within the segment over which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid only when you set the MEASUREMENT_INTERVAL_MODE attribute to Uniform.

Returns:

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

Return type:

int

set_measurement_location_type(selector_string, value)[source]

Sets whether the location at which the segment is measured is indicated by time or trigger.

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

Name (Value)

Description

Time (0)

The measurement is performed over a single record across multiple segments separated in time. The measurement locations of the segments are specified by the PAVT Segment Start Time attribute. The number of segments is equal to the number of segment start times.

Trigger (1)

The measurement is performed across segments obtained in multiple records, where each record is obtained when a trigger is received. The number of segments is equal to the number of triggers (records).
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.PavtMeasurementLocationType, int) – Specifies whether the location at which the segment is measured is indicated by time or trigger.

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 time offset from the start of the segment for which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid only when you set the MEASUREMENT_INTERVAL_MODE attribute to Uniform.

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 (float) – Specifies the time offset from the start of the segment for which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid only when you set the MEASUREMENT_INTERVAL_MODE attribute to Uniform.

Returns:

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

Return type:

int

set_number_of_segments(selector_string, value)[source]

Sets the number of segments to be measured.

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

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the number of segments to be measured.

Returns:

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

Return type:

int

set_phase_unwrap_enabled(selector_string, value)[source]

Sets whether the phase measurement results are unwrapped or wrapped.

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)

Phase measurement results are wrapped within +/-180 degrees.

True (1)

Phase measurement results are unwrapped.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.PavtPhaseUnwrapEnabled, int) – Specifies whether the phase measurement results are unwrapped or wrapped.

Returns:

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

Return type:

int

set_segment_measurement_length(selector_string, value)[source]

Sets the duration within each segment over which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid when you set the MEASUREMENT_INTERVAL_MODE attribute to Variable.

Use “segment<n>” as the Selector String to configure or read this attribute.

The default value is 1 millisecond.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the duration within each segment over which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid when you set the MEASUREMENT_INTERVAL_MODE attribute to Variable.

Returns:

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

Return type:

int

set_segment_measurement_offset(selector_string, value)[source]

Sets the time offset from the start of the segment for which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid only when you set the MEASUREMENT_INTERVAL_MODE attribute to Variable.

Use “segment<n>” as the Selector String to configure or read this attribute.

The default value is 0.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the time offset from the start of the segment for which the phase and amplitude, amplitude, or frequency error values are computed. This value is expressed in seconds. This attribute is valid only when you set the MEASUREMENT_INTERVAL_MODE attribute to Variable.

Returns:

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

Return type:

int

set_segment_start_time(selector_string, value)[source]

Sets the start time of measurement of the segments. This value is expressed in seconds. You can use this attribute only when you set the MEASUREMENT_LOCATION_TYPE attribute to Time.

Use “segment<n>” as the Selector String to configure or read this attribute.

The default value is 0.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the start time of measurement of the segments. This value is expressed in seconds. You can use this attribute only when you set the MEASUREMENT_LOCATION_TYPE attribute to Time.

Returns:

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

Return type:

int

set_segment_type(selector_string, value)[source]

Sets the type of segment.

Use “segment<n>” as the Selector String to configure or read this attribute.

The default value is Phase and Amplitude.

Name (Value)

Description

Phase and Amplitude (0)

Phase and amplitude is measured in this segment.

Amplitude (1)

Amplitude is measured in this segment.

Frequency Error Measurement (2)

Frequency error is measured in this segment.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.PavtSegmentType, int) – Specifies the type of segment.

Returns:

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

Return type:

int