API referenceΒΆ

The scTDClib class provides a low-level wrapper of functions from the underlying scTDC library. A few of the functions from this class may be interesting to the application, such as sc_tdc_config_get_library_version for querying the library version, or querying certain device properties. Other than that, this class is merely used to implement the higher-level interfaces which are recommended to be used primarily by the application developer:

  • the Device class for access to pre-computed histograms from DLD and TDC data and statistics data. The Device class can create Pipe objects and return them to the application. For access to the data, methods from these Pipe objects are used.

  • the Camera class in place of the Device class for camera applications.

  • the buffered_data_callbacks_pipe class for access to TDC or DLD events in a list-of-events form.

  • the usercallbacks_pipe class has been available for a longer time than the buffered_data_callbacks_pipe class and it maps the default list-of-events interface of the C/C++ scTDC SDK. However, the application may run into performance problems with the usercallbacks_pipe interface if TDC or DLD events are expected to be in the order of millions per second. The buffered_data_callbacks_pipe can be tuned to require less Python lines of code to be executed per second and therefore is able to handle higher event rates.