PulseConfiguration

Provides methods to configure the Pulse measurement.

class nirfmxpulse.pulse_measurement_configuration.PulseConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the Pulse measurement.

configure_1_reference_waveform(selector_string, x0, dx, reference_waveform)[source]

Configures the reference pulse waveform used for time sidelobe measurements.

Parameters:

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

  • x0 (float) – This parameter specifies the starting time of the reference waveform. This value is expressed in seconds.

  • dx (float) – This parameter specifies the sampling interval of the reference waveform. This value is expressed in seconds.

  • reference_waveform (numpy.complex64) – This parameter specifies an array of waveform samples of the reference waveform.

Returns:

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

Return type:

int

get_acquisition_trace_select(selector_string)[source]

Gets the mode to select all pulses or the subset of acquired pulses available for display acquisition trace, limited to MAXIMUM_PULSE_COUNT_ENABLED attribute if set to True.

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

Name (Value)

Description

All Pulses (0)

Selects all the acquired pulses.

Subset (1)
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PulseAcquisitionTraceSelect):

Specifies the mode to select all pulses or the subset of acquired pulses available for display acquisition trace, limited to MAXIMUM_PULSE_COUNT_ENABLED attribute if set to True.

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

Gets the total number of pulses starting from offset to be used for display acquisition trace. You must configure this attribute when you set the PULSE_ACQUISITION_TRACE_SELECT attribute to Subset.

Set length to 0 to disable the acquisition trace.

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. Valid values are 0 to 10000, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the total number of pulses starting from offset to be used for display acquisition trace. You must configure this attribute when you set the PULSE_ACQUISITION_TRACE_SELECT attribute to Subset.

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

Gets the offset in number of pulses to be used for display acquisition trace. You must configure this attribute when you set the PULSE_ACQUISITION_TRACE_SELECT attribute to Subset.

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 9999, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the offset in number of pulses to be used for display acquisition trace. You must configure this attribute when you set the PULSE_ACQUISITION_TRACE_SELECT attribute to Subset.

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

Gets whether to enable storing and retrieving traces after performing the measurements.

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 storing and retrieving traces after performing the measurements.

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

Gets whether voltage or power to be used as domain for pulse measurements.

The level thresholds are considered with a specified domain that impacts the timing results and level results such as droop, overshoot and ripple.

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

Name (Value)

Description

Volts (0)

All threshold levels are calculated in the voltage domain.

Watts (1)

All threshold levels are calculated in the power domain.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PulseAmplitudeLevelDomain):

Specifies whether voltage or power to be used as domain for pulse measurements.

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

Gets the unit of the amplitude level. This attribute is applicable only for the amplitude and acquired amplitude trace.

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

Name (Value)

Description

dBm (0)

Amplitude trace is expressed in dBm.

Volts (1)

Amplitude trace is expressed in Volts.

Watts (2)

Amplitude trace is expressed in Watts.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PulseAmplitudeTraceUnit):

Specifies the unit of the amplitude level. This attribute is applicable only for the amplitude and acquired amplitude trace.

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

Gets the hysteresis for pulse detection in dB for the defined threshold.

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. Valid values are 0 to 50, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the hysteresis for pulse detection in dB for the defined threshold.

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

Gets the maximum pulse width time to be considered for pulse detection. Any detected pulse width time above the specified value will be ignored by the pulse detection. This value is expressed in seconds.

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.005 seconds.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the maximum pulse width time to be considered for pulse detection. Any detected pulse width time above the specified value will be ignored by the pulse detection. 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)

get_detection_minimum_off_duration(selector_string)[source]

Gets the minimum pulse off duration to be ignored by the pulse detection. This value is expressed in seconds.

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.00000005. Valid values are 0 to 0.001, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the minimum pulse off duration to be ignored by the pulse detection. 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)

get_detection_minimum_width(selector_string)[source]

Gets the minimum pulse width time to be considered for pulse detection. Any detected pulse width time below the specified value will be ignored by the pulse detection. This value is expressed in seconds.

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.00000005 seconds.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the minimum pulse width time to be considered for pulse detection. Any detected pulse width time below the specified value will be ignored by the pulse detection. 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)

get_detection_reference(selector_string)[source]

Gets the reference used for PULSE_DETECTION_THRESHOLD 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 Ref Level.

Name (Value)

Description

Ref Level (0)

The threshold is relative to the reference level of the samples.

Absolute (1)

The threshold is the absolute power, in dBm.

Peak (2)

The threshold is relative to the peak level of the samples.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PulseDetectionReference):

Specifies the reference used for PULSE_DETECTION_THRESHOLD 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_detection_threshold(selector_string)[source]

Gets the threshold used for pulse detection. The unit dB or dBm is based on the value you set to the PULSE_DETECTION_REFERENCE 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 -20. Valid values are -100 to 100, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the threshold used for pulse detection. The unit dB or dBm is based on the value you set to the PULSE_DETECTION_REFERENCE 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_droop_compensation_enabled(selector_string)[source]

