niscope.Session properties¶
-
niscope.Session.
adjust_pretrigger_samples_5102
¶ When set to true and the digitizer is set to master, the number of pretrigger samples and total samples are adjusted to be able to synchronize a master and slave 5102.
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:5102 Adjust Pretrigger Samples
- C Attribute: NISCOPE_ATTR_5102_ADJUST_PRETRIGGER_SAMPLES
-
niscope.Session.
five_v_out_output_terminal
¶ Specifies the destination for the 5 Volt signal. 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:5 Volt Power:Output Terminal
- C Attribute: NISCOPE_ATTR_5V_OUT_OUTPUT_TERMINAL
-
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
-
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 (usually channels). If set or get directly on the accessory_gain.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 accessory_gain.Session instance, and calling set/get value on the result.:
session['0,1'].accessory_gain = var var = session['0,1'].accessory_gain
The 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
-
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 (usually channels). If set or get directly on the accessory_offset.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 accessory_offset.Session instance, and calling set/get value on the result.:
session['0,1'].accessory_offset = var var = session['0,1'].accessory_offset
The 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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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 (usually channels). If set or get directly on the bandpass_filter_enabled.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 bandpass_filter_enabled.Session instance, and calling set/get value on the result.:
session['0,1'].bandpass_filter_enabled = var var = session['0,1'].bandpass_filter_enabled
The 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
-
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
-
niscope.Session.
cache
¶ Specifies whether to cache the value of properties. When caching is enabled, the instrument driver keeps track of the current instrument settings and avoids sending redundant commands to the instrument. Thus, you can significantly increase execution speed. The instrument driver can choose to always cache or to never cache particular properties regardless of the setting of this property. The default value is True. Use
niscope.Session.__init__()
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:Cache
- C Attribute: NISCOPE_ATTR_CACHE
-
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
-
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 (usually channels). If set or get directly on the channel_enabled.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 channel_enabled.Session instance, and calling set/get value on the result.:
session['0,1'].channel_enabled = var var = session['0,1'].channel_enabled
The 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
-
niscope.Session.
channel_terminal_configuration
¶ Specifies the terminal configuration for the channel.
Tip
This property can use repeated capabilities (usually channels). If set or get directly on the channel_terminal_configuration.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 channel_terminal_configuration.Session instance, and calling set/get value on the result.:
session['0,1'].channel_terminal_configuration = var var = session['0,1'].channel_terminal_configuration
The 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
-
niscope.Session.
clock_sync_pulse_source
¶ For the NI 5102, specifies the line on which the sample clock is sent or received. For the NI 5112/5620/5621/5911, specifies the line on which the one-time sync pulse is sent or received. This line should be the same for all devices to be synchronized.
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:Clock Sync Pulse Source
- C Attribute: NISCOPE_ATTR_CLOCK_SYNC_PULSE_SOURCE
-
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
-
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
-
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
-
niscope.Session.
ddc_center_frequency
¶ The frequency at which the DDC block frequency translates the input data. Default Value: 10 MHz
Tip
This property can use repeated capabilities (usually channels). If set or get directly on the ddc_center_frequency.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 ddc_center_frequency.Session instance, and calling set/get value on the result.:
session['0,1'].ddc_center_frequency = var var = session['0,1'].ddc_center_frequency
The 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: Onboard Signal Processing:DDC:Center Frequency
- C Attribute: NISCOPE_ATTR_DDC_CENTER_FREQUENCY
-
niscope.Session.
ddc_data_processing_mode
¶ The way in which data is processed by the DDC block. Valid Values: Real (0) Complex (1) Default Value: Complex
The following table lists the characteristics of this property.
Characteristic Value Datatype enums.DataProcessingMode Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Onboard Signal Processing:DDC:Data Processing Mode
- C Attribute: NISCOPE_ATTR_DDC_DATA_PROCESSING_MODE
-
niscope.Session.
ddc_enabled
¶ Enables/disables the Digital Down Converter (DDC) block of the digitizer. When the DDC block is disabled, all DDC-related properties are disabled and have no effect on the acquired signal. Default Value: False
Tip
This property can use repeated capabilities (usually channels). If set or get directly on the ddc_enabled.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 ddc_enabled.Session instance, and calling set/get value on the result.:
session['0,1'].ddc_enabled = var var = session['0,1'].ddc_enabled
The 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:DDC:DDC Enabled
- C Attribute: NISCOPE_ATTR_DDC_ENABLED
-
niscope.Session.
ddc_frequency_translation_enabled
¶ Enables/disables frequency translating the data around the user-selected center frequency down to baseband. Default Value: True
Tip
This property can use repeated capabilities (usually channels). If set or get directly on the ddc_frequency_translation_enabled.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 ddc_frequency_translation_enabled.Session instance, and calling set/get value on the result.:
session['0,1'].ddc_frequency_translation_enabled = var var = session['0,1'].ddc_frequency_translation_enabled
The 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:DDC:Frequency Translation Enabled
- C Attribute: NISCOPE_ATTR_DDC_FREQUENCY_TRANSLATION_ENABLED
-
niscope.Session.
ddc_frequency_translation_phase_i
¶ The I center frequency phase in degrees at the first point of the acquisition. Default Value: 0
Tip
This property can use repeated capabilities (usually channels). If set or get directly on the ddc_frequency_translation_phase_i.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 ddc_frequency_translation_phase_i.Session instance, and calling set/get value on the result.:
session['0,1'].ddc_frequency_translation_phase_i = var var = session['0,1'].ddc_frequency_translation_phase_i
The 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: Onboard Signal Processing:DDC:Signal Adjustments:Frequency Translation:Frequency Translation Phase I
- C Attribute: NISCOPE_ATTR_DDC_FREQUENCY_TRANSLATION_PHASE_I
-
niscope.Session.
ddc_frequency_translation_phase_q
¶ The Q center frequency phase in degrees at the first point of the acquisition. Use this property only when
niscope.Session.ddc_data_processing_mode
is set to Complex. Default Value: 90Tip
This property can use repeated capabilities (usually channels). If set or get directly on the ddc_frequency_translation_phase_q.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 ddc_frequency_translation_phase_q.Session instance, and calling set/get value on the result.:
session['0,1'].ddc_frequency_translation_phase_q = var var = session['0,1'].ddc_frequency_translation_phase_q
The 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: Onboard Signal Processing:DDC:Signal Adjustments:Frequency Translation:Frequency Translation Phase Q
- C Attribute: NISCOPE_ATTR_DDC_FREQUENCY_TRANSLATION_PHASE_Q
-
niscope.Session.
ddc_q_source
¶ Indicates the channel that is the input of the Q path of the DDC. Default Value: The channel that the property is configured off of.
Tip
This property can use repeated capabilities (usually channels). If set or get directly on the ddc_q_source.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 ddc_q_source.Session instance, and calling set/get value on the result.:
session['0,1'].ddc_q_source = var var = session['0,1'].ddc_q_source
The following table lists the characteristics of this property.
Characteristic Value Datatype str 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:DDC:Q Source
- C Attribute: NISCOPE_ATTR_DDC_Q_SOURCE
-
niscope.Session.
device_number
¶ Indicates the device number associated with the current session.
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: Device Specific:IF Digitizer (5620 and 5621):Advanced:Device Number
- C Attribute: NISCOPE_ATTR_DEVICE_NUMBER
-
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
-
niscope.Session.
digital_gain
¶ Applies gain to the specified channel in hardware before any onboard processing. Valid Values: -1.5 to 1.5
Tip
This property can use repeated capabilities (usually channels). If set or get directly on the digital_gain.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 digital_gain.Session instance, and calling set/get value on the result.:
session['0,1'].digital_gain = var var = session['0,1'].digital_gain
The 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:Advanced:Digital Gain
- C Attribute: NISCOPE_ATTR_DIGITAL_GAIN
-
niscope.Session.
digital_offset
¶ Applies offset to the specified channel in hardware before any onboard processing. Valid Values: -1.5 to 1.5 V
Tip
This property can use repeated capabilities (usually channels). If set or get directly on the digital_offset.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 digital_offset.Session instance, and calling set/get value on the result.:
session['0,1'].digital_offset = var var = session['0,1'].digital_offset
The 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:Advanced:Digital Offset
- C Attribute: NISCOPE_ATTR_DIGITAL_OFFSET
-
niscope.Session.
dither_enabled
¶ Enables or Disables the analog dither on the device. The default value is FALSE. Using dither can improve the spectral performance of the device by reducing the effects of quantization. However, adding dither increases the power level to the ADC, so you may need to either decrease the signal level or increase your vertical range.
Tip
This property can use repeated capabilities (usually channels). If set or get directly on the dither_enabled.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 dither_enabled.Session instance, and calling set/get value on the result.:
session['0,1'].dither_enabled = var var = session['0,1'].dither_enabled
The 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:Dither Enabled
- C Attribute: NISCOPE_ATTR_DITHER_ENABLED
-
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
-
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
-
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 (usually channels). If set or get directly on the enable_time_interleaved_sampling.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 enable_time_interleaved_sampling.Session instance, and calling set/get value on the result.:
session['0,1'].enable_time_interleaved_sampling = var var = session['0,1'].enable_time_interleaved_sampling
The 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
-
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
-
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
-
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
-
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 (usually channels). If set or get directly on the equalization_filter_enabled.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 equalization_filter_enabled.Session instance, and calling set/get value on the result.:
session['0,1'].equalization_filter_enabled = var var = session['0,1'].equalization_filter_enabled
The 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
-
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 (usually channels). If set or get directly on the equalization_num_coefficients.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 equalization_num_coefficients.Session instance, and calling set/get value on the result.:
session['0,1'].equalization_num_coefficients = var var = session['0,1'].equalization_num_coefficients
The 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
-
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
-
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
-
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
-
niscope.Session.
fetch_interleaved_data
¶ Set to True to retrieve one array with alternating values on the NI 5620/5621. For example, this property can be used to retrieve a single array with I and Q interleaved instead of two separate arrays. If set to True, the resulting array will be twice the size of the actual record length.
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: Device Specific:IF Digitizer (5620 and 5621):Advanced:Fetch Interleaved Data
- C Attribute: NISCOPE_ATTR_FETCH_INTERLEAVED_DATA
-
niscope.Session.
fetch_interleaved_iq_data
¶ Enables/disables interleaving of the I and Q data. When disabled, the traditional :py:meth:`niscope.Session.fetch`() methods will return the I waveform for each acquisition followed by the Q waveform. When enabled, the I and Q data are interleaved into a single waveform. In the interleaving case, you must allocate twice as many elements in the array as number of samples being fetched (since each sample contains an I and a Q component). Default Value: True
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: Onboard Signal Processing:DDC:Fetch Interleaved IQ Data
- C Attribute: NISCOPE_ATTR_FETCH_INTERLEAVED_IQ_DATA
-
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 (usually channels). If set or get directly on the flex_fir_antialias_filter_type.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 flex_fir_antialias_filter_type.Session instance, and calling set/get value on the result.:
session['0,1'].flex_fir_antialias_filter_type = var var = session['0,1'].flex_fir_antialias_filter_type
The 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
-
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
-
niscope.Session.
fractional_resample_enabled
¶ Enables the onboard signal processing block that resamples the input waveform to the user desired sample rate. The default value is 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: Onboard Signal Processing:Fractional Resample:Fractional Resample Enabled
- C Attribute: NISCOPE_ATTR_FRACTIONAL_RESAMPLE_ENABLED
-
niscope.Session.
group_capabilities
¶ A string that contains a comma-separated list of class extension groups that this driver implements.
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:Class Group Capabilities
- C Attribute: NISCOPE_ATTR_GROUP_CAPABILITIES
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
niscope.Session.
input_impedance
¶ Specifies the input impedance for the channel in Ohms.
Tip
This property can use repeated capabilities (usually channels). If set or get directly on the input_impedance.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 input_impedance.Session instance, and calling set/get value on the result.:
session['0,1'].input_impedance = var var = session['0,1'].input_impedance
The 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
-
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
-
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
-
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
-
niscope.Session.
interchange_check
¶ NI-SCOPE does not generate interchange warnings and therefore ignores this property.
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:Interchange Check
- C Attribute: NISCOPE_ATTR_INTERCHANGE_CHECK
-
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
-
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
-
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
-
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
-
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 (usually channels). If set or get directly on the max_input_frequency.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 max_input_frequency.Session instance, and calling set/get value on the result.:
session['0,1'].max_input_frequency = var var = session['0,1'].max_input_frequency
The 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
-
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
-
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
-
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
-
niscope.Session.
mux_mode_register
¶ 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: Device Specific:IF Digitizer (5620 and 5621):Advanced:Mux Mode
- C Attribute: NISCOPE_ATTR_MUX_MODE_REGISTER
-
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
-
niscope.Session.
oscillator_phase_dac_value
¶ Gets or sets the binary phase DAC value that controls the delay added to the Phase Locked Loop (PLL) of the sample clock.
Note
if this value is set, sample clock adjust and TClk will not be able to do any sub-sample adjustment of the timebase sample clock.
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:Advanced:Oscillator Phase DAC Value
- C Attribute: NISCOPE_ATTR_OSCILLATOR_PHASE_DAC_VALUE
-
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
-
niscope.Session.
overflow_error_reporting
¶ Configures error reporting when the DDC block detects an overflow in any of its stages. Overflows lead to clipping of the waveform. Valid Values: Warning (0) Error (1) Disabled (2) Default Value: Warning
The following table lists the characteristics of this property.
Characteristic Value Datatype enums.OverflowErrorReporting Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Onboard Signal Processing:OSP Overflow Error Reporting
- C Attribute: NISCOPE_ATTR_OVERFLOW_ERROR_REPORTING
-
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
-
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
-
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
-
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 (usually channels). If set or get directly on the probe_attenuation.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 probe_attenuation.Session instance, and calling set/get value on the result.:
session['0,1'].probe_attenuation = var var = session['0,1'].probe_attenuation
The 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
-
niscope.Session.
range_check
¶ Specifies whether to validate property values and method parameters. If enabled, the instrument driver validates the parameters values that you pass to driver methods. Range checking parameters is very useful for debugging. After you validate your program, you can set this property to False to disable range checking and maximize performance. The default value is True. 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:Range Check
- C Attribute: NISCOPE_ATTR_RANGE_CHECK
-
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
-
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
-
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
-
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
-
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
-
niscope.Session.
record_coercions
¶ Specifies whether the IVI engine keeps a list of the value coercions it makes for ViInt32 and ViReal64 properties. You call Ivi_GetNextCoercionInfo to extract and delete the oldest coercion record from the list. 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:Record Value Coercions
- C Attribute: NISCOPE_ATTR_RECORD_COERCIONS
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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. 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
-
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
-
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
-
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
-
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
-
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
-
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
-
niscope.Session.
slave_trigger_delay
¶ Specifies the delay for the trigger from the master to the slave in seconds. This value adjusts the initial X value of the slave devices to correct for the propagation delay between the master trigger output and slave trigger input.
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: Synchronization:Trigger Calibration Delay:Slave Trigger Delay
- C Attribute: NISCOPE_ATTR_SLAVE_TRIGGER_DELAY
-
niscope.Session.
specific_driver_class_spec_major_version
¶ The major version number of the class specification with which this driver is compliant.
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 Identification:Class Specification Major Version
- C Attribute: NISCOPE_ATTR_SPECIFIC_DRIVER_CLASS_SPEC_MAJOR_VERSION
-
niscope.Session.
specific_driver_class_spec_minor_version
¶ The minor version number of the class specification with which this driver is compliant.
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 Identification:Class Specification Minor Version
- C Attribute: NISCOPE_ATTR_SPECIFIC_DRIVER_CLASS_SPEC_MINOR_VERSION
-
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
-
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
-
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
-
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 (usually channels). If set or get directly on the start_to_ref_trigger_holdoff.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 start_to_ref_trigger_holdoff.Session instance, and calling set/get value on the result.:
session['0,1'].start_to_ref_trigger_holdoff = var var = session['0,1'].start_to_ref_trigger_holdoff
The 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
-
niscope.Session.
stream_relative_to
¶ Determines which trigger peer-to-peer data is streamed relative to. The default value is Start Trigger.
Note
On the NI 5122/5622, only Start Trigger is valid for this property.
The following table lists the characteristics of this property.
Characteristic Value Datatype enums.StreamingPositionType Permissions read-write Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Peer-to-Peer:Stream Relative To
- C Attribute: NISCOPE_ATTR_STREAM_RELATIVE_TO
-
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
-
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
-
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
-
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
-
niscope.Session.
trigger_from_pfi_delay
¶ This is a factory-programmed value that specifies the delay for the PFI lines to the trigger input in seconds. By itself, this property has no effect on the acquired data. However, depending on how the trigger lines are routed between the master and slave devices, you can use this value as a starting point to set
niscope.Session.slave_trigger_delay
.The following table lists the characteristics of this property.
Characteristic Value Datatype float in seconds or datetime.timedelta Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Synchronization:Trigger Calibration Delay:Trigger from PFI Delay
- C Attribute: NISCOPE_ATTR_TRIGGER_FROM_PFI_DELAY
-
niscope.Session.
trigger_from_rtsi_delay
¶ This is a factory-programmed value that specifies the delay for the RTSI bus to the trigger input in seconds. By itself, this property has no effect on the acquired data. However, depending on how the trigger lines are routed between the master and slave devices, you can use this value as a starting point to set
niscope.Session.slave_trigger_delay
.The following table lists the characteristics of this property.
Characteristic Value Datatype float in seconds or datetime.timedelta Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Synchronization:Trigger Calibration Delay:Trigger from RTSI Delay
- C Attribute: NISCOPE_ATTR_TRIGGER_FROM_RTSI_DELAY
-
niscope.Session.
trigger_from_star_delay
¶ This is a factory-programmed value that specifies the delay for PXI Star Trigger line to the trigger input in seconds. By itself, this property has no effect on the acquired data. However, depending on how the trigger lines are routed between the master and slave devices, you can use this value as a starting point to set
niscope.Session.slave_trigger_delay
.The following table lists the characteristics of this property.
Characteristic Value Datatype float in seconds or datetime.timedelta Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Synchronization:Trigger Calibration Delay:Trigger from Star Delay
- C Attribute: NISCOPE_ATTR_TRIGGER_FROM_STAR_DELAY
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
niscope.Session.
trigger_to_pfi_delay
¶ This is a factory-programmed value that specifies the delay for the trigger to the PFI lines in seconds. By itself, this property has no effect on the acquired data. However, depending on how the trigger lines are routed between the master and slave devices, you can use this value as a starting point to set
niscope.Session.slave_trigger_delay
.The following table lists the characteristics of this property.
Characteristic Value Datatype float in seconds or datetime.timedelta Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Synchronization:Trigger Calibration Delay:Trigger to PFI Delay
- C Attribute: NISCOPE_ATTR_TRIGGER_TO_PFI_DELAY
-
niscope.Session.
trigger_to_rtsi_delay
¶ This is a factory-programmed value that specifies the delay for the trigger to the RTSI bus in seconds. By itself, this property has no effect on the acquired data. However, depending on how the trigger lines are routed between the master and slave devices, you can use this value as a starting point to set
niscope.Session.slave_trigger_delay
.The following table lists the characteristics of this property.
Characteristic Value Datatype float in seconds or datetime.timedelta Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Synchronization:Trigger Calibration Delay:Trigger to RTSI Delay
- C Attribute: NISCOPE_ATTR_TRIGGER_TO_RTSI_DELAY
-
niscope.Session.
trigger_to_star_delay
¶ This is a factory-programmed value that specifies the delay for the trigger to the PXI Star Trigger line in seconds. By itself, this property has no effect on the acquired data. However, depending on how the trigger lines are routed between the master and slave devices, you can use this value as a starting point to set
niscope.Session.slave_trigger_delay
.The following table lists the characteristics of this property.
Characteristic Value Datatype float in seconds or datetime.timedelta Permissions read only Channel Based False Resettable No Tip
This property corresponds to the following LabVIEW Property or C Attribute:
- LabVIEW Property: Synchronization:Trigger Calibration Delay:Trigger to Star Delay
- C Attribute: NISCOPE_ATTR_TRIGGER_TO_STAR_DELAY
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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 (usually channels). If set or get directly on the tv_trigger_signal_format.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 tv_trigger_signal_format.Session instance, and calling set/get value on the result.:
session['0,1'].tv_trigger_signal_format = var var = session['0,1'].tv_trigger_signal_format
The 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
-
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 (usually channels). If set or get directly on the vertical_coupling.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 vertical_coupling.Session instance, and calling set/get value on the result.:
session['0,1'].vertical_coupling = var var = session['0,1'].vertical_coupling
The 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
-
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 (usually channels). If set or get directly on the vertical_offset.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 vertical_offset.Session instance, and calling set/get value on the result.:
session['0,1'].vertical_offset = var var = session['0,1'].vertical_offset
The 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
-
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 (usually channels). If set or get directly on the vertical_range.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 vertical_range.Session instance, and calling set/get value on the result.:
session['0,1'].vertical_range = var var = session['0,1'].vertical_range
The 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