Add section on artifacts to imshow docs #16999
Merged
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
QuLogic
reviewed
Apr 2, 2020
ae5866c to
5ee5a19
Compare
story645
approved these changes
Apr 2, 2020
jklymak
reviewed
Apr 2, 2020
lib/matplotlib/axes/_axes.py
Outdated
| match the number of pixels given in *X*. *interpolation* is used to | ||
| calculate the displayed pixels, which is inherently prone to visual | ||
| artifacts. Depending on the ratio of given to need pixels different | ||
| interpolation methods may be preferable. |
There was a problem hiding this comment.
Maybe:
"""
The number of pixels used to render an image is set by the axes
size and the *dpi* of the figure, so the image size will usually not
match the size of *X*, which can lead to aliasing artifacts when the
image is resampled
(see :doc:`/gallery/images_contours_and_fields/image_antialiasing`).
The resampling can be controlled via the *interpolation* kwarg
and/or :rc:`image.interpolation`, which defaults to 'antialiased'.
"""There was a problem hiding this comment.
Sorry my suggedtions crosses @story645 please meld as you see fit.
There was a problem hiding this comment.
I think yours is mostly clearer, but I'd break it up a little:
"""The number of pixels used to render an image is set by the axes
size and the *dpi* of the figure. This can lead to aliasing artifacts when the
image is resampled because the displayed image size will usually not
match the size of *X*."""
There was a problem hiding this comment.
.. agreed, that was a run-on sentence.
025ccc3 to
b44d4ca
Compare
QuLogic
reviewed
Apr 4, 2020
lib/matplotlib/axes/_axes.py
Outdated
| @@ -5433,7 +5441,7 @@ def imshow(self, X, cmap=None, norm=None, aspect=None, | |||
| The filter radius for filters that have a radius parameter, i.e. | |||
| when interpolation is one of: 'sinc', 'lanczos' or 'blackman'. | |||
|
|
|||
| resample : bool, optional | |||
| resample : bool, default: False | |||
There was a problem hiding this comment.
The default for AxesImage is False; the default for imshow is None, which means the default here should be the 'image.resample' rcParam.
Co-authored-by: Jody Klymak <[email protected]> Co-authored-by: hannah <[email protected]>
b44d4ca to
a32fb6a
Compare
tacaswell
approved these changes
Apr 4, 2020
|
Travis OSX failure is unreleated. |
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.
PR Summary
Closes #16976.
And some minor cleanups.