cwt: log scales in docstring example#802
Merged
rgommers merged 2 commits intoPyWavelets:mainfrom Aug 3, 2025
Merged
Conversation
rgommers
approved these changes
Aug 3, 2025
Member
rgommers
left a comment
There was a problem hiding this comment.
Thanks @OverLordGoldDragon, this looks like a useful change to make. In the rest of the narrative docs for cwt (https://pywavelets.readthedocs.io/en/latest/ref/cwt.html) it's emphasized multiple times that it should be log scale, so making it consistent also in the docstring examples makes sense.
[skip ci]
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I saw linear
scalesin some important code recently (written by those who don't know better).There will almost never be a use case for this. CWT is a log transform and should be tiled logarithmically.
If my example of an exponential chirp is unsatisfying, feel free to revert, but it's what illustrates the flaw of the current approach; the signal should trace out a straight line in CWT.