search

PyWavelets / pywt

PyWavelets - Wavelet Transforms in Python
http://pywavelets.readthedocs.org
MIT License
1.97k stars 460 forks source link

Enhanced documentation for CWT #676

Closed drs251 closed 3 months ago

drs251 commented 11 months ago

IMO, the documentation for pywt.cwt could use a more detailed example, e.g. generating a chirp signal and creating a scaleogram using the complex Morlet wavelet, possibly with several different bandwidths and center frequencies. Ideally, this should also give some hints how to choose scales and wavelets and how to visualize the result. Also, a link to Torrence & Compo's paper (https://paos.colorado.edu/research/wavelets/bams_79_01_0061.pdf) would be helpful for users.

I was having a hard time getting started with the CWT, also because of the lack of good documentation elsewhere. If you think this is a good idea, I'll get started on a PR.

rgommers commented 11 months ago

Thank you @drs251, a PR like that would be very welcome.