Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Enhanced documentation for CWT #676

Closed
drs251 opened this issue Aug 7, 2023 · 1 comment
Closed

Enhanced documentation for CWT #676

drs251 opened this issue Aug 7, 2023 · 1 comment
Milestone

Comments

@drs251
Copy link
Contributor

drs251 commented Aug 7, 2023

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
Copy link
Member

rgommers commented Aug 9, 2023

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

drs251 added a commit to drs251/pywt that referenced this issue Aug 20, 2023
…ble of contents in index.rst more detailed.
rgommers pushed a commit to drs251/pywt that referenced this issue Aug 22, 2023
@rgommers rgommers added this to the v1.6.0 milestone Mar 8, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

No branches or pull requests

2 participants