Cluster

session in

Handle that identifies the NI-SCOPE instrument session as previously allocated by Initialize With Options .

error in

Error conditions that occur before this node runs.

The node responds to this input according to standard error behavior.

Standard Error Behavior

Default value: No error

channels

The channel(s) from which to acquire data.

Channel String Syntax

This input parameter has the following syntax options:

A single channel, such as 0
A list of channels, such as 0,1 or 3,2,1,0
A range of channels, such as 0-7 or 0:7
A combination of channels from multiple instruments, such as PXI1Slot3/0,PXI1Slot3/2-3,PXI1Slot4/2-3

Note The order of channels in a list is important. The data for each channel is returned in the order the channels occur in the list.

numsamples

The maximum number of samples to fetch for each waveform.

This function reads the actual record length and attempts to acquire all available samples. If the function fails to complete within the timeout period, the function returns an error. 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.

Default value: -1

Fetching All Available Samples

Use -1 for this parameter if you want to fetch all available samples.

timeout

The time, in seconds, to wait for the data to be acquired.

Default value: 5

Alternate Uses

Use 0 for this parameter to fetch whatever is currently available. Use -1 for this parameter to imply an infinite timeout.

session out

Reference to the NI-SCOPE instrument session to pass to the next node in the program.

error out

Error information.

The node produces this output according to standard error behavior.

Standard Error Behavior

waveform

A cluster containing the initial time value, time increment, and a waveform array.

The initial time value in the cluster is relative to the trigger. The relative initial time value is the time from the trigger to the first point, so the trigger always occurs at time equals zero.

t0

The initial time value relative to the trigger, such that the trigger always occurs at time equals zero.

dt

The time interval between two samples in the waveform. This value is 1 / sampling rate for time-domain acquisitions.

Y

An array of waveform data containing one waveform.

waveform info

The timing and scaling information about the waveform.

actualSamples

The actual number of samples in the acquired waveform.

Note The number returned in actualSamples may be less than numSamples if the number you request is not available.

absoluteInitialX

The timestamp, in seconds, of the first fetched sample.

This timestamp is comparable between records and acquisitions; devices that do not support this parameter use 0 for this output.

relativeInitialX

The time, in seconds, from the trigger to the first sample in the acquired waveform.

xIncrement

The time, in seconds, between two samples in the acquired waveform.

offset

The offset factor of the given channel.

Use for scaling binary data with the following formula: voltage = binary data x gain factor + offset

gain

The gain factor of the given channel.

Use for scaling binary data with the following formula: voltage = binary data × gain factor + offset.

reserved1

A reserved value. Do not use.

reserved2