Gets whether to compensate the droop detected in pulse level when applying thresholds.

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)

Droop Compensation is disabled.

True (1)

Droop Compensation is enabled.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PulseDroopCompensationEnabled):

Specifies whether to compensate the droop detected in pulse level when applying thresholds.

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

Gets to manually enter the CW frequency offset. This attribute is valid only when you set the PULSE_FREQUENCY_AND_PHASE_MODULATION_TYPE attribute to CW.

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 to manually enter the CW frequency offset. This attribute is valid only when you set the PULSE_FREQUENCY_AND_PHASE_MODULATION_TYPE attribute to CW.

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

Gets whether the CW frequency offset computation of every detected pulse is automatic or manual. This attribute is valid only when you set the PULSE_FREQUENCY_AND_PHASE_MODULATION_TYPE attribute to CW.

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)

CW frequency offset computation is set to manual.

True (1)

CW frequency offset computation is set to automatic.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PulseCWFrequencyOffsetAuto):

Specifies whether the CW frequency offset computation of every detected pulse is automatic or manual. This attribute is valid only when you set the PULSE_FREQUENCY_AND_PHASE_MODULATION_TYPE attribute to CW.

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

Gets the start of the pulse data used for the phase/frequency deviation and error measurements when you set the PULSE_FREQUENCY_AND_PHASE_DEVIATION_RANGE_REFERENCE attribute to Edge.

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 start of the pulse data used for the phase/frequency deviation and error measurements when you set the PULSE_FREQUENCY_AND_PHASE_DEVIATION_RANGE_REFERENCE attribute to Edge.

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

Gets the stop of the pulse data used for the phase/frequency deviation and error measurements when you set the PULSE_FREQUENCY_AND_PHASE_DEVIATION_RANGE_REFERENCE attribute to Edge.

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 stop of the pulse data used for the phase/frequency deviation and error measurements when you set the PULSE_FREQUENCY_AND_PHASE_DEVIATION_RANGE_REFERENCE attribute to Edge.

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

Gets the length of the pulse data used for the phase/frequency deviation and error measurements when you set the PULSE_FREQUENCY_AND_PHASE_DEVIATION_RANGE_REFERENCE attribute to Center.

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 75. Valid values are 0 to 100, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the length of the pulse data used for the phase/frequency deviation and error measurements when you set the PULSE_FREQUENCY_AND_PHASE_DEVIATION_RANGE_REFERENCE attribute to Center.

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

Gets the reference used for the measurement range in phase/frequency deviation and error measurements.

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

Name (Value)

Description

Edge (0)

Specifies the range with respect to the edges of the pulse.

Center (1)

Specifies the range with respect to the center of the pulse.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PulseFrequencyAndPhaseDeviationRangeReference):

Specifies the reference used for the measurement range in phase/frequency deviation and error measurements.

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

Gets the pulse modulation type used for the phase and frequency error, and pulsed FM 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 CW.

Name (Value)

Description

CW (0)

Continous wave where the frequency remains constant over pulse ON duration.

Linear FM (1)

Frequency varies linearly within pulse ON duration.

Triangular FM (2)

Frequency varies with two lienar FM chirps with opposite slopes within pulse ON duration.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PulseModulationType):

Specifies the pulse modulation type used for the phase and frequency error, and pulsed FM 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_level_computation_method(selector_string)[source]

Gets the algorithm used to detect the pulse levels. The algorithm is based on the histogram method of level detection as defined in IEEE Std 181-2011.

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

Name (Value)

Description

Mean (0)

The levels derived as the pulse sub-histogram mean levels.

Median (1)

The levels derived as the pulse sub-histogram median levels.

Mode (2)

The levels derived as the pulse sub-histogram mode levels.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PulseLevelComputationMethod):

Specifies the algorithm used to detect the pulse levels. The algorithm is based on the histogram method of level detection as defined in IEEE Std 181-2011.

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

Gets the lower threshold level as a percentage of the pulse amplitude used to signify the start of a rising or end of a falling edge.

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. Valid values are 0 to 100, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the lower threshold level as a percentage of the pulse amplitude used to signify the start of a rising or end of a falling edge.

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 pulse measurements are enabled.

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 pulse measurements are enabled.

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

Gets the length of the averaging window centered at the measurement point. A minimum of 1 sample is used internally.

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 length of the averaging window centered at the measurement point. A minimum of 1 sample is used internally.

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

Gets the time offset of the measurement point within the pulse for phase, frequency, and stability measurements.

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 of the measurement point within the pulse for phase, frequency, and stability measurements.

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

Gets the reference used for the measurement point calculation, in phase, frequency, and stability measurements. You can set measurement point based on a reference and offset.

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

Name (Value)

