Attributes

attributes.py - Contains the ID of all attributes belongs to the module.

class nirfmxpulse.attributes.AttributeID(value)[source]

Bases: Enum

This enum class contains the ID of all attributes belongs to the module.

ACQUISITION_LENGTH = 12582929

Specifies the acquisition length for the pulse measurement. This value is expressed in seconds.

You configure this attribute when you set the SEGMENTED_ACQUISITION_ENABLED attribute to False.

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

AUTO_LEVEL_INITIAL_REFERENCE_LEVEL = 12582925

Specifies the initial reference level, in dBm, which the auto_level() method uses to estimate the peak power of the input signal.

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

CENTER_FREQUENCY = 12582913

Specifies the expected carrier frequency of the acquired RF signal. This value is expressed in Hz. The signal analyzer tunes to this frequency.

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 of this attribute is hardware dependent.

DIGITAL_EDGE_TRIGGER_EDGE = 12582918

Specifies the active edge for the trigger. This attribute is used only when you set the TRIGGER_TYPE attribute to Digital 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 Rising Edge.

Name (Value)	Description
Rising Edge (0)	The trigger asserts on the rising edge of the signal.
Falling Edge (1)	The trigger asserts on the falling edge of the signal.

DIGITAL_EDGE_TRIGGER_SOURCE = 12582917

Specifies the source terminal for the digital edge trigger. This attribute is used only when you set the TRIGGER_TYPE attribute to Digital 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 of this attribute is hardware dependent.

EXTERNAL_ATTENUATION = 12582915

Specifies the attenuation of a switch or cable connected to the RF IN connector of the signal analyzer. This value is expressed in dB. For more information about attenuation, refer to the RF Attenuation and Signal Levels topic for your device in the NI RF Vector Signal Analyzers Help.

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.

IQ_POWER_EDGE_TRIGGER_LEVEL = 12582920

Specifies the power level at which the device triggers. This value is expressed in dB when you set the IQ_POWER_EDGE_TRIGGER_LEVEL_TYPE attribute to Relative and in dBm when you set the IQ Power Edge Level Type attribute to Absolute. The device asserts the trigger when the signal exceeds the level specified by the value of this attribute, taking into consideration the specified slope. This attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power 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 of this attribute is hardware dependent.

IQ_POWER_EDGE_TRIGGER_LEVEL_TYPE = 12587007

Specifies the reference for the IQ_POWER_EDGE_TRIGGER_LEVEL attribute. The IQ Power Edge Level Type attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power 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 Absolute.

Name (Value)	Description
Relative (0)	The value of the IQ Power Edge Level attribute is relative to the value of the Reference Level attribute.
Absolute (1)	The IQ Power Edge Level attribute specifies the absolute power.

IQ_POWER_EDGE_TRIGGER_SLOPE = 12582921

Specifies whether the device asserts the trigger when the signal power is rising or when it is falling. The device asserts the trigger when the signal power exceeds the level that you specify in the IQ_POWER_EDGE_TRIGGER_LEVEL attribute with the slope you specify. This attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power 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 Rising Slope.

Name (Value)	Description
Rising Slope (0)	The trigger asserts when the signal power is rising.
Falling Slope (1)	The trigger asserts when the signal power is falling.

IQ_POWER_EDGE_TRIGGER_SOURCE = 12582919

Specifies the channel from which the device monitors the trigger. This attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power 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 of this attribute is hardware dependent.

MAXIMUM_PULSE_COUNT = 12582931

Specifies the maximum number of pulses to be measured when you set the MAXIMUM_PULSE_COUNT_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 100. Valid values are 1 to 10000, inclusive.

MAXIMUM_PULSE_COUNT_ENABLED = 12582930

Specifies whether to enable the maximum pulse count for pulse measurements.

You must configure this attribute when you set the SEGMENTED_ACQUISITION_ENABLED attribute to False.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is False.

Name (Value)	Description
False (0)	The maximum pulse count is disabled.
True (1)	The maximum pulse count is enabled.

MEASUREMENT_BANDWIDTH = 12582935

