Python Toolkit API DAQ Module¶
zhinst.toolkit.driver.modules.daq_module.DAQModule(daq_module, session)
¶
Bases: BaseModule
Data Acquisition Module.
The Data Acquisition Module corresponds to the Data Acquisition tab of the LabOne User Interface. It enables the user to record and align time and frequency domain data from multiple instrument signal sources at a defined data rate. The data may be recorded either continuously or in bursts based upon trigger criteria analogous to the functionality provided by laboratory oscilloscopes.
For a complete documentation see the LabOne user manual
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
daq_module |
DataAcquisitionModule
|
Instance of the core DAQ module. |
required |
session |
Session
|
Session to the Data Server. |
required |
finish()
¶
Stop the module.
finished()
¶
Check if the acquisition has finished.
Returns:
| Type | Description |
|---|---|
bool
|
Flag if the acquisition has finished. |
read(*, raw=False, clk_rate=60000000.0)
¶
Read the acquired data from the module.
The data is split into bursts.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
raw |
bool
|
Flag if the acquired data from the subscribed device device nodes should be converted into the DAQResult format (raw = False) or not. (default = False) |
False
|
clk_rate |
float
|
Clock rate [Hz] for converting the timestamps. Only applies if the raw flag is reset. |
60000000.0
|
Returns:
| Type | Description |
|---|---|
NodeDict
|
Result of the burst grouped by the signals. |
trigger()
¶
Execute a manual trigger.