Skip to content

Commit e2d7faa

Browse files
committed
DOC: mention similarity to the MODWT in the swt docstring
1 parent 6ac0fa3 commit e2d7faa

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

pywt/_swt.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,18 @@ def swt(data, wavelet, level=None, start_level=0, axis=-1,
9797
1.) energy is conserved
9898
2.) variance is partitioned across scales
9999
100+
When used with ``norm=True``, this transform is closely related to the
101+
multiple-overlap DWT (MODWT) as popularized for time-series analysis,
102+
although the underlying implementation is slightly different from the one
103+
published in [1]_. Specifically, the implementation used here requires a
104+
signal that is a multiple of ``2**level`` in length.
105+
106+
References
107+
----------
108+
.. [1] DB Percival and AT Walden. Wavelet Methods for Time Series Analysis.
109+
Cambridge University Press, 2000.
100110
"""
111+
101112
if not _have_c99_complex and np.iscomplexobj(data):
102113
data = np.asarray(data)
103114
coeffs_real = swt(data.real, wavelet, level, start_level, trim_approx)

0 commit comments

Comments
 (0)