Enums

Enums used in NI-SCOPE

niscope.AcquisitionStatus

AcquisitionStatus.COMPLETE

AcquisitionStatus.IN_PROGRESS

AcquisitionStatus.STATUS_UNKNOWN

niscope.AcquisitionType

AcquisitionType.NORMAL

Sets the digitizer to normal resolution mode. The digitizer can use real-time sampling or equivalent-time sampling.

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

AcquisitionType.DDC

Sets the digitizer to DDC mode on the NI 5620/5621.

niscope.DataProcessingMode

DataProcessingMode.REAL

The waveform data points are real numbers (I data).

DataProcessingMode.COMPLEX

The waveform data points are complex numbers (IQ data).

niscope.ExportableSignals

ExportableSignals.START_TRIGGER

ExportableSignals.ADVANCE_TRIGGER

ExportableSignals.REF_TRIGGER

ExportableSignals.END_OF_RECORD_EVENT

ExportableSignals.END_OF_ACQUISITION_EVENT

ExportableSignals.READY_FOR_START_EVENT

ExportableSignals.READY_FOR_ADVANCE_EVENT

ExportableSignals.READY_FOR_REF_EVENT

ExportableSignals.REF_CLOCK

ExportableSignals.SAMPLE_CLOCK

ExportableSignals.FIVE_V_OUT

niscope.FetchRelativeTo

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.

FetchRelativeTo.PRETRIGGER

Fetches relative to the first pretrigger point requested with niscope.Session.configure_horizontal_timing().

FetchRelativeTo.NOW

Fetch data at the last sample acquired.

FetchRelativeTo.START

Fetch data starting at the first point sampled by the digitizer.

FetchRelativeTo.TRIGGER

Fetch at the first posttrigger sample.

niscope.FlexFIRAntialiasFilterType

FlexFIRAntialiasFilterType.FOURTYEIGHT_TAP_STANDARD

This filter is optimized for alias protection and frequency-domain flatness

FlexFIRAntialiasFilterType.FOURTYEIGHT_TAP_HANNING

This filter is optimized for the lowest possible bandwidth for a 48 tap filter and maximizes the SNR

FlexFIRAntialiasFilterType.SIXTEEN_TAP_HANNING

This filter is optimized for the lowest possible bandwidth for a 16 tap filter and maximizes the SNR

FlexFIRAntialiasFilterType.EIGHT_TAP_HANNING

This filter is optimized for the lowest possible bandwidth for a 8 tap filter and maximizes the SNR

niscope.Option

Option.SELF_CALIBRATE_ALL_CHANNELS

Self Calibrating all Channels

Option.RESTORE_EXTERNAL_CALIBRATION

Restore External Calibration.

niscope.OverflowErrorReporting

OverflowErrorReporting.ERROR

Execution stops and NI-SCOPE returns an error when an overflow has occurred in the OSP block.

OverflowErrorReporting.WARNING

Execution continues and NI-SCOPE returns a warning when an overflow has occurred in the OSP block.

OverflowErrorReporting.DISABLED

NI-SCOPE does not return an error when an overflow has occurred in the OSP block.

niscope.RISMethod

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.

RISMethod.MIN_NUM_AVERAGES

Each RIS sample is the average of a least a minimum number of randomly distributed points.

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

RISMethod.LIMITED_BIN_WIDTH

Limits the waveforms in the various bins to be within 200 ps of the center of the bin.

niscope.RefTriggerDetectorLocation

RefTriggerDetectorLocation.ANALOG_DETECTION_CIRCUIT

use the hardware analog circuitry to implement the reference trigger. This option will trigger before any onboard signal processing.

RefTriggerDetectorLocation.DDC_OUTPUT

use the onboard signal processing logic to implement the reference trigger. This option will trigger based on the onboard signal processed data.

niscope.StreamingPositionType

StreamingPositionType.START

Data is streamed from the start trigger.

StreamingPositionType.REFERENCE

Data is streamed relative to the reference trigger and reference position.

StreamingPositionType.SYNC

Data is streamed relative to the sync trigger and reference position.

niscope.TerminalConfiguration

TerminalConfiguration.SINGLE_ENDED

Channel is single ended

TerminalConfiguration.UNBALANCED_DIFFERENTIAL

Channel is unbalanced differential

TerminalConfiguration.DIFFERENTIAL

Channel is differential

niscope.TriggerCoupling

TriggerCoupling.AC

