Metadata-Version: 2.1
Name: tomtag
Version: 0.4
Summary: Package to identify correlated single photon detection events.
Author-email: Thomas Jaeken <tj2022@hw.ac.uk>
Project-URL: Bug Tracker, https://github.com/Thomas-Jaeken/tomtag/issues
Project-URL: Homepage, https://github.com/Thomas-Jaeken/tomtag
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE

# TomTag

This package holds 2 functions at the moment, ```count()``` and ```get_cc()```.
Both take as input a numpy array of integers and a coincidence window (also integer) and finds the entries that are less than the coincidence window apart.
```count()``` only counts these entries, but ```get_cc()``` also returns the indices of both arrays.

The integers are in the internal units of the timetagger so the user would need to know this to convert.

The use of the functions is verry simple and illustrated here:

https://github.com/Thomas-Jaeken/tomtag/blob/eadfe923e1eab1344aa1252ada93bb91cb31b046/example.py#L1-L10

# Installation
The project is not yet listed on pipy
To install the module to your computer, download the .tar.gz file from the ```dist``` folder and execute
```
pip install $PATH/tomtag-0.2.tar.gz
```
