docs(propagate_DWT): extend module description

PTB-M4D · Jun 12, 2020 · a007797 · a007797
1 parent 8331b57
commit a007797
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/PyDynamic/uncertainty/propagate_DWT.py b/PyDynamic/uncertainty/propagate_DWT.py
@@ -4,6 +4,16 @@
 The :mod:`PyDynamic.uncertainty.propagate_DWT` module implements methods for
 the propagation of uncertainties in the application of the discrete wavelet
 transform (DWT).
+
+This modules contains the following functions:
+
+* :func:`dwt`: single level DWT
+* :func:`wave_dec`: wavelet decomposition / multi level DWT
+* :func:`wave_dec_realtime"`: multi level DWT 
+* :func:`idwt`: single level inverse DWT
+* :func:`wave_rec`: wavelet reconstruction / multi level inverse DWT
+* :func:`filter_desig`: provide common wavelet filters (via :py:mod:`PyWavelets`)
+
 """
 
 import pywt