Skip to content

DOC: fix the swt/swt2 start_level coefficient ranges - #863

Merged
rgommers merged 1 commit into
PyWavelets:mainfrom
rgommers:doc/fix-swt-start-level-formula
Aug 17, 2026
Merged

DOC: fix the swt/swt2 start_level coefficient ranges#863
rgommers merged 1 commit into
PyWavelets:mainfrom
rgommers:doc/fix-swt-start-level-formula

Conversation

@rgommers

Copy link
Copy Markdown
Member

Use the form agreed on in gh-838 for the swt list.

Apply the same off-by-one fix to both swt2 output blocks, which still ended at (cA_m, (cH_m, cV_m, cD_m)), and correct the iswt/iswt2 remark that index 1 corresponds to start_level - it corresponds to start_level + 1.

Also state explicitly in the swt parameter description that the output holds exactly level sets of coefficients; that is the fact whose absence prompted the report.

Closes gh-838

Use the form agreed on in PyWaveletsgh-838 for the `swt` list.

Apply the same off-by-one fix to both `swt2` output blocks, which still
ended at `(cA_m, (cH_m, cV_m, cD_m))`, and correct the `iswt`/`iswt2`
remark that index 1 corresponds to `start_level` - it corresponds to
`start_level + 1`.

Also state explicitly in the `swt` parameter description that the output
holds exactly `level` sets of coefficients; that is the fact whose
absence prompted the report.

Closes PyWaveletsgh-838
@rgommers rgommers added this to the v1.10.0 milestone Aug 17, 2026
@rgommers
rgommers merged commit 6031ddf into PyWavelets:main Aug 17, 2026
17 checks passed
@rgommers
rgommers deleted the doc/fix-swt-start-level-formula branch August 17, 2026 12:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

swt documentation mistake

1 participant