Skip to content

Commit

Permalink
Doc: minor clarifications
Browse files Browse the repository at this point in the history
  • Loading branch information
tritemio committed Aug 20, 2018
2 parents 26938cc + cc10675 commit f9e109e
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,16 @@ commonly used in physics or biophysics for techniques such as
Two types of correlations are implemented:

- `ucorrelate <https://pycorrelate.readthedocs.io/en/latest/api.html#pycorrelate.pycorrelate.ucorrelate>`__:
the classical text-book linear cross-correlation between two signals
defined at **uniformly spaced** intervals.
the classical textbook linear cross-correlation between two signals defined at **uniformly-spaced** intervals
(both signals having the same interval size).
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 <https://docs.scipy.org/doc/numpy/reference/generated/numpy.correlate.html#numpy.correlate>`__.

- `pcorrelate <https://pycorrelate.readthedocs.io/en/latest/api.html#pycorrelate.pycorrelate.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**.
cross-correlation of discrete events in a point-process
(i.e. a series of timestamps). Input arrays are timestamps (or "positions")
of events, for example **photon arrival times**.
This function implements the algorithm in
`Laurence et al. Optics Letters (2006) <https://doi.org/10.1364/OL.31.000829>`__.
This is a generalization of the multi-tau algorithm which retains
Expand Down
2 changes: 1 addition & 1 deletion docs/theory.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ You can choose between the normalized and unnormalized version with the
input argument `normalize`.

.. note::
Due to a typo, in *Laurence 2006*, the expression for *G(k)*
In *Laurence 2006*, due to a typo, the expression for *G(k)*
(which they call :math:`C_{AB}(\tau)`) is missing the term
:math:`\Delta\tau_k` in the denominator.

Expand Down

0 comments on commit f9e109e

Please sign in to comment.