Skip to content

user-friendly error messages about multilevel DWT format#471

Merged
grlee77 merged 5 commits intoPyWavelets:masterfrom
grlee77:unravel_clarification
Jul 25, 2019
Merged

user-friendly error messages about multilevel DWT format#471
grlee77 merged 5 commits intoPyWavelets:masterfrom
grlee77:unravel_clarification

Conversation

@grlee77
Copy link
Copy Markdown
Contributor

@grlee77 grlee77 commented Feb 27, 2019

This PR introduces more informative error messages in the case the coefficients from the wrong multilevel DWT type are used as input to a multilevel reconstruction. This has resulted in user confusion in due to the output of pywt.array_to_coeffs and pywt.unravel_coeffs defaulting to compatibility with wavedecn: see #470 and #357

This was previously done for 1D in #358, but this PR attempts to do thisconsistently across waverec, waverec2 and waverecn.

In addition to the more informative error messages, I updated the docstring examples to explicitly specify output_format so that it is harder for users to overlook it.

@grlee77 grlee77 changed the title user-friendly error messages about coefficient format in waverec2, etc. user-friendly error messages about multilevel DWT format Feb 27, 2019
This case can never be reached due to the new ValueError check above
@rgommers
Copy link
Copy Markdown
Member

looks like a good idea. CI failures are real

@grlee77
Copy link
Copy Markdown
Contributor Author

grlee77 commented Feb 27, 2019

Thanks. I needed ... for line continuation in the docstrings.

@rgommers rgommers added this to the v1.1 milestone Feb 28, 2019
Comment thread pywt/_multilevel.py Outdated
@rgommers
Copy link
Copy Markdown
Member

LGTM module my one minor comment

@grlee77 grlee77 merged commit ba00fea into PyWavelets:master Jul 25, 2019
@grlee77 grlee77 deleted the unravel_clarification branch November 13, 2019 00:49
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.

2 participants