Welcome to phconvert’s documentation!#
- Version:
0.10 (release notes)
phconvert is a python 3 library which helps writing valid Photon-HDF5 files. This document contains the API documentation for phconvert.
The phconvert library contains two main modules: hdf5 and loader for reading and writing files. The former contains functions to save and validate Photon-HDF5 files. The latter, contains functions to load other formats to be converted to Photon-HDF5.
The plotter and helperfuncs modules contain utility functions that assist users in inspecting the itermeiate steps in converting from a raw data file into photon-HDF5, the first primarily in determining the ideal alternation periods for ALEX/PIE measuremtns, the latter for determining missing metadata.
The phconvert repository contains a set the notebooks to convert existing formats to Photon-HDF5 or to write Photon-HDF5 from scratch:
Particularly the notebooks
demonstrate the full process using the latest version of phconvert for converting picoquant and Becker & Hickl files to photon-HDF5.
See notebook Writing Photon-HDF5 files (read online) as an example of writing Photon-HDF5 files from scratch.
Finally, phconvert repository contains a JSON specification of the Photon-HDF5 format which lists all the valid field names and corresponding data types and descriptions.
Contents: