niScope Read (poly)
- Updated2023-02-21
- 13 minute(s) read
niScope Read (poly)
Initiates an acquisition, waits for it to complete, and acquires data.
Related topics:
Cluster
Initiates an acquisition, waits for it to complete, and retrieves the data for a single channel and record.
![]() |
instrument handle identifies a particular instrument session. |
||||||||||||||||
![]() |
channels specifies the channel(s) from which to acquire data. For more information, refer to Channel String Syntax. |
||||||||||||||||
![]() |
numSamples is the maximum number of samples to fetch for each waveform; if the acquisition finishes with fewer points than requested, some devices return partial data if the acquisition finished, was aborted, or a timeout of 0 was used. Use –1 for this parameter if you want to fetch all available samples. The VI reads the actual record length and attempts to acquire all available samples. If it fails to complete within the timeout period, the VI returns an error. |
||||||||||||||||
![]() |
timeout is the time (in seconds) to wait for the data to be acquired. Use 0 for this parameter to tell NI-SCOPE to fetch whatever is currently available. Using -1 for this parameter implies infinite timeout. |
||||||||||||||||
![]() |
error in describes error conditions that occur before this node runs. This input provides standard error in functionality. |
||||||||||||||||
![]() |
instrument handle out has the same value as the instrument handle. |
||||||||||||||||
![]() |
wfm info contains all the timing and scaling information about the waveform.
|
||||||||||||||||
![]() |
waveform is a cluster containing the initial x value, xIincrement, and a waveform array. This output can be wired directly to the LabVIEW waveform graph, so the waveform is plotted with timing information. The initial x value in the cluster is relative to the trigger. The relative initial x value is the time from the trigger to the first point so the trigger always occurs at time equals zero.
|
||||||||||||||||
![]() |
error out contains error information. This output provides standard error out functionality. |
WDT
Returns the waveform the digitizer acquires for the specified channel. The VI initiates an acquisition that returns a scaled voltage waveform in a waveform data type that includes timing information.
![]() |
instrument handle identifies a particular instrument session. |
||||||||||||||||
![]() |
channels specifies the channel(s) from which to acquire data. For more information, refer to Channel String Syntax. |
||||||||||||||||
![]() |
numSamples is the maximum number of samples to fetch for each waveform; if the acquisition finishes with fewer points than requested, some devices return partial data if the acquisition finished, was aborted, or a timeout of 0 was used. Use –1 for this parameter if you want to fetch all available samples. The VI reads the actual record length and attempts to acquire all available samples. If it fails to complete within the timeout period, the VI returns an error. |
||||||||||||||||
![]() |
timeout is the time (in seconds) to wait for the data to be acquired. Use 0 for this parameter to tell NI-SCOPE to fetch whatever is currently available. Using -1 for this parameter implies infinite timeout. |
||||||||||||||||
![]() |
timestamp Type specifies the time basis for the timestamp on the WDT data. Defined Values absolute relative |
||||||||||||||||
![]() |
error in describes error conditions that occur before this node runs. This input provides standard error in functionality. |
||||||||||||||||
![]() |
instrument handle out has the same value as the instrument handle. |
||||||||||||||||
![]() |
wfm info contains all the timing and scaling information about the waveform.
|
||||||||||||||||
![]() |
wfm returns data for wiring to a graph, including the timing information. |
||||||||||||||||
![]() |
error out contains error information. This output provides standard error out functionality. |
1D Cluster
Initiates an acquisition, waits for it to complete, and retrieves the data for multiple channels and records.
![]() |
instrument handle identifies a particular instrument session. |
||||||||||||||||
![]() |
channels specifies the channel(s) from which to acquire data. For more information, refer to Channel String Syntax. |
||||||||||||||||
![]() |
numSamples is the maximum number of samples to fetch for each waveform; if the acquisition finishes with fewer points than requested, some devices return partial data if the acquisition finished, was aborted, or a timeout of 0 was used. Use –1 for this parameter if you want to fetch all available samples. The VI reads the actual record length and attempts to acquire all available samples. If it fails to complete within the timeout period, the VI returns an error. |
||||||||||||||||
![]() |
timeout is the time (in seconds) to wait for the data to be acquired. Use 0 for this parameter to tell NI-SCOPE to fetch whatever is currently available. Using -1 for this parameter implies infinite timeout. |
||||||||||||||||
![]() |
error in describes error conditions that occur before this node runs. This input provides standard error in functionality. |
||||||||||||||||
![]() |
instrument handle out has the same value as the instrument handle. |
||||||||||||||||
![]() |
wfm info contains all the timing and scaling information about the waveform.
|
||||||||||||||||
![]() |
waveform is an array of clusters, each containing the initial x value, x increment, and a waveform array. This output can be wired directly to the LabVIEW waveform graph, so each waveform in the array is plotted with timing information. The initial x value in the cluster is the value relative to the trigger. The relative initial x value is the time from the trigger to the first point so the trigger always occurs at time equals zero. The array of clusters includes waveforms from multiple channels, records, and acquisition types. For example, if the acquisition type is normal there is one waveform per channel per record. If you call the fetch VI during a normal acquisition with the channel string "0,1" the order of the output is: record 0, channel 0 record 0, channel 1 record 1, channel 0 record 1, channel 1
|
||||||||||||||||
![]() |
error out contains error information. This output provides standard error out functionality. |
1D WDT
Initiates an acquisition and returns a one-dimensional array of LabVIEW waveform data types that includes timing information. This VI is only supported in LabVIEW 7.0 or later.
![]() |
instrument handle identifies a particular instrument session. |
||||||||||||||||
![]() |
channels specifies the channel(s) from which to acquire data. For more information, refer to Channel String Syntax. |
||||||||||||||||
![]() |
numSamples is the maximum number of samples to fetch for each waveform; if the acquisition finishes with fewer points than requested, some devices return partial data if the acquisition finished, was aborted, or a timeout of 0 was used. Use –1 for this parameter if you want to fetch all available samples. The VI reads the actual record length and attempts to acquire all available samples. If it fails to complete within the timeout period, the VI returns an error. |
||||||||||||||||
![]() |
timeout is the time (in seconds) to wait for the data to be acquired. Use 0 for this parameter to tell NI-SCOPE to fetch whatever is currently available. Using -1 for this parameter implies infinite timeout. |
||||||||||||||||
![]() |
timestamp Type specifies the time basis for the timestamp on the WDT data. Defined Values absolute relative |
||||||||||||||||
![]() |
error in describes error conditions that occur before this node runs. This input provides standard error in functionality. |
||||||||||||||||
![]() |
instrument handle out has the same value as the instrument handle. |
||||||||||||||||
![]() |
wfm info contains all the timing and scaling information about the waveform.
|
||||||||||||||||
![]() |
wfm returns a one-dimensional array of LabVIEW waveform data types that contain timing information. If you specify a channel list, NI-SCOPE returns the waveforms in the list order. NI-SCOPE returns these records sequentially, so all record 0 waveforms are first. For example, with a two-channel list, you would have the following index values: index 0 = record 0, channel 0 index 1 = record 0, channel 1 index 2 = record 1, channel 0 index 3 = record 1, channel 1 |
||||||||||||||||
![]() |
error out contains error information. This output provides standard error out functionality. |