Specifies the bandwidth of the filter used for the required sample rate. This value is expressed in Hz.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 80 MHz.

MEASUREMENT_FILTER_TYPE = 12582936

Specifies the demodulation filter type to be used in 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 Gaussian.

Name (Value)	Description
Rectangular (0)	The Rectangular filter is applied.
Gaussian (1)	The Gaussian filter is applied.

NUMBER_OF_SEGMENTS = 12582933

Specifies the number of segments to acquire when you set the SEGMENTED_ACQUISITION_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 1. Valid values are 1 to 10000, inclusive.

PULSE_ACQUISITION_TRACE_SELECT = 12587278

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.

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)

PULSE_ACQUISITION_TRACE_SUBSET_LENGTH = 12587280

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.

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.

PULSE_ACQUISITION_TRACE_SUBSET_OFFSET = 12587279

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.

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.

PULSE_ALL_TRACES_ENABLED = 12587022

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

PULSE_AMPLITUDE_LEVEL_DOMAIN = 12587017

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

PULSE_AMPLITUDE_TRACE_UNIT = 12587228

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

PULSE_DETECTION_HYSTERESIS = 12587012

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

PULSE_DETECTION_MAXIMUM_WIDTH = 12587015

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.

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.

PULSE_DETECTION_MINIMUM_OFF_DURATION = 12587013

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

PULSE_DETECTION_MINIMUM_WIDTH = 12587014

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.

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.

PULSE_DETECTION_REFERENCE = 12587010

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

PULSE_DETECTION_THRESHOLD = 12587011

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.

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.

PULSE_DROOP_COMPENSATION_ENABLED = 12587021

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

PULSE_FREQUENCY_AND_PHASE_CW_FREQUENCY_OFFSET = 12587165

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.

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.

PULSE_FREQUENCY_AND_PHASE_CW_FREQUENCY_OFFSET_AUTO = 12587164

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.

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.

PULSE_FREQUENCY_AND_PHASE_DEVIATION_RANGE_EDGE_START = 12587151

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.

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.

PULSE_FREQUENCY_AND_PHASE_DEVIATION_RANGE_EDGE_STOP = 12587152

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.

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.

PULSE_FREQUENCY_AND_PHASE_DEVIATION_RANGE_LENGTH = 12587150

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.

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.

PULSE_FREQUENCY_AND_PHASE_DEVIATION_RANGE_REFERENCE = 12587149

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

PULSE_FREQUENCY_AND_PHASE_MODULATION_TYPE = 12587163

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

PULSE_LEVEL_COMPUTATION_METHOD = 12587016

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.

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.

PULSE_LOWER_THRESHOLD_LEVEL = 12587020

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.

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.

PULSE_MEASUREMENT_ENABLED = 12587008

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

PULSE_MEASUREMENT_POINT_AVERAGING_DURATION = 12587148

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

PULSE_MEASUREMENT_POINT_OFFSET = 12587147

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

PULSE_MEASUREMENT_POINT_REFERENCE = 12587146

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.

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.

PULSE_METRICS_AMPLITUDE_DEVIATION_UNIT = 12587229

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

PULSE_METRICS_ENABLED = 12587162

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

PULSE_MULTIBURST_ENABLED = 12587230

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

PULSE_MULTIBURST_LENGTH = 12587231

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

PULSE_MULTIPLE_MEASUREMENT_POINTS_ENABLED = 12587235

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.

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.

PULSE_MULTIPLE_MEASUREMENT_POINTS_WINDOW_START = 12587236

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

PULSE_MULTIPLE_MEASUREMENT_POINTS_WINDOW_STEP_SIZE = 12587238

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.

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.

PULSE_MULTIPLE_MEASUREMENT_POINTS_WINDOW_STOP = 12587237

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

PULSE_NUMBER_OF_ANALYSIS_THREADS = 12587144

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

PULSE_RESULTS_AMPLITUDE_STABILITY = 12587129

Returns the amplitude stability of the measured pulses. This value is expressed in dB. This value is computed as the deviation of amplitude from the reference.