AC coupling

TriggerCoupling.DC

DC coupling

TriggerCoupling.HF_REJECT

Highpass filter coupling

TriggerCoupling.LF_REJECT

Lowpass filter coupling

TriggerCoupling.AC_PLUS_HF_REJECT

Highpass and lowpass filter coupling

niscope.TriggerModifier

TriggerModifier.NO_TRIGGER_MOD

Normal triggering.

TriggerModifier.AUTO

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

niscope.TriggerSlope

TriggerSlope.NEGATIVE

Falling edge

TriggerSlope.POSITIVE

Rising edge

niscope.TriggerType

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().

TriggerType.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().

TriggerType.IMMEDIATE

Configures the digitizer for immediate triggering. An immediate trigger occurs as soon as the pretrigger samples are acquired.

TriggerType.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().

TriggerType.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().

TriggerType.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().

TriggerType.SOFTWARE

Configures the digitizer for software triggering. A software trigger occurs when niscope.Session.SendSoftwareTrigger() is called.

niscope.TriggerWindowMode

TriggerWindowMode.ENTERING

Trigger upon entering the window

TriggerWindowMode.LEAVING

Trigger upon leaving the window

niscope.VerticalCoupling

VerticalCoupling.AC

AC coupling

VerticalCoupling.DC

DC coupling

VerticalCoupling.GND

GND coupling

niscope.VideoPolarity

VideoPolarity.POSITIVE

Specifies that the video signal has positive polarity.

VideoPolarity.NEGATIVE

Specifies that the video signal has negative polarity.

niscope.VideoSignalFormat

VideoSignalFormat.NTSC

NTSC signal format supports line numbers from 1 to 525

VideoSignalFormat.PAL

PAL signal format supports line numbers from 1 to 625

VideoSignalFormat.SECAM

SECAM signal format supports line numbers from 1 to 625

VideoSignalFormat.M_PAL

M-PAL signal format supports line numbers from 1 to 525

VideoSignalFormat.VIDEO_480I_59_94_FIELDS_PER_SECOND

480 lines, interlaced, 59.94 fields per second

VideoSignalFormat.VIDEO_480I_60_FIELDS_PER_SECOND

480 lines, interlaced, 60 fields per second

VideoSignalFormat.VIDEO_480P_59_94_FRAMES_PER_SECOND

480 lines, progressive, 59.94 frames per second

VideoSignalFormat.VIDEO_480P_60_FRAMES_PER_SECOND

480 lines, progressive,60 frames per second

VideoSignalFormat.VIDEO_576I_50_FIELDS_PER_SECOND

576 lines, interlaced, 50 fields per second

VideoSignalFormat.VIDEO_576P_50_FRAMES_PER_SECOND

576 lines, progressive, 50 frames per second

VideoSignalFormat.VIDEO_720P_50_FRAMES_PER_SECOND

720 lines, progressive, 50 frames per second

VideoSignalFormat.VIDEO_720P_59_94_FRAMES_PER_SECOND

720 lines, progressive, 59.94 frames per second

VideoSignalFormat.VIDEO_720P_60_FRAMES_PER_SECOND

720 lines, progressive, 60 frames per second

VideoSignalFormat.VIDEO_1080I_50_FIELDS_PER_SECOND

1,080 lines, interlaced, 50 fields per second

VideoSignalFormat.VIDEO_1080I_59_94_FIELDS_PER_SECOND

1,080 lines, interlaced, 59.94 fields per second

VideoSignalFormat.VIDEO_1080I_60_FIELDS_PER_SECOND

1,080 lines, interlaced, 60 fields per second

VideoSignalFormat.VIDEO_1080P_24_FRAMES_PER_SECOND

1,080 lines, progressive, 24 frames per second

niscope.VideoTriggerEvent

VideoTriggerEvent.FIELD1

Trigger on field 1 of the signal

VideoTriggerEvent.FIELD2

Trigger on field 2 of the signal

VideoTriggerEvent.ANY_FIELD

Trigger on the first field acquired

VideoTriggerEvent.ANY_LINE

Trigger on the first line acquired

VideoTriggerEvent.LINE_NUMBER

Trigger on a specific line of a video signal. Valid values vary depending on the signal format configured.

niscope.WhichTrigger

WhichTrigger.START

WhichTrigger.ARM_REFERENCE

WhichTrigger.REFERENCE

WhichTrigger.ADVANCE