update sigma_color description in denoise_bilateral #5393
Conversation
Update the description of `sigma_color` in `denoise_bilateral`. See: scikit-image#5391
|
Hello @felipegb94! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found: There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻 Comment last updated at 2021-05-20 18:34:51 UTC |
Fix PEP 8 issues raised for this PR scikit-image#5393
|
Closes #5391 |
Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org>
Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org>
skimage/restoration/_denoise.py
Outdated
| ``image`` will be used. Note that, if the image is of | ||
| any `int` dtype, ``image`` will be converted using the `img_as_float` | ||
| function and thus the standard deviation will be in | ||
| range ``[0, 1]``. For more information on scikit-image's data | ||
| type conversions and how images are rescaled in these conversions, | ||
| see: https://scikit-image.org/docs/stable/user_guide/data_types.html. |
There was a problem hiding this comment.
I think that Note that... .html. would be better placed in the Notes section, like:
Note that, if the image is of
any `int` dtype, ``image`` will be converted using the `img_as_float`
function and thus the standard deviation will be in
range ``[0, 1]``.
For more information on scikit-image's data
type conversions and how images are rescaled in these conversions,
see: https://scikit-image.org/docs/stable/user_guide/data_types.html.
There was a problem hiding this comment.
Respecting PEP-8, of course 😅
There was a problem hiding this comment.
got it. just applied the suggestions you made. thanks!
There was a problem hiding this comment.
Thank you @felipegb94! I think that these instructions feel too "heavy" for the description already; just left a suggestion, then.
Thanks again!
skimage/restoration/_denoise.py
Outdated
| ``image`` will be used. Note that, if the image is of | ||
| any `int` dtype, ``image`` will be converted using the `img_as_float` | ||
| function and thus the standard deviation will be in | ||
| range ``[0, 1]``. For more information on scikit-image's data | ||
| type conversions and how images are rescaled in these conversions, | ||
| see: https://scikit-image.org/docs/stable/user_guide/data_types.html. |
There was a problem hiding this comment.
Respecting PEP-8, of course 😅
Move some denoise_bilateral `sigma_color` text to Notes
|
It looks great @felipegb94! Thank you very much for your work! |
Description
Update the description of
sigma_colorindenoise_bilateralto make it clear thatimg_as_floatonly rescales images with anyinttype, and that it does not rescalefloatimages.See discussion in: #5391
Checklist
N/A
For reviewers
later.
__init__.py.doc/release/release_dev.rst.