MAINT: warns for new multichannel default in denoise_{bilateral, nl_means} #2467
Conversation
This file contains 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
|
@stsievert You need to follow the procedure that we started to write here: #2422 Thx! |
sciunto
added
🔧 type: Maintenance
sciunto
suggested changes
Jan 21, 2017
| @@ -75,7 +75,10 @@ def denoise_bilateral(image, win_size=None, sigma_color=None, sigma_spatial=1, | |||
| >>> noisy = np.clip(noisy, 0, 1) | |||
| >>> denoised = denoise_bilateral(noisy, sigma_color=0.05, sigma_spatial=15) | |||
| """ | |||
| warn('denoise_bilateral will default to multichannel=False') | |||
| if multichannel is None: | |||
| warn('denoise_bilateral will default to multichannel=False') | |||
There was a problem hiding this comment.
Please, specify the version here (0.15).
|
At the end, if you can squash the commit, would be awesome ;) |
|
You also need to update the test suite and specify the option everywhere. |
stsievert
force-pushed
the
warn-bilateral
branch
2 times, most recently
from
d2b4899
to
89abfff
Compare
Current coverage is 90.71% (diff: 100%)@@ master #2467 diff @@
==========================================
Files 304 304
Lines 21500 21511 +11
Methods 0 0
Messages 0 0
Branches 1851 1853 +2
==========================================
+ Hits 19502 19513 +11
Misses 1658 1658
Partials 340 340
|
stsievert
force-pushed
the
warn-bilateral
branch
from
89abfff
to
d2f0383
Compare
…ests uses process described in scikit-image#2422
stsievert
force-pushed
the
warn-bilateral
branch
from
d2f0383
to
d2e5761
Compare
|
Rebased and (I believe) ready to merge. |
sciunto
approved these changes
Jan 22, 2017
|
@scikit-image/core We need a second review here. It's easy :) |
|
Thanks @stsievert! and @sciunto, you were right, that was easy. =D |
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.
Fixes #2465
Description
In #2461 (comment) we realized that
denoise_waveletshould default tomultichannel=False. We chose this primarily becausemultichannel=Falseworks well for 2D images, is explicit and doesn't prioritize multichannel images (e.g., RGB images) over 2D images.From this we decided that
denoise_bilateralshould default tomultichannel=Falseto provide a consistent interface with the multichannel found indenoise_{wavelet, tv_chambolle}.denoise_nl_meansalso defaults tomultichannel=Trueand though not discussed this is changed as well.Checklist
References
This closes #2465.