Skip to content

tritemio/pycorrelate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

d5f3e7c · Nov 17, 2017

History

67 Commits
Jul 23, 2017
Nov 17, 2017
Nov 15, 2017
Nov 15, 2017
Jul 23, 2017
Nov 15, 2017
Jul 23, 2017
Nov 16, 2017
Jul 23, 2017
Sep 17, 2017
Nov 15, 2017
Jul 23, 2017
Nov 16, 2017
Jul 23, 2017
Nov 16, 2017
Nov 15, 2017
Nov 14, 2017
Jul 26, 2017
Nov 15, 2017
Nov 15, 2017
Jul 23, 2017
Nov 15, 2017

Repository files navigation

Pycorrelate

https://ci.appveyor.com/api/projects/status/dcanybpqi2o1ecwi/branch/master?svg=true Documentation Status

Pycorrelate computes fast and accurate cross-correlation over arbitrary time lags. Cross-correlations can be calculated on "uniformly-sampled" signals or on "point-processes", such as photon timestamps. Pycorrelate allows computing cross-correlation at log-spaced lags covering several orders of magnitude. This type of cross-correlation is commonly used in physics or biophysics for techniques such as fluorescence correlation spectroscopy (FCS) or dynamic light scattering (DLS).

Two types of correlations are implemented:

  • ucorrelate: the classical text-book linear cross-correlation between two signals defined at uniformly spaced intervals. Only positive lags are computed and a max lag can be specified. Thanks to the limit in the computed lags, this function can be much faster than numpy.correlate.
  • pcorrelate: cross-correlation of discrete events in a point-process. In this case input arrays can be timestamps or positions of "events", for example photon arrival times. This function implements the algorithm in Laurence et al. Optics Letters (2006). This is a generalization of the multi-tau algorithm which retains high execution speed while allowing arbitrary time-lag bins.

Pycorrelate is implemented in Python 3 and operates on standard numpy arrays. Execution speed is optimized using numba.