Enums

Enums used in NI-SCOPE

AcquisitionStatus

class niscope.AcquisitionStatus
COMPLETE
IN_PROGRESS
STATUS_UNKNOWN

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.

CableSenseMode

class niscope.CableSenseMode
DISABLED

The oscilloscope is not configured to emit a CableSense signal.

ON_DEMAND

The oscilloscope is configured to emit a single CableSense pulse.

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.

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

class niscope.GlitchCondition
GREATER

Trigger on pulses with a duration greater than the specified glitch width.

LESS

Trigger on pulses with a duration shorter than the specified glitch width.

GlitchPolarity

class niscope.GlitchPolarity
POSITIVE

Trigger on pulses of positive polarity relative to the trigger threshold.

NEGATIVE

Trigger on pulses of negative polarity relative to the trigger threshold.

EITHER

Trigger on pulses of either positive or negative polarity.

Option

class niscope.Option
SELF_CALIBRATE_ALL_CHANNELS

Self Calibrating all Channels

RESTORE_EXTERNAL_CALIBRATION

Restore External Calibration.

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.

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 cross niscope.Session.runt_high_threshold.

NEGATIVE

Trigger on pulses of negative polarity relative to niscope.Session.runt_high_threshold that do not cross niscope.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 and niscope.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 and niscope.Session.runt_time_high_limit.

TerminalConfiguration

class niscope.TerminalConfiguration
SINGLE_ENDED

Channel is single ended

UNBALANCED_DIFFERENTIAL

Channel is unbalanced differential

DIFFERENTIAL

Channel is differential

TriggerCoupling

class niscope.TriggerCoupling
AC

AC coupling

DC

DC coupling

HF_REJECT

Highpass filter coupling

LF_REJECT

Lowpass filter coupling

AC_PLUS_HF_REJECT

Highpass and lowpass filter coupling

TriggerModifier

class niscope.TriggerModifier
NO_TRIGGER_MOD

Normal triggering.

AUTO

Software will trigger an acquisition automatically if no trigger arrives after a certain amount of time.

AUTO_LEVEL

TriggerSlope

class niscope.TriggerSlope
NEGATIVE

Falling edge

POSITIVE

Rising edge

SLOPE_EITHER

Either edge

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

class niscope.TriggerWindowMode
ENTERING

Trigger upon entering the window

LEAVING

Trigger upon leaving the window

ENTERING_OR_LEAVING

VerticalCoupling

class niscope.VerticalCoupling
AC

AC coupling

DC

DC coupling

GND

GND coupling

VideoPolarity

class niscope.VideoPolarity
POSITIVE

Specifies that the video signal has positive polarity.

NEGATIVE

Specifies that the video signal has negative polarity.

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

class niscope.WhichTrigger
START
ARM_REFERENCE
REFERENCE
ADVANCE

WidthCondition

class niscope.WidthCondition
WITHIN

Trigger on pulses with a duration within the range bounded by niscope.Session.width_low_threshold and niscope.Session.width_high_threshold.

OUTSIDE

Trigger on pulses with a duration not within the range bounded by niscope.Session.width_low_threshold and niscope.Session.width_high_threshold.

WidthPolarity

class niscope.WidthPolarity
POSITIVE

Trigger on pulses of positive polarity relative to the trigger threshold.

NEGATIVE

Trigger on pulses of negative polarity relative to the trigger threshold.

EITHER

Trigger on pulses of either positive or negative polarity.