Description

Rise (0)

The measurement point is defined in reference to the rising edge.

Center (1)

The measurement point is defined in reference to the center of the pulse.

Fall (2)

The measurement point is defined in reference to the falling edge.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PulseMeasurementPointReference):

Specifies the reference used for the measurement point calculation, in phase, frequency, and stability measurements. You can set measurement point based on a reference and offset.

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

Gets the unit for amplitude deviation results. This attribute is applicable only for droop, ripple and overshoot results.

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

Name (Value)

Description

Percentage (0)

Amplitude deviation results are returned as a percentage.

dB (1)

Amplitude deviation results are returned in dB.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PulseMetricsAmplitudeDeviationUnit):

Specifies the unit for amplitude deviation results. This attribute is applicable only for droop, ripple and overshoot results.

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

Gets whether to enable pulse metrics results computation.

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)

Pulse Metric results computation is disabled.

True (1)

Pulse Metric results computation is enabled.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PulseMetricsEnabled):

Specifies whether to enable pulse metrics results computation.

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

Gets whether to enable pulse measurements on the multiple burst transmission.

In multiburst mode, several pulses are grouped and transmitted in rapid succession, followed by a long pause with no pulses, before another burst of pulses. Each pulse is assigned a burst index and position index within a burst.

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)

Multiburst disabled, assumes all pulses detected in the current acquisition are analysed as single burst.

True (1)

Multiburst enabled, assumes every burst in the acquisition contains pulses specified by Pulse Burst Length (Pulses) attribute.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.MultiburstEnabled):

Specifies whether to enable pulse measurements on the multiple burst transmission.

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

Gets the number of pulses assigned to a single burst.

A minimum of 10 pulses per burst is required for pulse measurements.

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 pulses assigned to a single burst.

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

Gets whether to enable pulse stability measurements on multiple measurement points. This attribute enables the stability traces over multiple measurement points when you set the PULSE_ALL_TRACES_ENABLED attribute to TRUE.

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)

Multiple Measurement Points related computation is disabled.

True (1)

Multiple Measurement Points related computation is enabled.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PulseMultipleMeasurementPointsEnabled):

Specifies whether to enable pulse stability measurements on multiple measurement points. This attribute enables the stability traces over multiple measurement points when you set the PULSE_ALL_TRACES_ENABLED attribute to TRUE.

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

Gets the start of the measurement window used for multiple measurement points selection over pulse ON duration.

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. Valid values are 0 to 100, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the start of the measurement window used for multiple measurement points selection over pulse ON duration.

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

Gets the step size of multiple measurement points selection within the measurement window over pulse ON duration. A minimum of 1 sample step size is used internally.

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

Specifies the step size of multiple measurement points selection within the measurement window over pulse ON duration. A minimum of 1 sample step size is used internally.

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

Gets the stop of the measurement window used for multiple measurement points selection over pulse ON duration.

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 80. Valid values are 0 to 100, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the stop of the measurement window used for multiple measurement points selection over pulse ON duration.

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

Gets the maximum number of threads used for parallelism for the pulse measurement.

The number of threads can range from 1 to the number of physical cores. The number of threads you set may not be used in calculations. The actual number of threads used depends on the problem size, system resources, data availability, and other considerations.

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. Valid values are 1 to 10, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the maximum number of threads used for parallelism for the pulse 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_selected_burst_trace(selector_string)[source]

Gets the burst number selected for the display of traces. This attribute is applicable for IQ, amplitude and pulse stability traces.

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 burst number selected for the display of traces. This attribute is applicable for IQ, amplitude and pulse stability traces.

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

Gets the pulse number selected for displaying the traces. This attribute is valid only for IQ, amplitude and pulse stability traces.

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 pulse number selected for displaying the traces. This attribute is valid only for IQ, amplitude and pulse stability traces.

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

Gets whether to enable pulse stability results computation.

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)

Pulse Stability results computation is disabled.

True (1)

Pulse Stability results computation is enabled.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PulseStabilityEnabled):

Specifies whether to enable pulse stability results computation.

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

Gets whether to compute and correct the frequency offset for stability results computation. This is an optional setting and in negligible frequency error condition you must set this attribute to Off to avoid incorrect results.

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

Name (Value)

Description

Off (0)

Frequency error compensation is disabled.

On (1)

Frequency error compensation is enabled.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PulseStabilityFrequencyErrorCompensation):

Specifies whether to compute and correct the frequency offset for stability results computation. This is an optional setting and in negligible frequency error condition you must set this attribute to Off to avoid incorrect results.

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

Gets the offset in number of pulses to be used for pulse stability measurement. This attribute is applicable for average stability results and pulse-to-pulse stabilty trace.

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 offset in number of pulses to be used for pulse stability measurement. This attribute is applicable for average stability results and pulse-to-pulse stabilty trace.

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

