Pycorrelate
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.
Free software: GNU General Public License v3
Documentation: https://pycorrelate.readthedocs.io.
History
0.2.1 (2017-11-15)
Added normalization for FCS curves (see pnormalize).
Added example notebook showing how to fit a simple FCS curve
Renamed ucorrelate argument from maxlags to maxlag.
Added theory page in the documentation, showing the exact formula used for CCF calculations.
0.1.0 (2017-07-23)
First release on PyPI.
1 maintainer
Metadata
1 maintainer
Release files for pycorrelate 0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pycorrelate-0.3.tar.gz | 206.0 kB | Without provenance | Details for pycorrelate-0.3.tar.gz |
Release files / pycorrelate-0.3.tar.gz
| Download URL | pycorrelate-0.3.tar.gz |
|---|---|
| Size | 206.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bbd358b0c924c900b8b345eaa9b9ef659b18e6f639c017898362f77dc6a0cce3
|
|
BLAKE2b-256 checksum How to use checksums |
bfb158b7f6001ef5ff8ca23c08f07b72b37c369ddae9f917dce2471e60582822
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for pycorrelate 0.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
