Runtime Control¶
Once a TimeTagger4 device is configured, the following functions can be used to control the behavior of it.
These functions return quickly with very little overhead. However, they are not guaranteed to be thread safe.
timetagger4_start_capture¶
-
int timetagger4_start_capture(timetagger4_device *device)¶
Start data acquisition.
- Parameters:
device – Pointer to a TimeTagger4 device.
- Returns:
Status code:
TIMETAGGER4_OK
,TIMETAGGER4_INVALID_DEVICE
,TIMETAGGER4_CRONO_INTERNAL_ERROR
,TIMETAGGER4_HARDWARE_FAILURE
, orTIMETAGGER4_WRONG_STATE
.
timetagger4_pause_capture¶
-
int timetagger4_pause_capture(timetagger4_device *device)¶
Pause data acquisition.
timetagger4_pause_capture()
andtimetagger4_continue_capture()
have less overhead thantimetagger4_start_capture()
andtimetagger4_stop_capture()
, but do not allow for a configuration change.- Parameters:
device – Pointer to a TimeTagger4 device.
- Returns:
Status code:
TIMETAGGER4_OK
,TIMETAGGER4_INVALID_DEVICE
,TIMETAGGER4_WRONG_STATE
.
timetagger4_continue_capture¶
-
int timetagger4_continue_capture(timetagger4_device *device)¶
Continue data acquisition.
timetagger4_pause_capture()
andtimetagger4_continue_capture()
have less overhead thantimetagger4_start_capture()
andtimetagger4_stop_capture()
, but do not allow for a configuration change.- Parameters:
device – Pointer to a TimeTagger4 device.
- Returns:
Status code:
TIMETAGGER4_OK
,TIMETAGGER4_INVALID_DEVICE
,TIMETAGGER4_WRONG_STATE
.
timetagger4_stop_capture¶
-
int timetagger4_stop_capture(timetagger4_device *device)¶
Stop data acquisition.
- Parameters:
device – Pointer to a TimeTagger4 device.
- Returns:
Status code:
TIMETAGGER4_OK
, orTIMETAGGER4_INVALID_DEVICE
.
timetagger4_start_tiger¶
-
int timetagger4_start_tiger(timetagger4_device *device)¶
Start the Timing Generator (TiGer)
This can be done independently of the state of the data acquisition.
- Parameters:
device – Pointer to a TimeTagger4 device.
- Returns:
Status code:
TIMETAGGER4_OK
,TIMETAGGER4_INVALID_DEVICE
, orTIMETAGGER4_WRONG_STATE
.
timetagger4_stop_tiger¶
-
int timetagger4_stop_tiger(timetagger4_device *device)¶
Stop the Timing Generator (TiGer)
This can be done independently of the state of the data acquisition.
- Parameters:
device – Pointer to a TimeTagger4 device.
- Returns:
Status code:
TIMETAGGER4_OK
orTIMETAGGER4_INVALID_DEVICE
.