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
|
multipletau documentation
=========================
General
:::::::
.. automodule:: multipletau
:members:
Methods
:::::::
Summary:
.. autosummary::
autocorrelate
correlate
correlate_numpy
.. _sec_ac:
Autocorrelation
---------------
.. autofunction:: autocorrelate
.. _sec_cc:
Cross-correlation
-----------------
.. autofunction:: correlate
.. _sec_cc_numpy:
Cross-correlation (NumPy)
-------------------------
.. autofunction:: correlate_numpy
.. _sec_constants:
Constants
---------
.. autodata:: multipletau.core.ZERO_CUTOFF
.. _sec_examples:
Examples
========
.. fancy_include:: compare_correlation_methods.py
.. _sec_changelog:
|