Commit 6aeb99c3 authored by Denis Arrivault's avatar Denis Arrivault
Browse files

Correct some doc mistakes

parent 3dfadcd5
......@@ -28,7 +28,10 @@ For developpers only:
Scientific Python libraries
---------------------------
* You need to have **libfftw3**, development version, installed. For debian based linux systems use ``$apt install libfftw3-dev``. For other systems, please read the documentation of `fftw <http://www.fftw.org/>`_.
* You need to have **libfftw3**, development version, installed.
* For debian based linux systems use: ``$apt install libfftw3-dev``.
* For MACOS X based systems, you may use: ``sudo port install fftw-3 fftw-3-single``.
* For other systems, please read the documentation of `fftw <http://www.fftw.org/>`_.
* **ltfatpy** is using **numpy** >= 1.9, **scipy** >= 0.15 and **matplotlib** >= 1.4. For installing those packages read the instructions in:
`here <http://www.scipy.org/install.html>`_.
......
......@@ -75,6 +75,7 @@ def dgtreal(f, g, a, M, L=None, pt='freqinv'):
- Usage:
| ``(c, Ls, g) = dgtreal(f, g, a, M)``
| ``(c, Ls, g) = dgtreal(f, g, a, M, L)``
| ``(c, Ls, g) = dgtreal(f, g, a, M, L, pt)``
- Input parameters:
......
......@@ -79,6 +79,7 @@ def idgt(coef, g, a, Ls=None, pt='freqinv'):
| ``(f, g) = idgt(c, g, a)``
| ``(f, g) = idgt(c, g, a, Ls)``
| ``(f, g) = idgt(c, g, a, Ls, pt)``
- Input parameters:
......@@ -86,6 +87,7 @@ def idgt(coef, g, a, Ls=None, pt='freqinv'):
:param g: Window function
:param int a: Length of time shift
:param int Ls: Length of signal
:param str pt: 'freqinv' or 'timeinv'. Default is 'freqinv'.
:type g: str, dict or numpy.ndarray
- Output parameters:
......
......@@ -78,6 +78,7 @@ def idgtreal(coef, g, a, M, Ls=None, pt='freqinv'):
- Usage:
| ``(f, g) = idgtreal(c, g, a, M)``
| ``(f, g) = idgtreal(c, g, a, M, Ls)``
| ``(f, g) = idgtreal(c, g, a, M, Ls, pt)``
- Input parameters:
......@@ -86,6 +87,7 @@ def idgtreal(coef, g, a, M, Ls=None, pt='freqinv'):
:param int a: Length of time shift
:param int M: Number of channels
:param int Ls: Length of signal
:param str pt: 'freqinv' or 'timeinv'. Default is 'freqinv'.
:type g: str, dict or numpy.ndarray
- Output parameters:
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment