Enums
Enums used in NI-SCOPE
AcquisitionStatus
AcquisitionType
- class niscope.AcquisitionType
- NORMAL
Sets the digitizer to normal resolution mode. The digitizer can use real-time sampling or equivalent-time sampling.
- FLEXRES
Sets the digitizer to flexible resolution mode if supported. The digitizer uses different hardware configurations to change the resolution depending on the sampling rate used.
- DDC
Sets the digitizer to DDC mode on the NI 5620/5621.
ArrayMeasurement
- class niscope.ArrayMeasurement
- NO_MEASUREMENT
None
- LAST_ACQ_HISTOGRAM
Last Acquisition Histogram
- FFT_PHASE_SPECTRUM
FFT Phase Spectrum
- FFT_AMP_SPECTRUM_VOLTS_RMS
FFT Amp. Spectrum (Volts RMS)
- MULTI_ACQ_VOLTAGE_HISTOGRAM
Multi Acquisition Voltage Histogram
- MULTI_ACQ_TIME_HISTOGRAM
Multi Acquisition Time Histogram
- ARRAY_INTEGRAL
Array Integral
- DERIVATIVE
Derivative
- INVERSE
Inverse
- HANNING_WINDOW
Hanning Window
- FLAT_TOP_WINDOW
Flat Top Window
- POLYNOMIAL_INTERPOLATION
Polynomial Interpolation
- MULTIPLY_CHANNELS
Multiply Channels
- ADD_CHANNELS
Add Channels
- SUBTRACT_CHANNELS
Subtract Channels
- DIVIDE_CHANNELS
Divide Channels
- MULTI_ACQ_AVERAGE
Multi Acquisition Average
- BUTTERWORTH_FILTER
Butterworth IIR Filter
- CHEBYSHEV_FILTER
Chebyshev IIR Filter
- FFT_AMP_SPECTRUM_DB
FFT Amp. Spectrum (dB)
- HAMMING_WINDOW
Hamming Window
- WINDOWED_FIR_FILTER
FIR Windowed Filter
- BESSEL_FILTER
Bessel IIR Filter
- TRIANGLE_WINDOW
Triangle Window
- BLACKMAN_WINDOW
Blackman Window
- ARRAY_OFFSET
Array Offset
- ARRAY_GAIN
Array Gain
CableSenseMode
ClearableMeasurement
- class niscope.ClearableMeasurement
- ALL_MEASUREMENTS
- MULTI_ACQ_VOLTAGE_HISTOGRAM
- MULTI_ACQ_TIME_HISTOGRAM
- MULTI_ACQ_AVERAGE
- FREQUENCY
- AVERAGE_FREQUENCY
- FFT_FREQUENCY
- PERIOD
- AVERAGE_PERIOD
- RISE_TIME
- FALL_TIME
- RISE_SLEW_RATE
- FALL_SLEW_RATE
- OVERSHOOT
- PRESHOOT
- VOLTAGE_RMS
- VOLTAGE_CYCLE_RMS
- AC_ESTIMATE
- FFT_AMPLITUDE
- VOLTAGE_AVERAGE
- VOLTAGE_CYCLE_AVERAGE
- DC_ESTIMATE
- VOLTAGE_MAX
- VOLTAGE_MIN
- VOLTAGE_PEAK_TO_PEAK
- VOLTAGE_HIGH
- VOLTAGE_LOW
- AMPLITUDE
- VOLTAGE_TOP
- VOLTAGE_BASE
- VOLTAGE_BASE_TO_TOP
- WIDTH_NEG
- WIDTH_POS
- DUTY_CYCLE_NEG
- DUTY_CYCLE_POS
- INTEGRAL
- AREA
- CYCLE_AREA
- TIME_DELAY
- PHASE_DELAY
- LOW_REF_VOLTS
- MID_REF_VOLTS
- HIGH_REF_VOLTS
- VOLTAGE_HISTOGRAM_MEAN
- VOLTAGE_HISTOGRAM_STDEV
- VOLTAGE_HISTOGRAM_MEDIAN
- VOLTAGE_HISTOGRAM_MODE
- VOLTAGE_HISTOGRAM_MAX
- VOLTAGE_HISTOGRAM_MIN
- VOLTAGE_HISTOGRAM_PEAK_TO_PEAK
- VOLTAGE_HISTOGRAM_MEAN_PLUS_STDEV
- VOLTAGE_HISTOGRAM_MEAN_PLUS_2_STDEV
- VOLTAGE_HISTOGRAM_MEAN_PLUS_3_STDEV
- VOLTAGE_HISTOGRAM_HITS
- VOLTAGE_HISTOGRAM_NEW_HITS
- TIME_HISTOGRAM_MEAN
- TIME_HISTOGRAM_STDEV
- TIME_HISTOGRAM_MEDIAN
- TIME_HISTOGRAM_MODE
- TIME_HISTOGRAM_MAX
- TIME_HISTOGRAM_MIN
- TIME_HISTOGRAM_PEAK_TO_PEAK
- TIME_HISTOGRAM_MEAN_PLUS_STDEV
- TIME_HISTOGRAM_MEAN_PLUS_2_STDEV
- TIME_HISTOGRAM_MEAN_PLUS_3_STDEV
- TIME_HISTOGRAM_HITS
- TIME_HISTOGRAM_NEW_HITS
FIRFilterWindow
FetchRelativeTo
- class niscope.FetchRelativeTo
- READ_POINTER
The read pointer is set to zero when a new acquisition is initiated. After every fetch the read pointer is incremeted to be the sample after the last sample retrieved. Therefore, you can repeatedly fetch relative to the read pointer for a continuous acquisition program.
- PRETRIGGER
Fetches relative to the first pretrigger point requested with
niscope.Session.configure_horizontal_timing()
.
- NOW
Fetch data at the last sample acquired.
- START
Fetch data starting at the first point sampled by the digitizer.
- TRIGGER
Fetch at the first posttrigger sample.
FilterType
FlexFIRAntialiasFilterType
- class niscope.FlexFIRAntialiasFilterType
- FOURTYEIGHT_TAP_STANDARD
This filter is optimized for alias protection and frequency-domain flatness
- FOURTYEIGHT_TAP_HANNING
This filter is optimized for the lowest possible bandwidth for a 48 tap filter and maximizes the SNR
- SIXTEEN_TAP_HANNING
This filter is optimized for the lowest possible bandwidth for a 16 tap filter and maximizes the SNR
- EIGHT_TAP_HANNING
This filter is optimized for the lowest possible bandwidth for a 8 tap filter and maximizes the SNR
GlitchCondition
GlitchPolarity
Option
PercentageMethod
RISMethod
- class niscope.RISMethod
- EXACT_NUM_AVERAGES
Acquires exactly the specified number of records for each bin in the RIS acquisition. An error is returned from the fetch method if the RIS acquisition does not successfully acquire the specified number of waveforms within the timeout period. You may call the fetch method again to allow more time for the acquisition to finish.
- MIN_NUM_AVERAGES
Each RIS sample is the average of a least a minimum number of randomly distributed points.
- INCOMPLETE
Returns the RIS waveform after the specified timeout even if it is incomplete. If no waveforms have been acquired in certain bins, these bins will have a NaN (when fetching scaled data) or a zero (when fetching binary data). A warning (positive error code) is returned from the fetch method if the RIS acquisition did not finish. The acquisition aborts when data is returned.
- LIMITED_BIN_WIDTH
Limits the waveforms in the various bins to be within 200 ps of the center of the bin.
RefLevelUnits
RefTriggerDetectorLocation
- class niscope.RefTriggerDetectorLocation
- ANALOG_DETECTION_CIRCUIT
use the hardware analog circuitry to implement the reference trigger. This option will trigger before any onboard signal processing.
- DDC_OUTPUT
use the onboard signal processing logic to implement the reference trigger. This option will trigger based on the onboard signal processed data.
RuntPolarity
- class niscope.RuntPolarity
- POSITIVE
Trigger on pulses of positive polarity relative to
niscope.Session.runt_low_threshold
that do not crossniscope.Session.runt_high_threshold
.
- NEGATIVE
Trigger on pulses of negative polarity relative to
niscope.Session.runt_high_threshold
that do not crossniscope.Session.runt_low_threshold
.
- EITHER
Trigger on pulses of either positive or negative polarity.
RuntTimeCondition
- class niscope.RuntTimeCondition
- NONE
Time qualification is disabled. Trigger on runt pulses based solely on the voltage level of the pulses.
- WITHIN
Trigger on pulses that, in addition to meeting runt voltage criteria, have a duration within the range bounded by
niscope.Session.runt_time_low_limit
andniscope.Session.runt_time_high_limit
.
- OUTSIDE
Trigger on pulses that, in addition to meeting runt voltage criteria, have a duration not within the range bounded by
niscope.Session.runt_time_low_limit
andniscope.Session.runt_time_high_limit
.
ScalarMeasurement
- class niscope.ScalarMeasurement
- NO_MEASUREMENT
None
- RISE_TIME
- FALL_TIME
- FREQUENCY
- PERIOD
- VOLTAGE_RMS
- VOLTAGE_PEAK_TO_PEAK
- VOLTAGE_MAX
- VOLTAGE_MIN
- VOLTAGE_HIGH
- VOLTAGE_LOW
- VOLTAGE_AVERAGE
- WIDTH_NEG
- WIDTH_POS
- DUTY_CYCLE_NEG
- DUTY_CYCLE_POS
- AMPLITUDE
- VOLTAGE_CYCLE_RMS
- VOLTAGE_CYCLE_AVERAGE
- OVERSHOOT
- PRESHOOT
- LOW_REF_VOLTS
- MID_REF_VOLTS
- HIGH_REF_VOLTS
- AREA
- CYCLE_AREA
- INTEGRAL
- VOLTAGE_BASE
- VOLTAGE_TOP
- FFT_FREQUENCY
- FFT_AMPLITUDE
- RISE_SLEW_RATE
- FALL_SLEW_RATE
- AC_ESTIMATE
- DC_ESTIMATE
- TIME_DELAY
- AVERAGE_PERIOD
- AVERAGE_FREQUENCY
- VOLTAGE_BASE_TO_TOP
- PHASE_DELAY
TerminalConfiguration
TriggerCoupling
TriggerModifier
TriggerSlope
TriggerType
- class niscope.TriggerType
- EDGE
Configures the digitizer for edge triggering. An edge trigger occurs when the trigger signal crosses the trigger level specified with the set trigger slope. You configure the trigger level and slope with
niscope.Session.configure_trigger_edge()
.
- HYSTERESIS
Configures the digitizer for hysteresis triggering. A hysteresis trigger occurs when the trigger signal crosses the trigger level with the specified slope and passes through the hysteresis window you specify. You configure the trigger level, slope, and hysteresis with
niscope.Session.configure_trigger_hysteresis()
.
- DIGITAL
Configures the digitizer for digital triggering. A digital trigger occurs when the trigger signal has the specified slope. You configure the trigger slope with
niscope.Session.configure_trigger_digital()
.
- WINDOW
Configures the digitizer for window triggering. A window trigger occurs when the trigger signal enters or leaves the window defined by the values you specify with the Low Window Level, High Window Level, and Window Mode Parameters. You configure the low window level high window level, and window mode with
niscope.Session.configure_trigger_window()
.
- SOFTWARE
Configures the digitizer for software triggering. A software trigger occurs when
niscope.Session.SendSoftwareTrigger()
is called.
- TV
Configures the digitizer for video/TV triggering. You configure the video trigger parameters like signal Format, Line to trigger off of, Polarity, and Enable DC Restore with
niscope.Session.configure_trigger_video()
.
- GLITCH
- WIDTH
- RUNT
- IMMEDIATE
Configures the digitizer for immediate triggering. An immediate trigger occurs as soon as the pretrigger samples are acquired.
TriggerWindowMode
VerticalCoupling
VideoPolarity
VideoSignalFormat
- class niscope.VideoSignalFormat
- NTSC
NTSC signal format supports line numbers from 1 to 525
- PAL
PAL signal format supports line numbers from 1 to 625
- SECAM
SECAM signal format supports line numbers from 1 to 625
- M_PAL
M-PAL signal format supports line numbers from 1 to 525
- VIDEO_480I_59_94_FIELDS_PER_SECOND
480 lines, interlaced, 59.94 fields per second
- VIDEO_480I_60_FIELDS_PER_SECOND
480 lines, interlaced, 60 fields per second
- VIDEO_480P_59_94_FRAMES_PER_SECOND
480 lines, progressive, 59.94 frames per second
- VIDEO_480P_60_FRAMES_PER_SECOND
480 lines, progressive,60 frames per second
- VIDEO_576I_50_FIELDS_PER_SECOND
576 lines, interlaced, 50 fields per second
- VIDEO_576P_50_FRAMES_PER_SECOND
576 lines, progressive, 50 frames per second
- VIDEO_720P_50_FRAMES_PER_SECOND
720 lines, progressive, 50 frames per second
- VIDEO_720P_59_94_FRAMES_PER_SECOND
720 lines, progressive, 59.94 frames per second
- VIDEO_720P_60_FRAMES_PER_SECOND
720 lines, progressive, 60 frames per second
- VIDEO_1080I_50_FIELDS_PER_SECOND
1,080 lines, interlaced, 50 fields per second
- VIDEO_1080I_59_94_FIELDS_PER_SECOND
1,080 lines, interlaced, 59.94 fields per second
- VIDEO_1080I_60_FIELDS_PER_SECOND
1,080 lines, interlaced, 60 fields per second
- VIDEO_1080P_24_FRAMES_PER_SECOND
1,080 lines, progressive, 24 frames per second
VideoTriggerEvent
- class niscope.VideoTriggerEvent
- FIELD1
Trigger on field 1 of the signal
- FIELD2
Trigger on field 2 of the signal
- ANY_FIELD
Trigger on the first field acquired
- ANY_LINE
Trigger on the first line acquired
- LINE_NUMBER
Trigger on a specific line of a video signal. Valid values vary depending on the signal format configured.
WhichTrigger
WidthCondition
- class niscope.WidthCondition
- WITHIN
Trigger on pulses with a duration within the range bounded by
niscope.Session.width_low_threshold
andniscope.Session.width_high_threshold
.
- OUTSIDE
Trigger on pulses with a duration not within the range bounded by
niscope.Session.width_low_threshold
andniscope.Session.width_high_threshold
.