File: index.rst

package info (click to toggle)
python-multipletau 0.3.3%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 380 kB
  • sloc: python: 1,557; makefile: 15
file content (40 lines) | stat: -rw-r--r-- 561 bytes parent folder | download | duplicates (3)
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
multipletau documentation
=========================

General
:::::::
.. automodule:: multipletau
   :members:

Methods
:::::::

Summary:

.. autosummary:: 
    autocorrelate
    correlate
    correlate_numpy


Autocorrelation
---------------
.. autofunction:: autocorrelate

Cross-correlation
-----------------
.. autofunction:: correlate

Cross-correlation (NumPy)
-------------------------
.. autofunction:: correlate_numpy

Constants
---------
.. autodata:: multipletau.core.ZERO_CUTOFF

Examples
========
.. fancy_include:: compare_correlation_methods.py