1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
|
multipletau
===========
|PyPI Version| |Tests Status| |Coverage Status| |Docs Status|
Multiple-tau correlation is computed on a logarithmic scale (less
data points are computed) and is thus much faster than conventional
correlation on a linear scale such as `numpy.correlate <http://docs.scipy.org/doc/numpy/reference/generated/numpy.correlate.html>`__.
Installation
------------
Multipletau supports Python 2.7 and Python 3.3+ with a common codebase.
The only requirement for ``multipletau`` is `NumPy <http://www.numpy.org/>`__ (for fast
operations on arrays). Install multipletau from the Python package index:
::
pip install multipletau
Documentation
-------------
The documentation, including the reference and examples, is available on `readthedocs.io <https://multipletau.readthedocs.io/en/stable/>`__.
Usage
-----
.. code:: python
import numpy as np
import multipletau
a = np.linspace(2,5,42)
v = np.linspace(1,6,42)
multipletau.correlate(a, v, m=2)
array([[ 0. , 569.56097561],
[ 1. , 549.87804878],
[ 2. , 530.37477692],
[ 4. , 491.85812017],
[ 8. , 386.39500297]])
Citing
------
The multipletau package should be cited like this
(replace "x.x.x" with the actual version of multipletau that you used
and "DD Month YYYY" with a matching date).
Paul Müller (2012) *Python multiple-tau algorithm* (Version x.x.x) [Computer program]. Available at `<https://pypi.python.org/pypi/multipletau/>`__ (Accessed DD Month YYYY)
You can find out what version you are using by typing (in a Python console):
.. code:: python
>>> import multipletau
>>> multipletau.__version__
'0.3.0'
.. |PyPI Version| image:: http://img.shields.io/pypi/v/multipletau.svg
:target: https://pypi.python.org/pypi/multipletau
.. |Tests Status| image:: http://img.shields.io/travis/FCS-analysis/multipletau.svg?label=tests
:target: https://travis-ci.org/FCS-analysis/multipletau
.. |Coverage Status| image:: https://img.shields.io/codecov/c/github/FCS-analysis/multipletau/master.svg
:target: https://codecov.io/gh/FCS-analysis/multipletau
.. |Docs Status| image:: https://readthedocs.org/projects/multipletau/badge/?version=latest
:target: https://readthedocs.org/projects/multipletau/builds/
|