Gets the offset in number of pulses used for pulse-to-pulse stability measurement trace.

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 offset in number of pulses used for pulse-to-pulse stability measurement trace.

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

Gets the offset in number of pulses used for pulse stability reference computation.

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 offset in number of pulses used for pulse stability reference computation.

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

Gets whether to enable pulse time sidelobe results computation. You can use the RFmxPulse Configure Reference Waveform (1 Wfm) method to set the reference waveform for correlation computation.

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)

Pulse Time Sidelobe results computation is disabled.

True (1)

Pulse Time Sidelobe results computation is enabled.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PulseTimeSidelobeEnabled):

Specifies whether to enable pulse time sidelobe results computation. You can use the RFmxPulse Configure Reference Waveform (1 Wfm) method to set the reference waveform for correlation computation.

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

Gets keep out time for the time sidelobe measurements.

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.000001 seconds.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies keep out time for the time sidelobe measurements.

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

Gets whether the keep out time computation for the time sidelobe measurements is automatic or manual.

Defines excluded region in the correlated output to distinguish the sidelobes from the main lobe for time sidelobe measurements.

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)

Keep out time computation is set to manual specifified by Pulse Time Sidelobe Keep Out Time (s) attribute.

True (1)

Keep out time computation is set to automatic, determined mainlobe 3dB width is used.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PulseTimeSidelobeKeepOutTimeAuto):

Specifies whether the keep out time computation for the time sidelobe measurements is automatic or manual.

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

Gets the minimum peak correlation value for the time sidelobe measurements.

Time sidelobe measurements for the given pulse is computed only if the peak correlation value crosses the minimum correlation value.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the minimum peak correlation value for the time sidelobe measurements.

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

Gets the window type to be applied to the reference pulse to obtain correlated output for the time sidelobe measurements.

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

Name (Value)

Description

None (0)

Indicates no windowing.

Flat Top (1)

Indicates Flat Top window type.

Hanning (2)

Indicates Hanning window type.

Hamming (3)

Indicates Hamming window type.

Gaussian (4)

Indicates Gaussian window type.

Blackman (5)

Indicates Blackman window type.

Dolph-Chebyshev (6)

Indicates Chebyshev window type.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PulseTimeSidelobeReferenceWindowType):

Specifies the window type to be applied to the reference pulse to obtain correlated output for the time sidelobe measurements.

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

Gets whether the trace range computation of the selected pulse is automatic or manually configured by you.

This attribute is applicable for IQ, amplitude, phase and frequency traces.

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)

Trace range computation is set to manual.

True (1)

Trace range is automatically computed according to the pulse width.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PulseTraceRangeAuto):

Specifies whether the trace range computation of the selected pulse is automatic or manually configured by you.

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

Gets the length in seconds of the trace range centered at the reference point.

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.000020 seconds.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the length in seconds of the trace range centered at the reference point.

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

Gets the time offset in seconds from the reference point to position the trace range.

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 in seconds from the reference point to position the trace range.

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

Gets the reference point for positioning of trace range. You can set reference point based on reference and PULSE_TRACE_RANGE_OFFSET value.

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

Name (Value)

Description

Rise (0)

Trace range is defined in reference to the rising edge.

Center (1)

Trace range is defined in reference to the center of the pulse.

Fall (2)

Trace range is defined in reference to the falling edge.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.PulseTraceRangeReference):

Specifies the reference point for positioning of trace range. You can set reference point based on reference and PULSE_TRACE_RANGE_OFFSET value.

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

Gets the upper threshold level as a percentage of the pulse amplitude used to signify the end of a rising edge or beginning of a falling edge.

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 90. Valid values are 0 to 100, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the upper threshold level as a percentage of the pulse amplitude used to signify the end of a rising edge or beginning of a falling edge.

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

Gets the middle threshold level as a percentage of the pulse amplitude used to signify the mid-transition level between pulse states used for pulse width computation.

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 50. Valid values are 0 to 100, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the middle threshold level as a percentage of the pulse amplitude used to signify the mid-transition level between pulse states used for pulse width computation.

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

Sets the mode to select all pulses or the subset of acquired pulses available for display acquisition trace, limited to MAXIMUM_PULSE_COUNT_ENABLED attribute if set to True.

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

Name (Value)

Description

All Pulses (0)

Selects all the acquired pulses.

Subset (1)
Parameters:
Returns:

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

Return type:

int

set_acquisition_trace_subset_length(selector_string, value)[source]

Sets the total number of pulses starting from offset to be used for display acquisition trace. You must configure this attribute when you set the PULSE_ACQUISITION_TRACE_SELECT attribute to Subset.

Set length to 0 to disable the acquisition trace.

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. Valid values are 0 to 10000, inclusive.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the total number of pulses starting from offset to be used for display acquisition trace. You must configure this attribute when you set the PULSE_ACQUISITION_TRACE_SELECT attribute to Subset.

