Skip to content

Commit 5a38a12

Browse files
committed
DOC: update release notes
1 parent 29ce9bb commit 5a38a12

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

doc/release/1.1.0-notes.rst

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,23 @@ Deprecated features
1717
Backwards incompatible changes
1818
==============================
1919

20+
When using complex-valued wavelets with the ``cwt``, the output will now be
21+
the complex conjugate of the result that was produced by PyWavelets 1.0.x.
22+
This was done to account for a bug described below. The magnitude of the
23+
``cwt`` coefficients will still match those from previous releases.
24+
2025
Bugs Fixed
2126
==========
22-
For the complex wavelet transforms, the tests were based on older implementation of Matlab CWT function that had an issue with the phase of the complex wavelet coefficients.
23-
Consequently, the complex wavelet coefficients were complex conjugates of the proper result.
24-
The tests were made using cmor1.0-1.0 and compared to the WT implementation proposed by Matlab R2017b and Lancaster University, Physics department Matlab function ``wt.m``.
27+
28+
For a ``cwt`` with complex wavelets, the results in PyWavelets 1.0.x releases
29+
matched the output of Matlab R2012a's ``cwt``. Howveer, older Matlab releases
30+
like R2012a had a phase that was of opposite sign to that given in textbook
31+
definitions of the CWT (Eq. 2 of Torrence and Compo's review article, "A
32+
Practical Guide to Wavelet Analysis"). Consequently, the wavelet coefficients
33+
were the complex conjugates of the expected result. This was validated by
34+
comparing the results of a transform using ``cmor1.0-1.0`` as compared to the
35+
``cwt`` implementation available in Matlab R2017b as well as to the Lancaster
36+
University Physics department's Matlab function, ``wt.m``.
2537

2638
Other changes
2739
=============

0 commit comments

Comments
 (0)