DOC: clarify CWT normalization details around sampling_period (issue #801)#842
Open
magnaprog wants to merge 1 commit intoPyWavelets:mainfrom
Open
DOC: clarify CWT normalization details around sampling_period (issue #801)#842magnaprog wants to merge 1 commit intoPyWavelets:mainfrom
magnaprog wants to merge 1 commit intoPyWavelets:mainfrom
Conversation
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
1 participant
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.
Why this change
Issue #801 raised a good question: when comparing a hand-written CWT with
pywt.cwt, why can an extra1/sqrt(fs)factor seem necessary to match amplitudes?This PR improves the docs to make that behavior easier to understand.
What changed
pywt.cwtdocstring to explicitly state thatsampling_periodaffects the reported frequencies, not coefficient scaling.dtfactor can appear in manual continuous-time discretizations, and why that may show up assqrt(dt)/1/sqrt(fs)depending on parameterization.Notes
This is a documentation-only change. No runtime behavior is changed.