Returns:

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

Return type:

int

set_acquisition_trace_subset_offset(selector_string, value)[source]

Sets the offset in number of pulses to be used for display acquisition trace. You must configure this attribute when you set the PULSE_ACQUISITION_TRACE_SELECT attribute to Subset.

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 9999, inclusive.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the offset in number of pulses to be used for display acquisition trace. You must configure this attribute when you set the PULSE_ACQUISITION_TRACE_SELECT attribute to Subset.

Returns:

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

Return type:

int

set_all_traces_enabled(selector_string, value)[source]

Sets whether to enable storing and retrieving traces after performing the measurements.

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 storing and retrieving traces after performing the measurements.

Returns:

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

Return type:

int

set_amplitude_level_domain(selector_string, value)[source]

Sets whether voltage or power to be used as domain for pulse measurements.

The level thresholds are considered with a specified domain that impacts the timing results and level results such as droop, overshoot and ripple.

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

Name (Value)

Description

Volts (0)

All threshold levels are calculated in the voltage domain.

Watts (1)

All threshold levels are calculated in the power domain.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.PulseAmplitudeLevelDomain, int) – Specifies whether voltage or power to be used as domain for pulse measurements.

Returns:

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

Return type:

int

set_amplitude_trace_unit(selector_string, value)[source]

Sets the unit of the amplitude level. This attribute is applicable only for the amplitude and acquired amplitude trace.

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

Name (Value)

Description

dBm (0)

Amplitude trace is expressed in dBm.

Volts (1)

Amplitude trace is expressed in Volts.

Watts (2)

Amplitude trace is expressed in Watts.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.PulseAmplitudeTraceUnit, int) – Specifies the unit of the amplitude level. This attribute is applicable only for the amplitude and acquired amplitude trace.

Returns:

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

Return type:

int

set_detection_hysteresis(selector_string, value)[source]

Sets the hysteresis for pulse detection in dB for the defined threshold.

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. Valid values are 0 to 50, inclusive.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the hysteresis for pulse detection in dB for the defined threshold.

Returns:

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

Return type:

int

set_detection_maximum_width(selector_string, value)[source]

Sets the maximum pulse width time to be considered for pulse detection. Any detected pulse width time above the specified value will be ignored by the pulse detection. This value is expressed in seconds.

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.005 seconds.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the maximum pulse width time to be considered for pulse detection. Any detected pulse width time above the specified value will be ignored by the pulse detection. 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

set_detection_minimum_off_duration(selector_string, value)[source]

Sets the minimum pulse off duration to be ignored by the pulse detection. This value is expressed in seconds.

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.00000005. Valid values are 0 to 0.001, inclusive.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the minimum pulse off duration to be ignored by the pulse detection. 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

set_detection_minimum_width(selector_string, value)[source]

Sets the minimum pulse width time to be considered for pulse detection. Any detected pulse width time below the specified value will be ignored by the pulse detection. This value is expressed in seconds.

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.00000005 seconds.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the minimum pulse width time to be considered for pulse detection. Any detected pulse width time below the specified value will be ignored by the pulse detection. 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

set_detection_reference(selector_string, value)[source]

Sets the reference used for PULSE_DETECTION_THRESHOLD 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 Ref Level.

Name (Value)

Description

Ref Level (0)

The threshold is relative to the reference level of the samples.

Absolute (1)

The threshold is the absolute power, in dBm.

Peak (2)

The threshold is relative to the peak level of the samples.
Parameters:
Returns:

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

Return type:

int

set_detection_threshold(selector_string, value)[source]

Sets the threshold used for pulse detection. The unit dB or dBm is based on the value you set to the PULSE_DETECTION_REFERENCE 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 -20. Valid values are -100 to 100, inclusive.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the threshold used for pulse detection. The unit dB or dBm is based on the value you set to the PULSE_DETECTION_REFERENCE attribute.

Returns:

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

Return type:

int

set_droop_compensation_enabled(selector_string, value)[source]

Sets whether to compensate the droop detected in pulse level when applying thresholds.

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)

Droop Compensation is disabled.

True (1)

Droop Compensation is enabled.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.PulseDroopCompensationEnabled, int) – Specifies whether to compensate the droop detected in pulse level when applying thresholds.

Returns:

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

Return type:

int

set_frequency_and_phase_cw_frequency_offset(selector_string, value)[source]

Sets to manually enter the CW frequency offset. This attribute is valid only when you set the PULSE_FREQUENCY_AND_PHASE_MODULATION_TYPE attribute to CW.

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:
Returns:

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

Return type:

int

set_frequency_and_phase_cw_frequency_offset_auto(selector_string, value)[source]

Sets whether the CW frequency offset computation of every detected pulse is automatic or manual. This attribute is valid only when you set the PULSE_FREQUENCY_AND_PHASE_MODULATION_TYPE attribute to CW.

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)

