Module pqreader
¶
This module contains functions to load and decode files from PicoQuant hardware.
The primary exported functions are:
load_ht3()
which returns decoded timestamps, detectors, nanotimes and metadata from an HT3 file.load_pt3()
which returns decoded timestamps, detectors, nanotimes and metadata from a PT3 file.
Other lower level functions are:
ht3_reader()
which loads metadata and raw t3 records from HT3 filespt3_reader()
which loads metadata and raw t3 records from PT3 filesprocess_t3records()
which decodes the t3 records returning timestamps (after overflow correction), detectors and TCSPC nanotimes.
Note that the functions performing overflow/rollover correction can take advantage of numba, if installed, to significanly speed-up the processing.
List of functions¶
High-level functions to load and decode several PicoQuant file formats:
-
phconvert.pqreader.
load_ht3
(filename, ovcfunc=None)¶ Load data from a PicoQuant .ht3 file.
Parameters: Returns: A tuple of timestamps, detectors, nanotimes (integer arrays) and a dictionary with metadata containing at least the keys ‘timestamps_unit’ and ‘nanotimes_unit’.
-
phconvert.pqreader.
load_pt3
(filename, ovcfunc=None)¶ Load data from a PicoQuant .pt3 file.
Parameters: Returns: A tuple of timestamps, detectors, nanotimes (integer arrays) and a dictionary with metadata containing at least the keys ‘timestamps_unit’ and ‘nanotimes_unit’.
Low-level functions¶
These functions are the building blocks for loading and decoding the different files:
-
phconvert.pqreader.
ht3_reader
(filename)¶ Load raw t3 records and metadata from an HT3 file.
-
phconvert.pqreader.
pt3_reader
(filename)¶ Load raw t3 records and metadata from a PT3 file.
-
phconvert.pqreader.
process_t3records
(t3records, time_bit=10, dtime_bit=15, ch_bit=6, special_bit=True, ovcfunc=None)¶ Extract the different fields from the raw t3records array (.ht3).
Returns: 3 arrays representing detectors, timestamps and nanotimes.