niscope.Session¶
-
class
niscope.
Session
(self, resource_name, id_query=False, reset_device=False, options={})¶ Performs the following initialization actions:
- Creates a new IVI instrument driver and optionally sets the initial state of the following session properties: Range Check, Cache, Simulate, Record Value Coercions
- Opens a session to the specified device using the interface and address you specify for the resourceName
- Resets the digitizer to a known state if resetDevice is set to True
- Queries the instrument ID and verifies that it is valid for this instrument driver if the IDQuery is set to True
- Returns an instrument handle that you use to identify the instrument in all subsequent instrument driver method calls
Parameters: - resource_name (str) –
Caution
Traditional NI-DAQ and NI-DAQmx device names are not case-sensitive. However, all IVI names, such as logical names, are case-sensitive. If you use logical names, driver session names, or virtual names in your program, you must make sure that the name you use matches the name in the IVI Configuration Store file exactly, without any variations in the case of the characters.
Specifies the resource name of the device to initializeFor Traditional NI-DAQ devices, the syntax is DAQ::n, where n is the device number assigned by MAX, as shown in Example 1.
For NI-DAQmx devices, the syntax is just the device name specified in MAX, as shown in Example 2. Typical default names for NI-DAQmx devices in MAX are Dev1 or PXI1Slot1. You can rename an NI-DAQmx device by right-clicking on the name in MAX and entering a new name.
An alternate syntax for NI-DAQmx devices consists of DAQ::NI-DAQmx device name, as shown in Example 3. This naming convention allows for the use of an NI-DAQmx device in an application that was originally designed for a Traditional NI-DAQ device. For example, if the application expects DAQ::1, you can rename the NI-DAQmx device to 1 in MAX and pass in DAQ::1 for the resource name, as shown in Example 4.
If you use the DAQ::n syntax and an NI-DAQmx device name already exists with that same name, the NI-DAQmx device is matched first.
You can also pass in the name of an IVI logical name or an IVI virtual name configured with the IVI Configuration utility, as shown in Example 5. A logical name identifies a particular virtual instrument. A virtual name identifies a specific device and specifies the initial settings for the session.
Example Device Type Syntax 1 Traditional NI-DAQ device DAQ::1 (1 = device number) 2 NI-DAQmx device myDAQmxDevice (myDAQmxDevice = device name) 3 NI-DAQmx device DAQ::myDAQmxDevice (myDAQmxDevice = device name) 4 NI-DAQmx device DAQ::2 (2 = device name) 5 IVI logical name or IVI virtual name myLogicalName (myLogicalName = name) - id_query (bool) –
Specify whether to perform an ID query.
When you set this parameter to True, NI-SCOPE verifies that the device you initialize is a type that it supports.
When you set this parameter to False, the method initializes the device without performing an ID query.
Defined Values
True—Perform ID queryFalse—Skip ID queryDefault Value: True
- reset_device (bool) –
Specify whether to reset the device during the initialization process.
Default Value: True
Defined Values
True (1)—Reset device
False (0)—Do not reset device
Note
For the NI 5112, repeatedly resetting the device may cause excessive wear on the electromechanical relays. Refer to NI 5112 Electromechanical Relays for recommended programming practices.
- options (str) –
Specifies the initial value of certain properties for the session. The syntax for options is a dictionary of properties with an assigned value. For example:
{ ‘simulate’: False }
You do not have to specify a value for all the properties. If you do not specify a value for a property, the default value is used.
Advanced Example: { ‘simulate’: True, ‘driver_setup’: { ‘Model’: ‘<model number>’, ‘BoardType’: ‘<type>’ } }
Property Default range_check True query_instrument_status False cache True simulate False record_value_coersions False driver_setup {}
Properties
Public methods
Properties¶
absolute_sample_clock_offset¶
niscope.Session.
absolute_sample_clock_offset
¶Gets or sets the absolute time offset of the sample clock relative to the reference clock in terms of seconds.
Note
Configures the sample clock relationship with respect to the reference clock. This parameter is factored into NI-TClk adjustments and is typically used to improve the repeatability of NI-TClk Synchronization. When this parameter is read, the currently programmed value is returned. The range of the absolute sample clock offset is [-.5 sample clock periods, .5 sample clock periods]. The default absolute sample clock offset is 0s.
The following table lists the characteristics of this property.
Characteristic Value Datatype float in seconds or datetime.timedelta Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Clocking:Advanced:Absolute Sample Clock Offset
- C Attribute: NISCOPE_ATTR_ABSOLUTE_SAMPLE_CLOCK_OFFSET
accessory_gain¶
niscope.Session.
accessory_gain
¶Returns the calibration gain for the current device configuration. Related topics: NI 5122/5124/5142 Calibration
Note
This property is only supported by the NI PXI-5900 differential amplifier.
Tip
This property can use repeated capabilities (channels). If set or get directly on the niscope.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an niscope.Session repeated capabilities container, and calling set/get value on the result.:
var = session.channels[0,1].accessory_gainThe following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read only Channel Based True Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Device:Accessory:Gain
- C Attribute: NISCOPE_ATTR_ACCESSORY_GAIN
accessory_offset¶
niscope.Session.
accessory_offset
¶Returns the calibration offset for the current device configuration. Related topics: NI 5122/5124/5142 Calibration
Note
This property is supported only by the NI PXI-5900 differential amplifier.
Tip
This property can use repeated capabilities (channels). If set or get directly on the niscope.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an niscope.Session repeated capabilities container, and calling set/get value on the result.:
var = session.channels[0,1].accessory_offsetThe following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read only Channel Based True Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Device:Accessory:Offset
- C Attribute: NISCOPE_ATTR_ACCESSORY_OFFSET
acquisition_start_time¶
niscope.Session.
acquisition_start_time
¶Specifies the length of time from the trigger event to the first point in the waveform record in seconds. If the value is positive, the first point in the waveform record occurs after the trigger event (same as specifying
niscope.Session.trigger_delay_time
). If the value is negative, the first point in the waveform record occurs before the trigger event (same as specifyingniscope.Session.horz_record_ref_position
).The following table lists the characteristics of this property.
Characteristic Value Datatype float in seconds or datetime.timedelta Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Horizontal:Advanced:Acquisition Start Time
- C Attribute: NISCOPE_ATTR_ACQUISITION_START_TIME
acquisition_type¶
niscope.Session.
acquisition_type
¶Specifies how the digitizer acquires data and fills the waveform record.
The following table lists the characteristics of this property.
Characteristic Value Datatype enums.AcquisitionType Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Acquisition:Acquisition Type
- C Attribute: NISCOPE_ATTR_ACQUISITION_TYPE
acq_arm_source¶
niscope.Session.
acq_arm_source
¶Specifies the source the digitizer monitors for a start (acquisition arm) trigger. When the start trigger is received, the digitizer begins acquiring pretrigger samples. Valid Values:
NISCOPE_VAL_IMMEDIATE
(‘VAL_IMMEDIATE’) - Triggers immediatelyNISCOPE_VAL_RTSI_0
(‘VAL_RTSI_0’) - RTSI 0NISCOPE_VAL_RTSI_1
(‘VAL_RTSI_1’) - RTSI 1NISCOPE_VAL_RTSI_2
(‘VAL_RTSI_2’) - RTSI 2NISCOPE_VAL_RTSI_3
(‘VAL_RTSI_3’) - RTSI 3NISCOPE_VAL_RTSI_4
(‘VAL_RTSI_4’) - RTSI 4NISCOPE_VAL_RTSI_5
(‘VAL_RTSI_5’) - RTSI 5NISCOPE_VAL_RTSI_6
(‘VAL_RTSI_6’) - RTSI 6NISCOPE_VAL_PFI_0
(‘VAL_PFI_0’) - PFI 0NISCOPE_VAL_PFI_1
(‘VAL_PFI_1’) - PFI 1NISCOPE_VAL_PFI_2
(‘VAL_PFI_2’) - PFI 2NISCOPE_VAL_PXI_STAR
(‘VAL_PXI_STAR’) - PXI Star TriggerNote
One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Synchronization:Start Trigger (Acq. Arm):Source
- C Attribute: NISCOPE_ATTR_ACQ_ARM_SOURCE
adv_trig_src¶
niscope.Session.
adv_trig_src
¶Specifies the source the digitizer monitors for an advance trigger. When the advance trigger is received, the digitizer begins acquiring pretrigger samples.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Synchronization:Advance Trigger:Source
- C Attribute: NISCOPE_ATTR_ADV_TRIG_SRC
allow_more_records_than_memory¶
niscope.Session.
allow_more_records_than_memory
¶Indicates whether more records can be configured with
niscope.Session.configure_horizontal_timing()
than fit in the onboard memory. If this property is set to True, it is necessary to fetch records while the acquisition is in progress. Eventually, some of the records will be overwritten. An error is returned from the fetch method if you attempt to fetch a record that has been overwritten.The following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Horizontal:Enable Records > Memory
- C Attribute: NISCOPE_ATTR_ALLOW_MORE_RECORDS_THAN_MEMORY
arm_ref_trig_src¶
niscope.Session.
arm_ref_trig_src
¶Specifies the source the digitizer monitors for an arm reference trigger. When the arm reference trigger is received, the digitizer begins looking for a reference (stop) trigger from the user-configured trigger source.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Synchronization:Arm Reference Trigger:Source
- C Attribute: NISCOPE_ATTR_ARM_REF_TRIG_SRC
backlog¶
niscope.Session.
backlog
¶Returns the number of samples (
niscope.Session.points_done
) that have been acquired but not fetched for the record specified byniscope.Session.fetch_record_number
.The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Fetch:Fetch Backlog
- C Attribute: NISCOPE_ATTR_BACKLOG
bandpass_filter_enabled¶
niscope.Session.
bandpass_filter_enabled
¶Enables the bandpass filter on the specificed channel. The default value is FALSE.
Tip
This property can use repeated capabilities (channels). If set or get directly on the niscope.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an niscope.Session repeated capabilities container, and calling set/get value on the result.:
session.channels[0,1].bandpass_filter_enabled = var var = session.channels[0,1].bandpass_filter_enabledThe following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based True Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Vertical:Advanced:Bandpass Filter Enabled
- C Attribute: NISCOPE_ATTR_BANDPASS_FILTER_ENABLED
binary_sample_width¶
niscope.Session.
binary_sample_width
¶Indicates the bit width of the binary data in the acquired waveform. Useful for determining which Binary Fetch method to use. Compare to
niscope.Session.resolution
. To configure the device to store samples with a lower resolution that the native, set this property to the desired binary width. This can be useful for streaming at faster speeds at the cost of resolution. The least significant bits will be lost with this configuration. Valid Values: 8, 16, 32The following table lists the characteristics of this property.
Characteristic Value Datatype int Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Acquisition:Binary Sample Width
- C Attribute: NISCOPE_ATTR_BINARY_SAMPLE_WIDTH
channel_count¶
niscope.Session.
channel_count
¶Indicates the number of channels that the specific instrument driver supports. For channel-based properties, the IVI engine maintains a separate cache value for each channel.
The following table lists the characteristics of this property.
Characteristic Value Datatype int Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Inherent IVI Attributes:Driver Capabilities:Channel Count
- C Attribute: NISCOPE_ATTR_CHANNEL_COUNT
channel_enabled¶
niscope.Session.
channel_enabled
¶Specifies whether the digitizer acquires a waveform for the channel. Valid Values: True (1) - Acquire data on this channel False (0) - Don’t acquire data on this channel
Tip
This property can use repeated capabilities (channels). If set or get directly on the niscope.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an niscope.Session repeated capabilities container, and calling set/get value on the result.:
session.channels[0,1].channel_enabled = var var = session.channels[0,1].channel_enabledThe following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based True Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Vertical:Channel Enabled
- C Attribute: NISCOPE_ATTR_CHANNEL_ENABLED
channel_terminal_configuration¶
niscope.Session.
channel_terminal_configuration
¶Specifies the terminal configuration for the channel.
Tip
This property can use repeated capabilities (channels). If set or get directly on the niscope.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an niscope.Session repeated capabilities container, and calling set/get value on the result.:
session.channels[0,1].channel_terminal_configuration = var var = session.channels[0,1].channel_terminal_configurationThe following table lists the characteristics of this property.
Characteristic Value Datatype enums.TerminalConfiguration Permissions read-write Channel Based True Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Vertical:Channel Terminal Configuration
- C Attribute: NISCOPE_ATTR_CHANNEL_TERMINAL_CONFIGURATION
data_transfer_block_size¶
niscope.Session.
data_transfer_block_size
¶Specifies the maximum number of samples to transfer at one time from the device to host memory. Increasing this number should result in better fetching performance because the driver does not need to restart the transfers as often. However, increasing this number may also increase the amount of page-locked memory required from the system.
The following table lists the characteristics of this property.
Characteristic Value Datatype int Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Fetch:Data Transfer Block Size
- C Attribute: NISCOPE_ATTR_DATA_TRANSFER_BLOCK_SIZE
data_transfer_maximum_bandwidth¶
niscope.Session.
data_transfer_maximum_bandwidth
¶This property specifies the maximum bandwidth that the device is allowed to consume.
The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Fetch:Advanced:Maximum Bandwidth
- C Attribute: NISCOPE_ATTR_DATA_TRANSFER_MAXIMUM_BANDWIDTH
data_transfer_preferred_packet_size¶
niscope.Session.
data_transfer_preferred_packet_size
¶This property specifies the size of (read request|memory write) data payload. Due to alignment of the data buffers, the hardware may not always generate a packet of this size.
The following table lists the characteristics of this property.
Characteristic Value Datatype int Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Fetch:Advanced:Preferred Packet Size
- C Attribute: NISCOPE_ATTR_DATA_TRANSFER_PREFERRED_PACKET_SIZE
device_temperature¶
niscope.Session.
device_temperature
¶Returns the temperature of the device in degrees Celsius from the onboard sensor.
The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Device:Temperature
- C Attribute: NISCOPE_ATTR_DEVICE_TEMPERATURE
driver_setup¶
niscope.Session.
driver_setup
¶This property indicates the Driver Setup string that the user specified when initializing the driver. Some cases exist where the end-user must specify instrument driver options at initialization. An example of this is specifying a particular instrument model from among a family of instruments that the driver supports. This is useful when using simulation. The end-user can specify driver-specific options through the DriverSetup keyword in the optionsString parameter in
niscope.Session.__init__()
, or through the IVI Configuration Utility. If the user does not specify a Driver Setup string, this property returns an empty string.The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based 0 Resettable 0 Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NISCOPE_ATTR_DRIVER_SETUP
enable_dc_restore¶
niscope.Session.
enable_dc_restore
¶Restores the video-triggered data retrieved by the digitizer to the video signal’s zero reference point. Valid Values: True - Enable DC restore False - Disable DC restore
The following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggering:Trigger Video:Enable DC Restore
- C Attribute: NISCOPE_ATTR_ENABLE_DC_RESTORE
enable_time_interleaved_sampling¶
niscope.Session.
enable_time_interleaved_sampling
¶Specifies whether the digitizer acquires the waveform using multiple ADCs for the channel enabling a higher maximum real-time sampling rate. Valid Values: True (1) - Use multiple interleaved ADCs on this channel False (0) - Use only this channel’s ADC to acquire data for this channel
Tip
This property can use repeated capabilities (channels). If set or get directly on the niscope.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an niscope.Session repeated capabilities container, and calling set/get value on the result.:
session.channels[0,1].enable_time_interleaved_sampling = var var = session.channels[0,1].enable_time_interleaved_samplingThe following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based True Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Horizontal:Enable Time Interleaved Sampling
- C Attribute: NISCOPE_ATTR_ENABLE_TIME_INTERLEAVED_SAMPLING
end_of_acquisition_event_output_terminal¶
niscope.Session.
end_of_acquisition_event_output_terminal
¶Specifies the destination for the End of Acquisition Event. When this event is asserted, the digitizer has completed sampling for all records. Consult your device documentation for a specific list of valid destinations.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Synchronization:End of Acquisition:Output Terminal
- C Attribute: NISCOPE_ATTR_END_OF_ACQUISITION_EVENT_OUTPUT_TERMINAL
end_of_record_event_output_terminal¶
niscope.Session.
end_of_record_event_output_terminal
¶Specifies the destination for the End of Record Event. When this event is asserted, the digitizer has completed sampling for the current record. Consult your device documentation for a specific list of valid destinations.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Synchronization:End of Record:Output Terminal
- C Attribute: NISCOPE_ATTR_END_OF_RECORD_EVENT_OUTPUT_TERMINAL
end_of_record_to_advance_trigger_holdoff¶
niscope.Session.
end_of_record_to_advance_trigger_holdoff
¶End of Record to Advance Trigger Holdoff is the length of time (in seconds) that a device waits between the completion of one record and the acquisition of pre-trigger samples for the next record. During this time, the acquisition engine state delays the transition to the Wait for Advance Trigger state, and will not store samples in onboard memory, accept an Advance Trigger, or trigger on the input signal.. Supported Devices: NI 5185/5186
The following table lists the characteristics of this property.
Characteristic Value Datatype float in seconds or datetime.timedelta Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggering:End of Record to Advance Trigger Holdoff
- C Attribute: NISCOPE_ATTR_END_OF_RECORD_TO_ADVANCE_TRIGGER_HOLDOFF
equalization_filter_enabled¶
niscope.Session.
equalization_filter_enabled
¶Enables the onboard signal processing FIR block. This block is connected directly to the input signal. This filter is designed to compensate the input signal for artifacts introduced to the signal outside of the digitizer. However, since this is a generic FIR filter any coefficients are valid. Coefficients should be between +1 and -1 in value.
Tip
This property can use repeated capabilities (channels). If set or get directly on the niscope.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an niscope.Session repeated capabilities container, and calling set/get value on the result.:
session.channels[0,1].equalization_filter_enabled = var var = session.channels[0,1].equalization_filter_enabledThe following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based True Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Onboard Signal Processing:Equalization:Equalization Filter Enabled
- C Attribute: NISCOPE_ATTR_EQUALIZATION_FILTER_ENABLED
equalization_num_coefficients¶
niscope.Session.
equalization_num_coefficients
¶Returns the number of coefficients that the FIR filter can accept. This filter is designed to compensate the input signal for artifacts introduced to the signal outside of the digitizer. However, since this is a generic FIR filter any coefficients are valid. Coefficients should be between +1 and -1 in value.
Tip
This property can use repeated capabilities (channels). If set or get directly on the niscope.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an niscope.Session repeated capabilities container, and calling set/get value on the result.:
var = session.channels[0,1].equalization_num_coefficientsThe following table lists the characteristics of this property.
Characteristic Value Datatype int Permissions read only Channel Based True Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Onboard Signal Processing:Equalization:Equalization Num Coefficients
- C Attribute: NISCOPE_ATTR_EQUALIZATION_NUM_COEFFICIENTS
exported_advance_trigger_output_terminal¶
niscope.Session.
exported_advance_trigger_output_terminal
¶Specifies the destination to export the advance trigger. When the advance trigger is received, the digitizer begins acquiring samples for the Nth record. Consult your device documentation for a specific list of valid destinations.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Synchronization:Advance Trigger:Output Terminal
- C Attribute: NISCOPE_ATTR_EXPORTED_ADVANCE_TRIGGER_OUTPUT_TERMINAL
exported_ref_trigger_output_terminal¶
niscope.Session.
exported_ref_trigger_output_terminal
¶Specifies the destination export for the reference (stop) trigger. Consult your device documentation for a specific list of valid destinations.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggering:Trigger Output Terminal
- C Attribute: NISCOPE_ATTR_EXPORTED_REF_TRIGGER_OUTPUT_TERMINAL
exported_start_trigger_output_terminal¶
niscope.Session.
exported_start_trigger_output_terminal
¶Specifies the destination to export the Start trigger. When the start trigger is received, the digitizer begins acquiring samples. Consult your device documentation for a specific list of valid destinations.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Synchronization:Start Trigger (Acq. Arm):Output Terminal
- C Attribute: NISCOPE_ATTR_EXPORTED_START_TRIGGER_OUTPUT_TERMINAL
flex_fir_antialias_filter_type¶
niscope.Session.
flex_fir_antialias_filter_type
¶The NI 5922 flexible-resolution digitizer uses an onboard FIR lowpass antialias filter. Use this property to select from several types of filters to achieve desired filtering characteristics.
Tip
This property can use repeated capabilities (channels). If set or get directly on the niscope.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an niscope.Session repeated capabilities container, and calling set/get value on the result.:
session.channels[0,1].flex_fir_antialias_filter_type = var var = session.channels[0,1].flex_fir_antialias_filter_typeThe following table lists the characteristics of this property.
Characteristic Value Datatype enums.FlexFIRAntialiasFilterType Permissions read-write Channel Based True Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Vertical:Advanced:Flex FIR Antialias Filter Type
- C Attribute: NISCOPE_ATTR_FLEX_FIR_ANTIALIAS_FILTER_TYPE
fpga_bitfile_path¶
niscope.Session.
fpga_bitfile_path
¶Gets the absolute file path to the bitfile loaded on the FPGA.
Note
Gets the absolute file path to the bitfile loaded on the FPGA.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Device:FPGA Bitfile Path
- C Attribute: NISCOPE_ATTR_FPGA_BITFILE_PATH
high_pass_filter_frequency¶
niscope.Session.
high_pass_filter_frequency
¶Specifies the frequency for the highpass filter in Hz. The device uses one of the valid values listed below. If an invalid value is specified, no coercion occurs. The default value is 0. (PXIe-5164) Valid Values: 0 90 450 Related topics: Digital Filtering
The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Vertical:Advanced:High Pass Filter Frequency
- C Attribute: NISCOPE_ATTR_HIGH_PASS_FILTER_FREQUENCY
horz_enforce_realtime¶
niscope.Session.
horz_enforce_realtime
¶Indicates whether the digitizer enforces real-time measurements or allows equivalent-time measurements.
The following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Horizontal:Enforce Realtime
- C Attribute: NISCOPE_ATTR_HORZ_ENFORCE_REALTIME
horz_min_num_pts¶
niscope.Session.
horz_min_num_pts
¶Specifies the minimum number of points you require in the waveform record for each channel. NI-SCOPE uses the value you specify to configure the record length that the digitizer uses for waveform acquisition.
niscope.Session.horz_record_length
returns the actual record length. Valid Values: 1 - available onboard memoryThe following table lists the characteristics of this property.
Characteristic Value Datatype int Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Horizontal:Min Number of Points
- C Attribute: NISCOPE_ATTR_HORZ_MIN_NUM_PTS
horz_num_records¶
niscope.Session.
horz_num_records
¶Specifies the number of records to acquire. Can be used for multi-record acquisition and single-record acquisitions. Setting this to 1 indicates a single-record acquisition.
The following table lists the characteristics of this property.
Characteristic Value Datatype int Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Horizontal:Number of Records
- C Attribute: NISCOPE_ATTR_HORZ_NUM_RECORDS
horz_record_length¶
niscope.Session.
horz_record_length
¶Returns the actual number of points the digitizer acquires for each channel. The value is equal to or greater than the minimum number of points you specify with
niscope.Session.horz_min_num_pts
. Allocate a ViReal64 array of this size or greater to pass as the WaveformArray parameter of the Read and Fetch methods. This property is only valid after a call to the one of the Configure Horizontal methods.The following table lists the characteristics of this property.
Characteristic Value Datatype int Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Horizontal:Actual Record Length
- C Attribute: NISCOPE_ATTR_HORZ_RECORD_LENGTH
horz_record_ref_position¶
niscope.Session.
horz_record_ref_position
¶Specifies the position of the Reference Event in the waveform record. When the digitizer detects a trigger, it waits the length of time the
niscope.Session.trigger_delay_time
property specifies. The event that occurs when the delay time elapses is the Reference Event. The Reference Event is relative to the start of the record and is a percentage of the record length. For example, the value 50.0 corresponds to the center of the waveform record and 0.0 corresponds to the first element in the waveform record. Valid Values: 0.0 - 100.0The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Horizontal:Reference Position
- C Attribute: NISCOPE_ATTR_HORZ_RECORD_REF_POSITION
horz_sample_rate¶
niscope.Session.
horz_sample_rate
¶Returns the effective sample rate using the current configuration. The units are samples per second. This property is only valid after a call to the one of the Configure Horizontal methods. Units: Hertz (Samples / Second)
The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Horizontal:Actual Sample Rate
- C Attribute: NISCOPE_ATTR_HORZ_SAMPLE_RATE
horz_time_per_record¶
niscope.Session.
horz_time_per_record
¶Specifies the length of time that corresponds to the record length. Units: Seconds
The following table lists the characteristics of this property.
Characteristic Value Datatype float in seconds or datetime.timedelta Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Horizontal:Advanced:Time Per Record
- C Attribute: NISCOPE_ATTR_HORZ_TIME_PER_RECORD
input_clock_source¶
niscope.Session.
input_clock_source
¶Specifies the input source for the PLL reference clock (the 1 MHz to 20 MHz clock on the NI 5122, the 10 MHz clock for the NI 5112/5620/5621/5911) to which the digitizer will be phase-locked; for the NI 5102, this is the source of the board clock.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Clocking:Reference (Input) Clock Source
- C Attribute: NISCOPE_ATTR_INPUT_CLOCK_SOURCE
input_impedance¶
niscope.Session.
input_impedance
¶Specifies the input impedance for the channel in Ohms.
Tip
This property can use repeated capabilities (channels). If set or get directly on the niscope.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an niscope.Session repeated capabilities container, and calling set/get value on the result.:
session.channels[0,1].input_impedance = var var = session.channels[0,1].input_impedanceThe following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based True Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Vertical:Input Impedance
- C Attribute: NISCOPE_ATTR_INPUT_IMPEDANCE
instrument_firmware_revision¶
niscope.Session.
instrument_firmware_revision
¶A string that contains the firmware revision information for the instrument you are currently using.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Inherent IVI Attributes:Instrument Identification:Firmware Revision
- C Attribute: NISCOPE_ATTR_INSTRUMENT_FIRMWARE_REVISION
instrument_manufacturer¶
niscope.Session.
instrument_manufacturer
¶A string that contains the name of the instrument manufacturer.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Inherent IVI Attributes:Instrument Identification:Manufacturer
- C Attribute: NISCOPE_ATTR_INSTRUMENT_MANUFACTURER
instrument_model¶
niscope.Session.
instrument_model
¶A string that contains the model number of the current instrument.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Inherent IVI Attributes:Instrument Identification:Model
- C Attribute: NISCOPE_ATTR_INSTRUMENT_MODEL
interleaving_offset_correction_enabled¶
niscope.Session.
interleaving_offset_correction_enabled
¶Enables the interleaving offset correction on the specified channel. The default value is TRUE. Related topics: Timed Interleaved Sampling
Note
If disabled, warranted specifications are not guaranteed.
The following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Vertical:Advanced:Interleaving Offset Correction Enabled
- C Attribute: NISCOPE_ATTR_INTERLEAVING_OFFSET_CORRECTION_ENABLED
io_resource_descriptor¶
niscope.Session.
io_resource_descriptor
¶Indicates the resource descriptor the driver uses to identify the physical device. If you initialize the driver with a logical name, this property contains the resource descriptor that corresponds to the entry in the IVI Configuration utility. If you initialize the instrument driver with the resource descriptor, this property contains that value.You can pass a logical name to
niscope.Session.Init()
orniscope.Session.__init__()
. The IVI Configuration utility must contain an entry for the logical name. The logical name entry refers to a virtual instrument section in the IVI Configuration file. The virtual instrument section specifies a physical device and initial user options.Note
One or more of the referenced methods are not in the Python API for this driver.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Inherent IVI Attributes:Advanced Session Information:Resource Descriptor
- C Attribute: NISCOPE_ATTR_IO_RESOURCE_DESCRIPTOR
logical_name¶
niscope.Session.
logical_name
¶A string containing the logical name you specified when opening the current IVI session. You can pass a logical name to
niscope.Session.Init()
orniscope.Session.__init__()
. The IVI Configuration utility must contain an entry for the logical name. The logical name entry refers to a virtual instrument section in the IVI Configuration file. The virtual instrument section specifies a physical device and initial user options.Note
One or more of the referenced methods are not in the Python API for this driver.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Inherent IVI Attributes:Advanced Session Information:Logical Name
- C Attribute: NISCOPE_ATTR_LOGICAL_NAME
master_enable¶
niscope.Session.
master_enable
¶Specifies whether you want the device to be a master or a slave. The master typically originates the trigger signal and clock sync pulse. For a standalone device, set this property to False.
The following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Synchronization:Master Enable
- C Attribute: NISCOPE_ATTR_MASTER_ENABLE
max_input_frequency¶
niscope.Session.
max_input_frequency
¶Specifies the bandwidth of the channel. Express this value as the frequency at which the input circuitry attenuates the input signal by 3 dB. The units are hertz. Defined Values:
NISCOPE_VAL_BANDWIDTH_FULL
(-1.0)NISCOPE_VAL_BANDWIDTH_DEVICE_DEFAULT
(0.0)NISCOPE_VAL_20MHZ_BANDWIDTH
(20000000.0)NISCOPE_VAL_100MHZ_BANDWIDTH
(100000000.0)NISCOPE_VAL_20MHZ_MAX_INPUT_FREQUENCY
(20000000.0)NISCOPE_VAL_100MHZ_MAX_INPUT_FREQUENCY
(100000000.0)Note
One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.
Tip
This property can use repeated capabilities (channels). If set or get directly on the niscope.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an niscope.Session repeated capabilities container, and calling set/get value on the result.:
session.channels[0,1].max_input_frequency = var var = session.channels[0,1].max_input_frequencyThe following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based True Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Vertical:Maximum Input Frequency
- C Attribute: NISCOPE_ATTR_MAX_INPUT_FREQUENCY
max_real_time_sampling_rate¶
niscope.Session.
max_real_time_sampling_rate
¶Returns the maximum real time sample rate in Hz.
The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Horizontal:Maximum Real Time Sample Rate
- C Attribute: NISCOPE_ATTR_MAX_REAL_TIME_SAMPLING_RATE
max_ris_rate¶
niscope.Session.
max_ris_rate
¶Returns the maximum sample rate in RIS mode in Hz.
The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Horizontal:Maximum RIS Rate
- C Attribute: NISCOPE_ATTR_MAX_RIS_RATE
min_sample_rate¶
niscope.Session.
min_sample_rate
¶Specify the sampling rate for the acquisition in Samples per second. Valid Values: The combination of sampling rate and min record length must allow the digitizer to sample at a valid sampling rate for the acquisition type specified in
niscope.Session.ConfigureAcquisition()
and not require more memory than the onboard memory module allows.Note
One or more of the referenced methods are not in the Python API for this driver.
The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based False Resettable Yes Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Horizontal:Min Sample Rate
- C Attribute: NISCOPE_ATTR_MIN_SAMPLE_RATE
onboard_memory_size¶
niscope.Session.
onboard_memory_size
¶Returns the total combined amount of onboard memory for all channels in bytes.
The following table lists the characteristics of this property.
Characteristic Value Datatype int Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Horizontal:Memory Size
- C Attribute: NISCOPE_ATTR_ONBOARD_MEMORY_SIZE
output_clock_source¶
niscope.Session.
output_clock_source
¶Specifies the output source for the 10 MHz clock to which another digitizer’s sample clock can be phased-locked.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Clocking:Output Clock Source
- C Attribute: NISCOPE_ATTR_OUTPUT_CLOCK_SOURCE
pll_lock_status¶
niscope.Session.
pll_lock_status
¶If TRUE, the PLL has remained locked to the external reference clock since it was last checked. If FALSE, the PLL has become unlocked from the external reference clock since it was last checked.
The following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Clocking:PLL Lock Status
- C Attribute: NISCOPE_ATTR_PLL_LOCK_STATUS
points_done¶
niscope.Session.
points_done
¶Actual number of samples acquired in the record specified by
niscope.Session.fetch_record_number
from theniscope.Session.fetch_relative_to
andniscope.Session.fetch_offset
properties.The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Fetch:Points Done
- C Attribute: NISCOPE_ATTR_POINTS_DONE
poll_interval¶
niscope.Session.
poll_interval
¶Specifies the poll interval in milliseconds to use during RIS acquisitions to check whether the acquisition is complete.
The following table lists the characteristics of this property.
Characteristic Value Datatype int Permissions read-write Channel Based 0 Resettable 0 Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- C Attribute: NISCOPE_ATTR_POLL_INTERVAL
probe_attenuation¶
niscope.Session.
probe_attenuation
¶Specifies the probe attenuation for the input channel. For example, for a 10:1 probe, set this property to 10.0. Valid Values: Any positive real number. Typical values are 1, 10, and 100.
Tip
This property can use repeated capabilities (channels). If set or get directly on the niscope.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an niscope.Session repeated capabilities container, and calling set/get value on the result.:
session.channels[0,1].probe_attenuation = var var = session.channels[0,1].probe_attenuationThe following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based True Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Vertical:Probe Attenuation
- C Attribute: NISCOPE_ATTR_PROBE_ATTENUATION
ready_for_advance_event_output_terminal¶
niscope.Session.
ready_for_advance_event_output_terminal
¶Specifies the destination for the Ready for Advance Event. When this event is asserted, the digitizer is ready to receive an advance trigger. Consult your device documentation for a specific list of valid destinations.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Synchronization:Ready for Advance:Output Terminal
- C Attribute: NISCOPE_ATTR_READY_FOR_ADVANCE_EVENT_OUTPUT_TERMINAL
ready_for_ref_event_output_terminal¶
niscope.Session.
ready_for_ref_event_output_terminal
¶Specifies the destination for the Ready for Reference Event. When this event is asserted, the digitizer is ready to receive a reference trigger. Consult your device documentation for a specific list of valid destinations.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Synchronization:Ready for Reference:Output Terminal
- C Attribute: NISCOPE_ATTR_READY_FOR_REF_EVENT_OUTPUT_TERMINAL
ready_for_start_event_output_terminal¶
niscope.Session.
ready_for_start_event_output_terminal
¶Specifies the destination for the Ready for Start Event. When this event is asserted, the digitizer is ready to receive a start trigger. Consult your device documentation for a specific list of valid destinations.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Synchronization:Ready for Start:Output Terminal
- C Attribute: NISCOPE_ATTR_READY_FOR_START_EVENT_OUTPUT_TERMINAL
records_done¶
niscope.Session.
records_done
¶Specifies the number of records that have been completely acquired.
The following table lists the characteristics of this property.
Characteristic Value Datatype int Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Fetch:Records Done
- C Attribute: NISCOPE_ATTR_RECORDS_DONE
record_arm_source¶
niscope.Session.
record_arm_source
¶Specifies the record arm source.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Synchronization:Record Arm Source
- C Attribute: NISCOPE_ATTR_RECORD_ARM_SOURCE
ref_clk_rate¶
niscope.Session.
ref_clk_rate
¶If
niscope.Session.input_clock_source
is an external source, this property specifies the frequency of the input, or reference clock, to which the internal sample clock timebase is synchronized. The frequency is in hertz.The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Clocking:Reference Clock Rate
- C Attribute: NISCOPE_ATTR_REF_CLK_RATE
ref_trigger_detector_location¶
niscope.Session.
ref_trigger_detector_location
¶Indicates which analog compare circuitry to use on the device.
The following table lists the characteristics of this property.
Characteristic Value Datatype enums.RefTriggerDetectorLocation Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggering:Onboard Signal Processing:Ref Trigger Detection Location
- C Attribute: NISCOPE_ATTR_REF_TRIGGER_DETECTOR_LOCATION
ref_trigger_minimum_quiet_time¶
niscope.Session.
ref_trigger_minimum_quiet_time
¶The amount of time the trigger circuit must not detect a signal above the trigger level before the trigger is armed. This property is useful for triggering at the beginning and not in the middle of signal bursts.
The following table lists the characteristics of this property.
Characteristic Value Datatype float in seconds or datetime.timedelta Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggering:Onboard Signal Processing:Ref Trigger Min Quiet Time
- C Attribute: NISCOPE_ATTR_REF_TRIGGER_MINIMUM_QUIET_TIME
ref_trig_tdc_enable¶
niscope.Session.
ref_trig_tdc_enable
¶This property controls whether the TDC is used to compute an accurate trigger.
The following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Horizontal:Advanced:Enable TDC
- C Attribute: NISCOPE_ATTR_REF_TRIG_TDC_ENABLE
resolution¶
niscope.Session.
resolution
¶Indicates the bit width of valid data (as opposed to padding bits) in the acquired waveform. Compare to
niscope.Session.binary_sample_width
.The following table lists the characteristics of this property.
Characteristic Value Datatype int Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Acquisition:Resolution
- C Attribute: NISCOPE_ATTR_RESOLUTION
ris_in_auto_setup_enable¶
niscope.Session.
ris_in_auto_setup_enable
¶Indicates whether the digitizer should use RIS sample rates when searching for a frequency in autosetup. Valid Values: True (1) - Use RIS sample rates in autosetup False (0) - Do not use RIS sample rates in autosetup
The following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Acquisition:Advanced:Enable RIS in Auto Setup
- C Attribute: NISCOPE_ATTR_RIS_IN_AUTO_SETUP_ENABLE
ris_method¶
niscope.Session.
ris_method
¶Specifies the algorithm for random-interleaved sampling, which is used if the sample rate exceeds the value of
niscope.Session.max_real_time_sampling_rate
.The following table lists the characteristics of this property.
Characteristic Value Datatype enums.RISMethod Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Horizontal:RIS Method
- C Attribute: NISCOPE_ATTR_RIS_METHOD
ris_num_averages¶
niscope.Session.
ris_num_averages
¶The number of averages for each bin in an RIS acquisition. The number of averages times the oversampling factor is the minimum number of real-time acquisitions necessary to reconstruct the RIS waveform. Averaging is useful in RIS because the trigger times are not evenly spaced, so adjacent points in the reconstructed waveform not be accurately spaced. By averaging, the errors in both time and voltage are smoothed.
The following table lists the characteristics of this property.
Characteristic Value Datatype int Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Horizontal:RIS Num Avg
- C Attribute: NISCOPE_ATTR_RIS_NUM_AVERAGES
sample_clock_timebase_multiplier¶
niscope.Session.
sample_clock_timebase_multiplier
¶If Sample Clock Timebase Source <p:py:meth:`niscope.Session.SampleClockTimebaseSource.html>`__ is an external source, this property specifies the ratio between the Sample Clock Timebase Rate <p:py:meth:`niscope.Session.SampleClockTimebaseRate.html>`__ and the actual sample rate, which can be higher. This property can be used in conjunction with the Sample Clock Timebase Divisor Property <p:py:meth:`niscope.Session.SampleClockTimebaseDivisor.html>`__. Some devices use multiple ADCs to sample the same channel at an effective sample rate that is greater than the specified clock rate. When providing an external sample clock use this property to indicate when you want a higher sample rate. Valid values for this property vary by device and current configuration. Related topics: Sample Clock
Note
One or more of the referenced methods are not in the Python API for this driver.
The following table lists the characteristics of this property.
Characteristic Value Datatype int Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Clocking:Sample Clock Timebase Multiplier
- C Attribute: NISCOPE_ATTR_SAMPLE_CLOCK_TIMEBASE_MULTIPLIER
sample_mode¶
niscope.Session.
sample_mode
¶Indicates the sample mode the digitizer is currently using.
The following table lists the characteristics of this property.
Characteristic Value Datatype int Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Acquisition:Sample Mode
- C Attribute: NISCOPE_ATTR_SAMPLE_MODE
samp_clk_timebase_div¶
niscope.Session.
samp_clk_timebase_div
¶If
niscope.Session.samp_clk_timebase_src
is an external source, specifies the ratio between the sample clock timebase rate and the actual sample rate, which can be slower.The following table lists the characteristics of this property.
Characteristic Value Datatype int Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Clocking:Sample Clock Timebase Divisor
- C Attribute: NISCOPE_ATTR_SAMP_CLK_TIMEBASE_DIV
samp_clk_timebase_rate¶
niscope.Session.
samp_clk_timebase_rate
¶If
niscope.Session.samp_clk_timebase_src
is an external source, specifies the frequency in hertz of the external clock used as the timebase source.The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Clocking:Sample Clock Timebase Rate
- C Attribute: NISCOPE_ATTR_SAMP_CLK_TIMEBASE_RATE
samp_clk_timebase_src¶
niscope.Session.
samp_clk_timebase_src
¶Specifies the source of the sample clock timebase, which is the timebase used to control waveform sampling. The actual sample rate may be the timebase itself or a divided version of the timebase, depending on the
niscope.Session.min_sample_rate
(for internal sources) or theniscope.Session.samp_clk_timebase_div
(for external sources).The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Clocking:Sample Clock Timebase Source
- C Attribute: NISCOPE_ATTR_SAMP_CLK_TIMEBASE_SRC
serial_number¶
niscope.Session.
serial_number
¶Returns the serial number of the device.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Device:Serial Number
- C Attribute: NISCOPE_ATTR_SERIAL_NUMBER
simulate¶
niscope.Session.
simulate
¶Specifies whether or not to simulate instrument driver I/O operations. If simulation is enabled, instrument driver methods perform range checking and call Ivi_GetAttribute and Ivi_SetAttribute methods, but they do not perform instrument I/O. For output parameters that represent instrument data, the instrument driver methods return calculated values. The default value is False. Use the
niscope.Session.__init__()
method to override this value.The following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Inherent IVI Attributes:User Options:Simulate
- C Attribute: NISCOPE_ATTR_SIMULATE
specific_driver_description¶
niscope.Session.
specific_driver_description
¶A string that contains a brief description of the specific driver
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Inherent IVI Attributes:Driver Identification:Description
- C Attribute: NISCOPE_ATTR_SPECIFIC_DRIVER_DESCRIPTION
specific_driver_revision¶
niscope.Session.
specific_driver_revision
¶A string that contains additional version information about this instrument driver.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Inherent IVI Attributes:Driver Identification:Revision
- C Attribute: NISCOPE_ATTR_SPECIFIC_DRIVER_REVISION
specific_driver_vendor¶
niscope.Session.
specific_driver_vendor
¶A string that contains the name of the vendor that supplies this driver.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Inherent IVI Attributes:Driver Identification:Driver Vendor
- C Attribute: NISCOPE_ATTR_SPECIFIC_DRIVER_VENDOR
start_to_ref_trigger_holdoff¶
niscope.Session.
start_to_ref_trigger_holdoff
¶Pass the length of time you want the digitizer to wait after it starts acquiring data until the digitizer enables the trigger system to detect a reference (stop) trigger. Units: Seconds Valid Values: 0.0 - 171.8
Tip
This property can use repeated capabilities (channels). If set or get directly on the niscope.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an niscope.Session repeated capabilities container, and calling set/get value on the result.:
session.channels[0,1].start_to_ref_trigger_holdoff = var var = session.channels[0,1].start_to_ref_trigger_holdoffThe following table lists the characteristics of this property.
Characteristic Value Datatype float in seconds or datetime.timedelta Permissions read-write Channel Based True Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggering:Start To Ref Trigger Holdoff
- C Attribute: NISCOPE_ATTR_START_TO_REF_TRIGGER_HOLDOFF
supported_instrument_models¶
niscope.Session.
supported_instrument_models
¶A string that contains a comma-separated list of the instrument model numbers supported by this driver.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Inherent IVI Attributes:Driver Capabilities:Supported Instrument Models
- C Attribute: NISCOPE_ATTR_SUPPORTED_INSTRUMENT_MODELS
trigger_auto_triggered¶
niscope.Session.
trigger_auto_triggered
¶Specifies if the last acquisition was auto triggered. You can use the Auto Triggered property to find out if the last acquisition was triggered.
The following table lists the characteristics of this property.
Characteristic Value Datatype bool Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggering:Auto Triggered
- C Attribute: NISCOPE_ATTR_TRIGGER_AUTO_TRIGGERED
trigger_coupling¶
niscope.Session.
trigger_coupling
¶Specifies how the digitizer couples the trigger source. This property affects instrument operation only when
niscope.Session.trigger_type
is set toEDGE
,HYSTERESIS
, orWINDOW
.The following table lists the characteristics of this property.
Characteristic Value Datatype enums.TriggerCoupling Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggering:Trigger Coupling
- C Attribute: NISCOPE_ATTR_TRIGGER_COUPLING
trigger_delay_time¶
niscope.Session.
trigger_delay_time
¶Specifies the trigger delay time in seconds. The trigger delay time is the length of time the digitizer waits after it receives the trigger. The event that occurs when the trigger delay elapses is the Reference Event. Valid Values: 0.0 - 171.8
The following table lists the characteristics of this property.
Characteristic Value Datatype float in seconds or datetime.timedelta Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggering:Trigger Delay
- C Attribute: NISCOPE_ATTR_TRIGGER_DELAY_TIME
trigger_holdoff¶
niscope.Session.
trigger_holdoff
¶Specifies the length of time (in seconds) the digitizer waits after detecting a trigger before enabling the trigger subsystem to detect another trigger. This property affects instrument operation only when the digitizer requires multiple acquisitions to build a complete waveform. The digitizer requires multiple waveform acquisitions when it uses equivalent-time sampling or when the digitizer is configured for a multi-record acquisition through a call to
niscope.Session.configure_horizontal_timing()
. Valid Values: 0.0 - 171.8The following table lists the characteristics of this property.
Characteristic Value Datatype float in seconds or datetime.timedelta Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggering:Trigger Holdoff
- C Attribute: NISCOPE_ATTR_TRIGGER_HOLDOFF
trigger_hysteresis¶
niscope.Session.
trigger_hysteresis
¶Specifies the size of the hysteresis window on either side of the trigger level. The digitizer triggers when the trigger signal passes through the threshold you specify with the Trigger Level parameter, has the slope you specify with the Trigger Slope parameter, and passes through the hysteresis window that you specify with this parameter.
The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggering:Trigger Hysteresis
- C Attribute: NISCOPE_ATTR_TRIGGER_HYSTERESIS
trigger_impedance¶
niscope.Session.
trigger_impedance
¶Specifies the input impedance for the external analog trigger channel in Ohms. Valid Values: 50 - 50 ohms 1000000 - 1 mega ohm
The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggering:Trigger Impedance
- C Attribute: NISCOPE_ATTR_TRIGGER_IMPEDANCE
trigger_level¶
niscope.Session.
trigger_level
¶Specifies the voltage threshold for the trigger subsystem. The units are volts. This property affects instrument behavior only when the
niscope.Session.trigger_type
is set toEDGE
,HYSTERESIS
, orWINDOW
. Valid Values: The values of the range and offset parameters inniscope.Session.configure_vertical()
determine the valid range for the trigger level on the channel you use as the Trigger Source. The value you pass for this parameter must meet the following conditions:The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggering:Trigger Level
- C Attribute: NISCOPE_ATTR_TRIGGER_LEVEL
trigger_modifier¶
niscope.Session.
trigger_modifier
¶Configures the device to automatically complete an acquisition if a trigger has not been received. Valid Values: None (1) - Normal triggering Auto Trigger (2) - Auto trigger acquisition if no trigger arrives
The following table lists the characteristics of this property.
Characteristic Value Datatype enums.TriggerModifier Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggering:Trigger Modifier
- C Attribute: NISCOPE_ATTR_TRIGGER_MODIFIER
trigger_slope¶
niscope.Session.
trigger_slope
¶Specifies if a rising or a falling edge triggers the digitizer. This property affects instrument operation only when
niscope.Session.trigger_type
is set toEDGE
,HYSTERESIS
, orWINDOW
.The following table lists the characteristics of this property.
Characteristic Value Datatype enums.TriggerSlope Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggering:Trigger Slope
- C Attribute: NISCOPE_ATTR_TRIGGER_SLOPE
trigger_source¶
niscope.Session.
trigger_source
¶Specifies the source the digitizer monitors for the trigger event.
The following table lists the characteristics of this property.
Characteristic Value Datatype str Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggering:Trigger Source
- C Attribute: NISCOPE_ATTR_TRIGGER_SOURCE
trigger_type¶
niscope.Session.
trigger_type
¶Specifies the type of trigger to use.
The following table lists the characteristics of this property.
Characteristic Value Datatype enums.TriggerType Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggering:Trigger Type
- C Attribute: NISCOPE_ATTR_TRIGGER_TYPE
trigger_window_high_level¶
niscope.Session.
trigger_window_high_level
¶Pass the upper voltage threshold you want the digitizer to use for window triggering. The digitizer triggers when the trigger signal enters or leaves the window you specify with
niscope.Session.trigger_window_low_level
andniscope.Session.trigger_window_high_level
Valid Values: The values of the Vertical Range and Vertical Offset parameters inniscope.Session.configure_vertical()
determine the valid range for the High Window Level on the channel you use as the Trigger Source parameter inniscope.Session.ConfigureTriggerSource()
. The value you pass for this parameter must meet the following conditions. High Trigger Level <= Vertical Range/2 + Vertical Offset High Trigger Level >= (-Vertical Range/2) + Vertical Offset High Trigger Level > Low Trigger LevelNote
One or more of the referenced methods are not in the Python API for this driver.
The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggering:Trigger Window:High Level
- C Attribute: NISCOPE_ATTR_TRIGGER_WINDOW_HIGH_LEVEL
trigger_window_low_level¶
niscope.Session.
trigger_window_low_level
¶Pass the lower voltage threshold you want the digitizer to use for window triggering. The digitizer triggers when the trigger signal enters or leaves the window you specify with
niscope.Session.trigger_window_low_level
andniscope.Session.trigger_window_high_level
. Units: Volts Valid Values: The values of the Vertical Range and Vertical Offset parameters inniscope.Session.configure_vertical()
determine the valid range for the Low Window Level on the channel you use as the Trigger Source parameter inniscope.Session.ConfigureTriggerSource()
. The value you pass for this parameter must meet the following conditions. Low Trigger Level <= Vertical Range/2 + Vertical Offset Low Trigger Level >= (-Vertical Range/2) + Vertical Offset Low Trigger Level < High Trigger LevelNote
One or more of the referenced methods are not in the Python API for this driver.
The following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggering:Trigger Window:Low Level
- C Attribute: NISCOPE_ATTR_TRIGGER_WINDOW_LOW_LEVEL
trigger_window_mode¶
niscope.Session.
trigger_window_mode
¶Specifies whether you want a trigger to occur when the signal enters or leaves the window specified by
niscope.Session.trigger_window_low_level
, orniscope.Session.trigger_window_high_level
.The following table lists the characteristics of this property.
Characteristic Value Datatype enums.TriggerWindowMode Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggering:Trigger Window:Window Mode
- C Attribute: NISCOPE_ATTR_TRIGGER_WINDOW_MODE
tv_trigger_event¶
niscope.Session.
tv_trigger_event
¶Specifies the condition in the video signal that causes the digitizer to trigger.
The following table lists the characteristics of this property.
Characteristic Value Datatype enums.VideoTriggerEvent Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggering:Trigger Video:Event
- C Attribute: NISCOPE_ATTR_TV_TRIGGER_EVENT
tv_trigger_line_number¶
niscope.Session.
tv_trigger_line_number
¶Specifies the line on which to trigger, if
niscope.Session.tv_trigger_event
is set to line number. The valid ranges of the property depend on the signal format selected. M-NTSC has a valid range of 1 to 525. B/G-PAL, SECAM, 576i, and 576p have a valid range of 1 to 625. 720p has a valid range of 1 to 750. 1080i and 1080p have a valid range of 1125.The following table lists the characteristics of this property.
Characteristic Value Datatype int Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggering:Trigger Video:Line Number
- C Attribute: NISCOPE_ATTR_TV_TRIGGER_LINE_NUMBER
tv_trigger_polarity¶
niscope.Session.
tv_trigger_polarity
¶Specifies whether the video signal sync is positive or negative.
The following table lists the characteristics of this property.
Characteristic Value Datatype enums.VideoPolarity Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggering:Trigger Video:Polarity
- C Attribute: NISCOPE_ATTR_TV_TRIGGER_POLARITY
tv_trigger_signal_format¶
niscope.Session.
tv_trigger_signal_format
¶Specifies the type of video signal, such as NTSC, PAL, or SECAM.
Tip
This property can use repeated capabilities (channels). If set or get directly on the niscope.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an niscope.Session repeated capabilities container, and calling set/get value on the result.:
session.channels[0,1].tv_trigger_signal_format = var var = session.channels[0,1].tv_trigger_signal_formatThe following table lists the characteristics of this property.
Characteristic Value Datatype enums.VideoSignalFormat Permissions read-write Channel Based True Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Triggering:Trigger Video:Signal Format
- C Attribute: NISCOPE_ATTR_TV_TRIGGER_SIGNAL_FORMAT
vertical_coupling¶
niscope.Session.
vertical_coupling
¶Specifies how the digitizer couples the input signal for the channel. When input coupling changes, the input stage takes a finite amount of time to settle.
Tip
This property can use repeated capabilities (channels). If set or get directly on the niscope.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an niscope.Session repeated capabilities container, and calling set/get value on the result.:
session.channels[0,1].vertical_coupling = var var = session.channels[0,1].vertical_couplingThe following table lists the characteristics of this property.
Characteristic Value Datatype enums.VerticalCoupling Permissions read-write Channel Based True Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Vertical:Vertical Coupling
- C Attribute: NISCOPE_ATTR_VERTICAL_COUPLING
vertical_offset¶
niscope.Session.
vertical_offset
¶Specifies the location of the center of the range. The value is with respect to ground and is in volts. For example, to acquire a sine wave that spans between 0.0 and 10.0 V, set this property to 5.0 V.
Note
This property is not supported by all digitizers.Refer to the NI High-Speed Digitizers Help for a list of vertical offsets supported for each device.
Tip
This property can use repeated capabilities (channels). If set or get directly on the niscope.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an niscope.Session repeated capabilities container, and calling set/get value on the result.:
session.channels[0,1].vertical_offset = var var = session.channels[0,1].vertical_offsetThe following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based True Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Vertical:Vertical Offset
- C Attribute: NISCOPE_ATTR_VERTICAL_OFFSET
vertical_range¶
niscope.Session.
vertical_range
¶Specifies the absolute value of the input range for a channel in volts. For example, to acquire a sine wave that spans between -5 and +5 V, set this property to 10.0 V. Refer to the NI High-Speed Digitizers Help for a list of supported vertical ranges for each device. If the specified range is not supported by a device, the value is coerced up to the next valid range.
Tip
This property can use repeated capabilities (channels). If set or get directly on the niscope.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an niscope.Session repeated capabilities container, and calling set/get value on the result.:
session.channels[0,1].vertical_range = var var = session.channels[0,1].vertical_rangeThe following table lists the characteristics of this property.
Characteristic Value Datatype float Permissions read-write Channel Based True Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Vertical:Vertical Range
- C Attribute: NISCOPE_ATTR_VERTICAL_RANGE
Methods¶
abort¶
niscope.Session.
abort
()¶Aborts an acquisition and returns the digitizer to the Idle state. Call this method if the digitizer times out waiting for a trigger.
acquisition_status¶
niscope.Session.
acquisition_status
()¶Returns status information about the acquisition to the status output parameter.
Return type: niscope.AcquisitionStatus
Returns: Returns whether the acquisition is complete, in progress, or unknown. Defined Values
auto_setup¶
niscope.Session.
auto_setup
()¶Automatically configures the instrument. When you call this method, the digitizer senses the input signal and automatically configures many of the instrument settings. If a signal is detected on a channel, the driver chooses the smallest available vertical range that is larger than the signal range. For example, if the signal is a 1.2 Vpk-pk sine wave, and the device supports 1 V and 2 V vertical ranges, the driver will choose the 2 V vertical range for that channel.
If no signal is found on any analog input channel, a warning is returned, and all channels are enabled. A channel is considered to have a signal present if the signal is at least 10% of the smallest vertical range available for that channel.
The following settings are changed:
General Acquisition mode Normal Reference clock Internal Vertical Vertical coupling AC (DC for NI 5621) Vertical bandwidth Full Vertical range Changed by auto setup Vertical offset 0 V Probe attenuation Unchanged by auto setup Input impedance Unchanged by auto setup Horizontal Sample rate Changed by auto setup Min record length Changed by auto setup Enforce realtime True Number of Records Changed to 1 Triggering Trigger type Edge if signal present, otherwise immediate Trigger channel Lowest numbered channel with a signal present Trigger slope Positive Trigger coupling DC Reference position 50% Trigger level 50% of signal on trigger channel Trigger delay 0 Trigger holdoff 0 Trigger output None
commit¶
niscope.Session.
commit
()¶Commits to hardware all the parameter settings associated with the task. Use this method if you want a parameter change to be immediately reflected in the hardware. This method is not supported for Traditional NI-DAQ (Legacy) devices.
configure_chan_characteristics¶
niscope.Session.
configure_chan_characteristics
(input_impedance, max_input_frequency)¶Configures the properties that control the electrical characteristics of the channel—the input impedance and the bandwidth.
Tip
This method requires repeated capabilities (channels). If called directly on the niscope.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an niscope.Session repeated capabilities container, and calling this method on the result.:
session.channels[0,1].configure_chan_characteristics(input_impedance, max_input_frequency)
Parameters:
- input_impedance (float) – The input impedance for the channel; NI-SCOPE sets
niscope.Session.input_impedance
to this value.- max_input_frequency (float) – The bandwidth for the channel; NI-SCOPE sets
niscope.Session.max_input_frequency
to this value. Pass 0 for this value to use the hardware default bandwidth. Pass –1 for this value to achieve full bandwidth.
configure_equalization_filter_coefficients¶
niscope.Session.
configure_equalization_filter_coefficients
(coefficients)¶Configures the custom coefficients for the equalization FIR filter on the device. This filter is designed to compensate the input signal for artifacts introduced to the signal outside of the digitizer. Because this filter is a generic FIR filter, any coefficients are valid. Coefficient values should be between +1 and –1.
Tip
This method requires repeated capabilities (channels). If called directly on the niscope.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an niscope.Session repeated capabilities container, and calling this method on the result.:
session.channels[0,1].configure_equalization_filter_coefficients(coefficients)
Parameters: coefficients (list of float) – The custom coefficients for the equalization FIR filter on the device. These coefficients should be between +1 and –1. You can obtain the number of coefficients from the :py:data:`niscope.Session.equalization_num_coefficients <cvi:py:data:niscope.Session.equalization_num_coefficients.html>`__ property. The :py:data:`niscope.Session.equalization_filter_enabled <cvi:py:data:niscope.Session.equalization_filter_enabled.html>`__ property must be set to TRUE to enable the filter.
configure_horizontal_timing¶
niscope.Session.
configure_horizontal_timing
(min_sample_rate, min_num_pts, ref_position, num_records, enforce_realtime)¶Configures the common properties of the horizontal subsystem for a multirecord acquisition in terms of minimum sample rate.
Parameters:
- min_sample_rate (float) – The sampling rate for the acquisition. Refer to
niscope.Session.min_sample_rate
for more information.- min_num_pts (int) –
The minimum number of points you need in the record for each channel; call
niscope.Session.ActualRecordLength()
to obtain the actual record length used.Valid Values: Greater than 1; limited by available memory
Note
One or more of the referenced methods are not in the Python API for this driver.
- ref_position (float) – The position of the Reference Event in the waveform record specified as a percentage.
- num_records (int) – The number of records to acquire
- enforce_realtime (bool) –
Indicates whether the digitizer enforces real-time measurements or allows equivalent-time (RIS) measurements; not all digitizers support RIS—refer to Features Supported by Device for more information.
Default value: True
Defined Values
True—Allow real-time acquisitions only
False—Allow real-time and equivalent-time acquisitions
configure_trigger_digital¶
niscope.Session.
configure_trigger_digital
(trigger_source, slope=niscope.TriggerSlope.POSITIVE, holdoff=datetime.timedelta(seconds=0.0), delay=datetime.timedelta(seconds=0.0))¶Configures the common properties of a digital trigger.
When you initiate an acquisition, the digitizer waits for the start trigger, which is configured through the
niscope.Session.acq_arm_source
(Start Trigger Source) property. The default is immediate. Upon receiving the start trigger the digitizer begins sampling pretrigger points. After the digitizer finishes sampling pretrigger points, the digitizer waits for a reference (stop) trigger that you specify with a method such as this one. Upon receiving the reference trigger the digitizer finishes the acquisition after completing posttrigger sampling. With each Configure Trigger method, you specify configuration parameters such as the trigger source and the amount of trigger delay.Note
For multirecord acquisitions, all records after the first record are started by using the Advance Trigger Source. The default is immediate.
You can adjust the amount of pre-trigger and post-trigger samples using the reference position parameter on the
niscope.Session.configure_horizontal_timing()
method. The default is half of the record length.Some features are not supported by all digitizers. Refer to Features Supported by Device for more information.
Digital triggering is not supported in RIS mode.
Parameters:
- trigger_source (str) – Specifies the trigger source. Refer to
niscope.Session.trigger_source
for defined values.- slope (
niscope.TriggerSlope
) – Specifies whether you want a rising edge or a falling edge to trigger the digitizer. Refer toniscope.Session.trigger_slope
for more information.- holdoff (float in seconds or datetime.timedelta) – The length of time the digitizer waits after detecting a trigger before enabling NI-SCOPE to detect another trigger. Refer to
niscope.Session.trigger_holdoff
for more information.- delay (float in seconds or datetime.timedelta) – How long the digitizer waits after receiving the trigger to start acquiring data. Refer to
niscope.Session.trigger_delay_time
for more information.
configure_trigger_edge¶
niscope.Session.
configure_trigger_edge
(trigger_source, level, trigger_coupling, slope=niscope.TriggerSlope.POSITIVE, holdoff=datetime.timedelta(seconds=0.0), delay=datetime.timedelta(seconds=0.0))¶Configures common properties for analog edge triggering.
When you initiate an acquisition, the digitizer waits for the start trigger, which is configured through the
niscope.Session.acq_arm_source
(Start Trigger Source) property. The default is immediate. Upon receiving the start trigger the digitizer begins sampling pretrigger points. After the digitizer finishes sampling pretrigger points, the digitizer waits for a reference (stop) trigger that you specify with a method such as this one. Upon receiving the reference trigger the digitizer finishes the acquisition after completing posttrigger sampling. With each Configure Trigger method, you specify configuration parameters such as the trigger source and the amount of trigger delay.Note
Some features are not supported by all digitizers. Refer to Features Supported by Device for more information.
Parameters:
- trigger_source (str) – Specifies the trigger source. Refer to
niscope.Session.trigger_source
for defined values.- level (float) – The voltage threshold for the trigger. Refer to
niscope.Session.trigger_level
for more information.- trigger_coupling (
niscope.TriggerCoupling
) – Applies coupling and filtering options to the trigger signal. Refer toniscope.Session.trigger_coupling
for more information.- slope (
niscope.TriggerSlope
) – Specifies whether you want a rising edge or a falling edge to trigger the digitizer. Refer toniscope.Session.trigger_slope
for more information.- holdoff (float in seconds or datetime.timedelta) – The length of time the digitizer waits after detecting a trigger before enabling NI-SCOPE to detect another trigger. Refer to
niscope.Session.trigger_holdoff
for more information.- delay (float in seconds or datetime.timedelta) – How long the digitizer waits after receiving the trigger to start acquiring data. Refer to
niscope.Session.trigger_delay_time
for more information.
configure_trigger_hysteresis¶
niscope.Session.
configure_trigger_hysteresis
(trigger_source, level, hysteresis, trigger_coupling, slope=niscope.TriggerSlope.POSITIVE, holdoff=datetime.timedelta(seconds=0.0), delay=datetime.timedelta(seconds=0.0))¶Configures common properties for analog hysteresis triggering. This kind of trigger specifies an additional value, specified in the hysteresis parameter, that a signal must pass through before a trigger can occur. This additional value acts as a kind of buffer zone that keeps noise from triggering an acquisition.
When you initiate an acquisition, the digitizer waits for the start trigger, which is configured through the
niscope.Session.acq_arm_source
. The default is immediate. Upon receiving the start trigger the digitizer begins sampling pretrigger points. After the digitizer finishes sampling pretrigger points, the digitizer waits for a reference (stop) trigger that you specify with a method such as this one. Upon receiving the reference trigger the digitizer finishes the acquisition after completing posttrigger sampling. With each Configure Trigger method, you specify configuration parameters such as the trigger source and the amount of trigger delay.Note
Some features are not supported by all digitizers. Refer to Features Supported by Device for more information.
Parameters:
- trigger_source (str) – Specifies the trigger source. Refer to
niscope.Session.trigger_source
for defined values.- level (float) – The voltage threshold for the trigger. Refer to
niscope.Session.trigger_level
for more information.- hysteresis (float) – The size of the hysteresis window on either side of the level in volts; the digitizer triggers when the trigger signal passes through the hysteresis value you specify with this parameter, has the slope you specify with slope, and passes through the level. Refer to
niscope.Session.trigger_hysteresis
for defined values.- trigger_coupling (
niscope.TriggerCoupling
) – Applies coupling and filtering options to the trigger signal. Refer toniscope.Session.trigger_coupling
for more information.- slope (
niscope.TriggerSlope
) – Specifies whether you want a rising edge or a falling edge to trigger the digitizer. Refer toniscope.Session.trigger_slope
for more information.- holdoff (float in seconds or datetime.timedelta) – The length of time the digitizer waits after detecting a trigger before enabling NI-SCOPE to detect another trigger. Refer to
niscope.Session.trigger_holdoff
for more information.- delay (float in seconds or datetime.timedelta) – How long the digitizer waits after receiving the trigger to start acquiring data. Refer to
niscope.Session.trigger_delay_time
for more information.
configure_trigger_immediate¶
niscope.Session.
configure_trigger_immediate
()¶Configures common properties for immediate triggering. Immediate triggering means the digitizer triggers itself.
When you initiate an acquisition, the digitizer waits for a trigger. You specify the type of trigger that the digitizer waits for with a Configure Trigger method, such as
niscope.Session.configure_trigger_immediate()
.
configure_trigger_software¶
niscope.Session.
configure_trigger_software
(holdoff=datetime.timedelta(seconds=0.0), delay=datetime.timedelta(seconds=0.0))¶Configures common properties for software triggering.
When you initiate an acquisition, the digitizer waits for the start trigger, which is configured through the
niscope.Session.acq_arm_source
(Start Trigger Source) property. The default is immediate. Upon receiving the start trigger the digitizer begins sampling pretrigger points. After the digitizer finishes sampling pretrigger points, the digitizer waits for a reference (stop) trigger that you specify with a method such as this one. Upon receiving the reference trigger the digitizer finishes the acquisition after completing posttrigger sampling. With each Configure Trigger method, you specify configuration parameters such as the trigger source and the amount of trigger delay.To trigger the acquisition, use
niscope.Session.send_software_trigger_edge()
.Note
Some features are not supported by all digitizers. Refer to Features Supported by Device for more information.
Parameters:
- holdoff (float in seconds or datetime.timedelta) – The length of time the digitizer waits after detecting a trigger before enabling NI-SCOPE to detect another trigger. Refer to
niscope.Session.trigger_holdoff
for more information.- delay (float in seconds or datetime.timedelta) – How long the digitizer waits after receiving the trigger to start acquiring data. Refer to
niscope.Session.trigger_delay_time
for more information.
configure_trigger_video¶
niscope.Session.
configure_trigger_video
(trigger_source, signal_format, event, polarity, trigger_coupling, enable_dc_restore=False, line_number=1, holdoff=datetime.timedelta(seconds=0.0), delay=datetime.timedelta(seconds=0.0))¶Configures the common properties for video triggering, including the signal format, TV event, line number, polarity, and enable DC restore. A video trigger occurs when the digitizer finds a valid video signal sync.
When you initiate an acquisition, the digitizer waits for the start trigger, which is configured through the
niscope.Session.acq_arm_source
(Start Trigger Source) property. The default is immediate. Upon receiving the start trigger the digitizer begins sampling pretrigger points. After the digitizer finishes sampling pretrigger points, the digitizer waits for a reference (stop) trigger that you specify with a method such as this one. Upon receiving the reference trigger the digitizer finishes the acquisition after completing posttrigger sampling. With each Configure Trigger method, you specify configuration parameters such as the trigger source and the amount of trigger delay.Note
Some features are not supported by all digitizers. Refer to Features Supported by Device for more information.
Parameters:
- trigger_source (str) – Specifies the trigger source. Refer to
niscope.Session.trigger_source
for defined values.- signal_format (
niscope.VideoSignalFormat
) – Specifies the type of video signal sync the digitizer should look for. Refer toniscope.Session.tv_trigger_signal_format
for more information.- event (
niscope.VideoTriggerEvent
) – Specifies the TV event you want to trigger on. You can trigger on a specific or on the next coming line or field of the signal.- polarity (
niscope.VideoPolarity
) – Specifies the polarity of the video signal sync.- trigger_coupling (
niscope.TriggerCoupling
) – Applies coupling and filtering options to the trigger signal. Refer toniscope.Session.trigger_coupling
for more information.- enable_dc_restore (bool) – Offsets each video line so the clamping level (the portion of the video line between the end of the color burst and the beginning of the active image) is moved to zero volt. Refer to
niscope.Session.enable_dc_restore
for defined values.- line_number (int) –
Selects the line number to trigger on. The line number range covers an entire frame and is referenced as shown on Vertical Blanking and Synchronization Signal. Refer to
niscope.Session.tv_trigger_line_number
for more information.Default value: 1
- holdoff (float in seconds or datetime.timedelta) – The length of time the digitizer waits after detecting a trigger before enabling NI-SCOPE to detect another trigger. Refer to
niscope.Session.trigger_holdoff
for more information.- delay (float in seconds or datetime.timedelta) – How long the digitizer waits after receiving the trigger to start acquiring data. Refer to
niscope.Session.trigger_delay_time
for more information.
configure_trigger_window¶
niscope.Session.
configure_trigger_window
(trigger_source, low_level, high_level, window_mode, trigger_coupling, holdoff=datetime.timedelta(seconds=0.0), delay=datetime.timedelta(seconds=0.0))¶Configures common properties for analog window triggering. A window trigger occurs when a signal enters or leaves a window you specify with the high level or low level parameters.
When you initiate an acquisition, the digitizer waits for the start trigger, which is configured through the
niscope.Session.acq_arm_source
(Start Trigger Source) property. The default is immediate. Upon receiving the start trigger the digitizer begins sampling pretrigger points. After the digitizer finishes sampling pretrigger points, the digitizer waits for a reference (stop) trigger that you specify with a method such as this one. Upon receiving the reference trigger the digitizer finishes the acquisition after completing posttrigger sampling. With each Configure Trigger method, you specify configuration parameters such as the trigger source and the amount of trigger delay.To trigger the acquisition, use
niscope.Session.send_software_trigger_edge()
.Note
Some features are not supported by all digitizers. Refer to Features Supported by Device for more information.
Parameters:
- trigger_source (str) – Specifies the trigger source. Refer to
niscope.Session.trigger_source
for defined values.- low_level (float) – Passes the voltage threshold you want the digitizer to use for low triggering.
- high_level (float) – Passes the voltage threshold you want the digitizer to use for high triggering.
- window_mode (
niscope.TriggerWindowMode
) – Specifies whether you want the trigger to occur when the signal enters or leaves a window.- trigger_coupling (
niscope.TriggerCoupling
) – Applies coupling and filtering options to the trigger signal. Refer toniscope.Session.trigger_coupling
for more information.- holdoff (float in seconds or datetime.timedelta) – The length of time the digitizer waits after detecting a trigger before enabling NI-SCOPE to detect another trigger. Refer to
niscope.Session.trigger_holdoff
for more information.- delay (float in seconds or datetime.timedelta) – How long the digitizer waits after receiving the trigger to start acquiring data. Refer to
niscope.Session.trigger_delay_time
for more information.
configure_vertical¶
niscope.Session.
configure_vertical
(range, coupling, offset=0.0, probe_attenuation=1.0, enabled=True)¶Configures the most commonly configured properties of the digitizer vertical subsystem, such as the range, offset, coupling, probe attenuation, and the channel.
Tip
This method requires repeated capabilities (channels). If called directly on the niscope.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an niscope.Session repeated capabilities container, and calling this method on the result.:
session.channels[0,1].configure_vertical(range, coupling, offset=0.0, probe_attenuation=1.0, enabled=True)
Parameters:
- range (float) – Specifies the vertical range Refer to
niscope.Session.vertical_range
for more information.- coupling (
niscope.VerticalCoupling
) – Specifies how to couple the input signal. Refer toniscope.Session.vertical_coupling
for more information.- offset (float) – Specifies the vertical offset. Refer to
niscope.Session.vertical_offset
for more information.- probe_attenuation (float) – Specifies the probe attenuation. Refer to
niscope.Session.probe_attenuation
for valid values.- enabled (bool) – Specifies whether the channel is enabled for acquisition. Refer to
niscope.Session.channel_enabled
for more information.
disable¶
niscope.Session.
disable
()¶Aborts any current operation, opens data channel relays, and releases RTSI and PFI lines.
fetch¶
niscope.Session.
fetch
(num_samples=None, relative_to=niscope.FetchRelativeTo.PRETRIGGER, offset=0, record_number=0, num_records=None, timeout=datetime.timedelta(seconds=5.0))¶Returns the waveform from a previously initiated acquisition that the digitizer acquires for the specified channel. This method returns scaled voltage waveforms.
This method may return multiple waveforms depending on the number of channels, the acquisition type, and the number of records you specify.
Note
Some functionality, such as time stamping, is not supported in all digitizers.
Tip
This method requires repeated capabilities (channels). If called directly on the niscope.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an niscope.Session repeated capabilities container, and calling this method on the result.:
session.channels[0,1].fetch(num_samples=None, relative_to=niscope.FetchRelativeTo.PRETRIGGER, offset=0, record_number=0, num_records=None, timeout=datetime.timedelta(seconds=5.0))
Parameters:
- num_samples (int) – The maximum number of samples to fetch for each waveform. If the acquisition finishes with fewer points than requested, some devices return partial data if the acquisition finished, was aborted, or a timeout of 0 was used. If it fails to complete within the timeout period, the method raises.
- relative_to (
niscope.FetchRelativeTo
) – Position to start fetching within one record.- offset (int) – Offset in samples to start fetching data within each record. The offset can be positive or negative.
- record_number (int) – Zero-based index of the first record to fetch.
- num_records (int) – Number of records to fetch. Use -1 to fetch all configured records.
- timeout (float or datetime.timedelta) – The time to wait for data to be acquired; using 0 for this parameter tells NI-SCOPE to fetch whatever is currently available. Using -1 seconds for this parameter implies infinite timeout.
Return type: list of WaveformInfo
Returns: Returns an array of classes with the following timing and scaling information about each waveform:
relative_initial_x (float) the time (in seconds) from the trigger to the first sample in the fetched waveform
absolute_initial_x (float) timestamp (in seconds) of the first fetched sample. This timestamp is comparable between records and acquisitions; devices that do not support this parameter use 0 for this output.
x_increment (float) the time between points in the acquired waveform in seconds
channel (str) channel name this waveform was asquire from
record (int) record number of this waveform
gain (float) the gain factor of the given channel; useful for scaling binary data with the following formula:
\[voltage = binary data * gain factor + offset\]offset (float) the offset factor of the given channel; useful for scaling binary data with the following formula:
\[voltage = binary data * gain factor + offset\]samples (array of float) floating point array of samples. Length will be of the actual samples acquired
fetch_into¶
niscope.Session.
fetch_into
(waveform, relative_to=niscope.FetchRelativeTo.PRETRIGGER, offset=0, record_number=0, num_records=None, timeout=datetime.timedelta(seconds=5.0))¶Returns the waveform from a previously initiated acquisition that the digitizer acquires for the specified channel. This method returns scaled voltage waveforms.
This method may return multiple waveforms depending on the number of channels, the acquisition type, and the number of records you specify.
Note
Some functionality, such as time stamping, is not supported in all digitizers.
Tip
This method requires repeated capabilities (channels). If called directly on the niscope.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an niscope.Session repeated capabilities container, and calling this method on the result.:
session.channels[0,1].fetch(waveform, relative_to=niscope.FetchRelativeTo.PRETRIGGER, offset=0, record_number=0, num_records=None, timeout=datetime.timedelta(seconds=5.0))
Parameters:
- waveform (array.array("d")) –
numpy array of the appropriate type and size the should be acquired as a 1D array. Size should be num_samples times number of waveforms. Call
niscope.Session._actual_num_wfms()
to determine the number of waveforms.Types supported are
- numpy.float64
- numpy.int8
- numpy.in16
- numpy.int32
Example:
waveform = numpy.ndarray(num_samples * session.actual_num_wfms(), dtype=numpy.float64) wfm_info = session['0,1'].fetch_into(num_samples, waveform, timeout=5.0)- relative_to (
niscope.FetchRelativeTo
) – Position to start fetching within one record.- offset (int) – Offset in samples to start fetching data within each record.The offset can be positive or negative.
- record_number (int) – Zero-based index of the first record to fetch.
- num_records (int) – Number of records to fetch. Use -1 to fetch all configured records.
- timeout (float) – The time to wait in seconds for data to be acquired; using 0 for this parameter tells NI-SCOPE to fetch whatever is currently available. Using -1 for this parameter implies infinite timeout.
Return type: list of WaveformInfo
Returns: Returns an array of classed with the following timing and scaling information about each waveform:
relative_initial_x (float) the time (in seconds) from the trigger to the first sample in the fetched waveform
absolute_initial_x (float) timestamp (in seconds) of the first fetched sample. This timestamp is comparable between records and acquisitions; devices that do not support this parameter use 0 for this output.
x_increment (float) the time between points in the acquired waveform in seconds
channel (str) channel name this waveform was asquire from
record (int) record number of this waveform
gain (float) the gain factor of the given channel; useful for scaling binary data with the following formula:
\[voltage = binary data * gain factor + offset\]offset (float) the offset factor of the given channel; useful for scaling binary data with the following formula:
\[voltage = binary data * gain factor + offset\]samples (array of float) floating point array of samples. Length will be of the actual samples acquired
get_equalization_filter_coefficients¶
niscope.Session.
get_equalization_filter_coefficients
()¶Retrieves the custom coefficients for the equalization FIR filter on the device. This filter is designed to compensate the input signal for artifacts introduced to the signal outside of the digitizer. Because this filter is a generic FIR filter, any coefficients are valid. Coefficient values should be between +1 and –1.
Tip
This method requires repeated capabilities (channels). If called directly on the niscope.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an niscope.Session repeated capabilities container, and calling this method on the result.:
session.channels[0,1].get_equalization_filter_coefficients()
lock¶
-
niscope.Session.
lock
()¶ Obtains a multithread lock on the device session. Before doing so, the software waits until all other execution threads release their locks on the device session.
Other threads may have obtained a lock on this session for the following reasons:
- The application called the
niscope.Session.lock()
method. - A call to NI-SCOPE locked the session.
- After a call to the
niscope.Session.lock()
method returns successfully, no other threads can access the device session until you call theniscope.Session.unlock()
method or exit out of the with block when using lock context manager. - Use the
niscope.Session.lock()
method and theniscope.Session.unlock()
method around a sequence of calls to instrument driver methods if you require that the device retain its settings through the end of the sequence.
You can safely make nested calls to the
niscope.Session.lock()
method within the same thread. To completely unlock the session, you must balance each call to theniscope.Session.lock()
method with a call to theniscope.Session.unlock()
method.One method for ensuring there are the same number of unlock method calls as there is lock calls is to use lock as a context manager
with niscope.Session('dev1') as session: with session.lock(): # Calls to session within a single lock context
The first with block ensures the session is closed regardless of any exceptions raised
The second with block ensures that unlock is called regardless of any exceptions raised
Return type: context manager Returns: When used in a with statement, niscope.Session.lock()
acts as a context manager and unlock will be called when the with block is exited- The application called the
probe_compensation_signal_start¶
niscope.Session.
probe_compensation_signal_start
()¶Starts the 1 kHz square wave output on PFI 1 for probe compensation.
probe_compensation_signal_stop¶
niscope.Session.
probe_compensation_signal_stop
()¶Stops the 1 kHz square wave output on PFI 1 for probe compensation.
read¶
niscope.Session.
read
(num_samples=None, relative_to=niscope.FetchRelativeTo.PRETRIGGER, offset=0, record_number=0, num_records=None, timeout=datetime.timedelta(seconds=5.0))¶Initiates an acquisition, waits for it to complete, and retrieves the data. The process is similar to calling
niscope.Session._initiate_acquisition()
,niscope.Session.acquisition_status()
, andniscope.Session.fetch()
. The only difference is that withniscope.Session.read()
, you enable all channels specified with channelList before the acquisition; in the other method, you enable the channels withniscope.Session.configure_vertical()
.This method may return multiple waveforms depending on the number of channels, the acquisition type, and the number of records you specify.
Note
Some functionality, such as time stamping, is not supported in all digitizers.
Tip
This method requires repeated capabilities (channels). If called directly on the niscope.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an niscope.Session repeated capabilities container, and calling this method on the result.:
session.channels[0,1].read(num_samples=None, relative_to=niscope.FetchRelativeTo.PRETRIGGER, offset=0, record_number=0, num_records=None, timeout=datetime.timedelta(seconds=5.0))
Parameters:
- num_samples (int) – The maximum number of samples to fetch for each waveform. If the acquisition finishes with fewer points than requested, some devices return partial data if the acquisition finished, was aborted, or a timeout of 0 was used. If it fails to complete within the timeout period, the method raises.
- relative_to (
niscope.FetchRelativeTo
) – Position to start fetching within one record.- offset (int) – Offset in samples to start fetching data within each record. The offset can be positive or negative.
- record_number (int) – Zero-based index of the first record to fetch.
- num_records (int) – Number of records to fetch. Use -1 to fetch all configured records.
- timeout (float or datetime.timedelta) – The time to wait for data to be acquired; using 0 for this parameter tells NI-SCOPE to fetch whatever is currently available. Using -1 seconds for this parameter implies infinite timeout.
Return type: list of WaveformInfo
Returns: Returns an array of classes with the following timing and scaling information about each waveform:
relative_initial_x (float) the time (in seconds) from the trigger to the first sample in the fetched waveform
absolute_initial_x (float) timestamp (in seconds) of the first fetched sample. This timestamp is comparable between records and acquisitions; devices that do not support this parameter use 0 for this output.
x_increment (float) the time between points in the acquired waveform in seconds
channel (str) channel name this waveform was asquire from
record (int) record number of this waveform
gain (float) the gain factor of the given channel; useful for scaling binary data with the following formula:
\[voltage = binary data * gain factor + offset\]offset (float) the offset factor of the given channel; useful for scaling binary data with the following formula:
\[voltage = binary data * gain factor + offset\]samples (array of float) floating point array of samples. Length will be of the actual samples acquired
reset¶
niscope.Session.
reset
()¶Stops the acquisition, releases routes, and all session properties are reset to their default states.
reset_device¶
niscope.Session.
reset_device
()¶Performs a hard reset of the device. Acquisition stops, all routes are released, RTSI and PFI lines are tristated, hardware is configured to its default state, and all session properties are reset to their default state.
reset_with_defaults¶
niscope.Session.
reset_with_defaults
()¶Performs a software reset of the device, returning it to the default state and applying any initial default settings from the IVI Configuration Store.
self_cal¶
niscope.Session.
self_cal
(option=niscope.Option.SELF_CALIBRATE_ALL_CHANNELS)¶Self-calibrates most NI digitizers, including all SMC-based devices and most Traditional NI-DAQ (Legacy) devices. To verify that your digitizer supports self-calibration, refer to Features Supported by Device.
For SMC-based digitizers, if the self-calibration is performed successfully in a regular session, the calibration constants are immediately stored in the self-calibration area of the EEPROM. If the self-calibration is performed in an external calibration session, the calibration constants take effect immediately for the duration of the session. However, they are not stored in the EEPROM until
niscope.Session.CalEnd()
is called with action set toNISCOPE_VAL_ACTION_STORE
and no errors occur.Note
One or more of the referenced methods are not in the Python API for this driver.
Note
One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.
Tip
This method requires repeated capabilities (channels). If called directly on the niscope.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an niscope.Session repeated capabilities container, and calling this method on the result.:
session.channels[0,1].self_cal(option=niscope.Option.SELF_CALIBRATE_ALL_CHANNELS)
Parameters: option ( niscope.Option
) –The calibration option. Use VI_NULL for a normal self-calibration operation or
NISCOPE_VAL_CAL_RESTORE_EXTERNAL_CALIBRATION
to restore the previous calibration.Note
One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.
self_test¶
niscope.Session.
self_test
()¶Runs the instrument self-test routine and returns the test result(s). Refer to the device-specific help topics for an explanation of the message contents.
Raises SelfTestError on self test failure. Properties on exception object:
- code - failure code from driver
- message - status message from driver
Self-Test Code Description 0 Passed self-test 1 Self-test failed
send_software_trigger_edge¶
niscope.Session.
send_software_trigger_edge
(which_trigger)¶Sends the selected trigger to the digitizer. Call this method if you called
niscope.Session.configure_trigger_software()
when you want the Reference trigger to occur. You can also call this method to override a misused edge, digital, or hysteresis trigger. If you have configuredniscope.Session.acq_arm_source
,niscope.Session.arm_ref_trig_src
, orniscope.Session.adv_trig_src
, call this method when you want to send the corresponding trigger to the digitizer.
Parameters: which_trigger ( niscope.WhichTrigger
) –Specifies the type of trigger to send to the digitizer.
Defined Values
unlock¶
-
niscope.Session.
unlock
()¶ Releases a lock that you acquired on an device session using
niscope.Session.lock()
. Refer toniscope.Session.unlock()
for additional information on session locks.