CW frequency offset computation is set to manual.

True (1)

CW frequency offset computation is set to automatic.
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_and_phase_deviation_range_edge_start(selector_string, value)[source]

Sets the start of the pulse data used for the phase/frequency deviation and error measurements when you set the PULSE_FREQUENCY_AND_PHASE_DEVIATION_RANGE_REFERENCE attribute to Edge.

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:
Returns:

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

Return type:

int

set_frequency_and_phase_deviation_range_edge_stop(selector_string, value)[source]

Sets the stop of the pulse data used for the phase/frequency deviation and error measurements when you set the PULSE_FREQUENCY_AND_PHASE_DEVIATION_RANGE_REFERENCE attribute to Edge.

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:
Returns:

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

Return type:

int

set_frequency_and_phase_deviation_range_length(selector_string, value)[source]

Sets the length of the pulse data used for the phase/frequency deviation and error measurements when you set the PULSE_FREQUENCY_AND_PHASE_DEVIATION_RANGE_REFERENCE attribute to Center.

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 75. Valid values are 0 to 100, inclusive.

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

Sets the reference used for the measurement range in phase/frequency deviation and error measurements.

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

Name (Value)

Description

Edge (0)

Specifies the range with respect to the edges of the pulse.

Center (1)

Specifies the range with respect to the center of the pulse.
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_and_phase_modulation_type(selector_string, value)[source]

Sets the pulse modulation type used for the phase and frequency error, and pulsed FM 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 CW.

Name (Value)

Description

CW (0)

Continous wave where the frequency remains constant over pulse ON duration.

Linear FM (1)

Frequency varies linearly within pulse ON duration.

Triangular FM (2)

Frequency varies with two lienar FM chirps with opposite slopes within pulse ON duration.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.PulseModulationType, int) – Specifies the pulse modulation type used for the phase and frequency error, and pulsed FM Measurement.

Returns:

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

Return type:

int

set_level_computation_method(selector_string, value)[source]

Sets the algorithm used to detect the pulse levels. The algorithm is based on the histogram method of level detection as defined in IEEE Std 181-2011.

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

Name (Value)

Description

Mean (0)

The levels derived as the pulse sub-histogram mean levels.

Median (1)

The levels derived as the pulse sub-histogram median levels.

Mode (2)

The levels derived as the pulse sub-histogram mode levels.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.PulseLevelComputationMethod, int) – Specifies the algorithm used to detect the pulse levels. The algorithm is based on the histogram method of level detection as defined in IEEE Std 181-2011.

Returns:

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

Return type:

int

set_lower_threshold_level(selector_string, value)[source]

Sets the lower threshold level as a percentage of the pulse amplitude used to signify the start of a rising or end of a falling edge.

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. Valid values are 0 to 100, inclusive.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the lower threshold level as a percentage of the pulse amplitude used to signify the start of a rising or end of a falling edge.

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 pulse measurements are enabled.

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 pulse measurements are enabled.

Returns:

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

Return type:

int

set_measurement_point_averaging_duration(selector_string, value)[source]

Sets the length of the averaging window centered at the measurement point. A minimum of 1 sample is used internally.

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 length of the averaging window centered at the measurement point. A minimum of 1 sample is used internally.

Returns:

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

Return type:

int

set_measurement_point_offset(selector_string, value)[source]

Sets the time offset of the measurement point within the pulse for phase, frequency, and stability measurements.

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 of the measurement point within the pulse for phase, frequency, and stability measurements.

Returns:

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

Return type:

int

set_measurement_point_reference(selector_string, value)[source]

Sets the reference used for the measurement point calculation, in phase, frequency, and stability measurements. You can set measurement point based on a reference and offset.

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

Name (Value)

Description

Rise (0)

The measurement point is defined in reference to the rising edge.

Center (1)

The measurement point is defined in reference to the center of the pulse.

Fall (2)

The measurement point is defined in reference to the falling edge.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.PulseMeasurementPointReference, int) – Specifies the reference used for the measurement point calculation, in phase, frequency, and stability measurements. You can set measurement point based on a reference and offset.

Returns:

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

Return type:

int

set_metrics_amplitude_deviation_unit(selector_string, value)[source]

Sets the unit for amplitude deviation results. This attribute is applicable only for droop, ripple and overshoot results.

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

Name (Value)

Description

Percentage (0)

Amplitude deviation results are returned as a percentage.

dB (1)

Amplitude deviation results are returned in dB.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.PulseMetricsAmplitudeDeviationUnit, int) – Specifies the unit for amplitude deviation results. This attribute is applicable only for droop, ripple and overshoot results.

Returns:

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

Return type:

int

set_metrics_enabled(selector_string, value)[source]

Sets whether to enable pulse metrics results computation.

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)

Pulse Metric results computation is disabled.

True (1)

Pulse Metric results computation is enabled.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.PulseMetricsEnabled, int) – Specifies whether to enable pulse metrics results computation.

Returns:

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

Return type:

int

set_multiburst_enabled(selector_string, value)[source]

Sets whether to enable pulse measurements on the multiple burst transmission.

In multiburst mode, several pulses are grouped and transmitted in rapid succession, followed by a long pause with no pulses, before another burst of pulses. Each pulse is assigned a burst index and position index within a burst.

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)

Multiburst disabled, assumes all pulses detected in the current acquisition are analysed as single burst.

True (1)

Multiburst enabled, assumes every burst in the acquisition contains pulses specified by Pulse Burst Length (Pulses) attribute.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.MultiburstEnabled, int) – Specifies whether to enable pulse measurements on the multiple burst transmission.

Returns:

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

Return type:

int

set_multiburst_length(selector_string, value)[source]

Sets the number of pulses assigned to a single burst.

A minimum of 10 pulses per burst is required for pulse measurements.

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 pulses assigned to a single burst.

Returns:

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

Return type:

int

set_multiple_measurement_points_enabled(selector_string, value)[source]

Sets whether to enable pulse stability measurements on multiple measurement points. This attribute enables the stability traces over multiple measurement points when you set the PULSE_ALL_TRACES_ENABLED attribute to TRUE.

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)

Multiple Measurement Points related computation is disabled.

True (1)

Multiple Measurement Points related computation is enabled.
Parameters:
Returns:

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

Return type:

int

set_multiple_measurement_points_window_start(selector_string, value)[source]

Sets the start of the measurement window used for multiple measurement points selection over pulse ON duration.

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. Valid values are 0 to 100, inclusive.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the start of the measurement window used for multiple measurement points selection over pulse ON duration.

Returns:

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

Return type:

int

set_multiple_measurement_points_window_step_size(selector_string, value)[source]

Sets the step size of multiple measurement points selection within the measurement window over pulse ON duration. A minimum of 1 sample step size is used internally.

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 (float) – Specifies the step size of multiple measurement points selection within the measurement window over pulse ON duration. A minimum of 1 sample step size is used internally.

Returns:

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

Return type:

int

set_multiple_measurement_points_window_stop(selector_string, value)[source]

Sets the stop of the measurement window used for multiple measurement points selection over pulse ON duration.

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 80. Valid values are 0 to 100, inclusive.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the stop of the measurement window used for multiple measurement points selection over pulse ON duration.

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

Sets the maximum number of threads used for parallelism for the pulse measurement.

The number of threads can range from 1 to the number of physical cores. The number of threads you set may not be used in calculations. The actual number of threads used depends on the problem size, system resources, data availability, and other considerations.

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. Valid values are 1 to 10, inclusive.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the maximum number of threads used for parallelism for the pulse measurement.

Returns:

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

Return type:

int

set_selected_burst_trace(selector_string, value)[source]

Sets the burst number selected for the display of traces. This attribute is applicable for IQ, amplitude and pulse stability traces.

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 burst number selected for the display of traces. This attribute is applicable for IQ, amplitude and pulse stability traces.

Returns:

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

Return type:

int

set_selected_pulse_trace(selector_string, value)[source]

Sets the pulse number selected for displaying the traces. This attribute is valid only for IQ, amplitude and pulse stability traces.

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 pulse number selected for displaying the traces. This attribute is valid only for IQ, amplitude and pulse stability traces.

Returns:

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

Return type:

int

set_stability_enabled(selector_string, value)[source]

Sets whether to enable pulse stability results computation.

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)

Pulse Stability results computation is disabled.

True (1)

Pulse Stability results computation is enabled.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.PulseStabilityEnabled, int) – Specifies whether to enable pulse stability results computation.

Returns:

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

Return type:

int

set_stability_frequency_error_compensation(selector_string, value)[source]

Sets whether to compute and correct the frequency offset for stability results computation. This is an optional setting and in negligible frequency error condition you must set this attribute to Off to avoid incorrect results.

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

Name (Value)

Description

Off (0)

Frequency error compensation is disabled.

On (1)

Frequency error compensation is enabled.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.PulseStabilityFrequencyErrorCompensation, int) – Specifies whether to compute and correct the frequency offset for stability results computation. This is an optional setting and in negligible frequency error condition you must set this attribute to Off to avoid incorrect results.

Returns:

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

Return type:

int

set_stability_measurement_offset(selector_string, value)[source]

Sets the offset in number of pulses to be used for pulse stability measurement. This attribute is applicable for average stability results and pulse-to-pulse stabilty trace.

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 offset in number of pulses to be used for pulse stability measurement. This attribute is applicable for average stability results and pulse-to-pulse stabilty trace.

Returns:

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

Return type:

int

set_stability_pulse_to_pulse_offset(selector_string, value)[source]

Sets the offset in number of pulses used for pulse-to-pulse stability measurement trace.

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 offset in number of pulses used for pulse-to-pulse stability measurement trace.

Returns:

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

Return type:

int

set_stability_reference_offset(selector_string, value)[source]

Sets the offset in number of pulses used for pulse stability reference computation.

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 offset in number of pulses used for pulse stability reference computation.

Returns:

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

Return type:

int

set_time_sidelobe_enabled(selector_string, value)[source]

Sets whether to enable pulse time sidelobe results computation. You can use the RFmxPulse Configure Reference Waveform (1 Wfm) method to set the reference waveform for correlation computation.

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)

Pulse Time Sidelobe results computation is disabled.

True (1)

Pulse Time Sidelobe results computation is enabled.
Parameters:
Returns:

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

Return type:

int

set_time_sidelobe_keep_out_time(selector_string, value)[source]

Sets keep out time for the time sidelobe measurements.

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.000001 seconds.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies keep out time for the time sidelobe measurements.

Returns:

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

Return type:

int

set_time_sidelobe_keep_out_time_auto(selector_string, value)[source]

Sets whether the keep out time computation for the time sidelobe measurements is automatic or manual.

Defines excluded region in the correlated output to distinguish the sidelobes from the main lobe for time sidelobe measurements.

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)

Keep out time computation is set to manual specifified by Pulse Time Sidelobe Keep Out Time (s) attribute.

True (1)

Keep out time computation is set to automatic, determined mainlobe 3dB width is used.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.PulseTimeSidelobeKeepOutTimeAuto, int) – Specifies whether the keep out time computation for the time sidelobe measurements is automatic or manual.

Returns:

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

Return type:

int

set_time_sidelobe_minimum_correlation(selector_string, value)[source]

Sets the minimum peak correlation value for the time sidelobe measurements.

Time sidelobe measurements for the given pulse is computed only if the peak correlation value crosses the minimum correlation value.

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

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the minimum peak correlation value for the time sidelobe measurements.

Returns:

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

Return type:

int

set_time_sidelobe_reference_window_type(selector_string, value)[source]

Sets the window type to be applied to the reference pulse to obtain correlated output for the time sidelobe measurements.

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

Name (Value)

Description

None (0)

Indicates no windowing.

Flat Top (1)

Indicates Flat Top window type.

Hanning (2)

Indicates Hanning window type.

Hamming (3)

Indicates Hamming window type.

Gaussian (4)

Indicates Gaussian window type.

Blackman (5)

Indicates Blackman window type.

Dolph-Chebyshev (6)

Indicates Chebyshev window type.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.PulseTimeSidelobeReferenceWindowType, int) – Specifies the window type to be applied to the reference pulse to obtain correlated output for the time sidelobe measurements.

Returns:

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

Return type:

int

set_trace_range_auto(selector_string, value)[source]

Sets whether the trace range computation of the selected pulse is automatic or manually configured by you.

This attribute is applicable for IQ, amplitude, phase and frequency traces.

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)

Trace range computation is set to manual.

True (1)

Trace range is automatically computed according to the pulse width.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.PulseTraceRangeAuto, int) – Specifies whether the trace range computation of the selected pulse is automatic or manually configured by you.

Returns:

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

Return type:

int

set_trace_range_length(selector_string, value)[source]

Sets the length in seconds of the trace range centered at the reference point.

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.000020 seconds.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the length in seconds of the trace range centered at the reference point.

Returns:

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

Return type:

int

set_trace_range_offset(selector_string, value)[source]

Sets the time offset in seconds from the reference point to position the trace range.

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 in seconds from the reference point to position the trace range.

Returns:

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

Return type:

int

set_trace_range_reference(selector_string, value)[source]

Sets the reference point for positioning of trace range. You can set reference point based on reference and PULSE_TRACE_RANGE_OFFSET value.

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

Name (Value)

Description

Rise (0)

Trace range is defined in reference to the rising edge.

Center (1)

Trace range is defined in reference to the center of the pulse.

Fall (2)

Trace range is defined in reference to the falling edge.
Parameters:
Returns:

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

Return type:

int

set_upper_threshold_level(selector_string, value)[source]

Sets the upper threshold level as a percentage of the pulse amplitude used to signify the end of a rising edge or beginning of a falling edge.

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 90. Valid values are 0 to 100, inclusive.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the upper threshold level as a percentage of the pulse amplitude used to signify the end of a rising edge or beginning of a falling edge.

Returns:

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

Return type:

int

set_width_threshold_level(selector_string, value)[source]

Sets the middle threshold level as a percentage of the pulse amplitude used to signify the mid-transition level between pulse states used for pulse width computation.

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 50. Valid values are 0 to 100, inclusive.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the middle threshold level as a percentage of the pulse amplitude used to signify the mid-transition level between pulse states used for pulse width computation.

Returns:

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

Return type:

int