Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 555e737

Browse filesBrowse files
committed
Minor tweaks to image docs.
1 parent 31b1b91 commit 555e737
Copy full SHA for 555e737

File tree

Expand file treeCollapse file tree

1 file changed

+17
-16
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+17
-16
lines changed

‎lib/matplotlib/image.py

Copy file name to clipboardExpand all lines: lib/matplotlib/image.py
+17-16Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -234,17 +234,18 @@ class _ImageBase(mcolorizer.ColorizingArtist):
234234
"""
235235
Base class for images.
236236
237-
interpolation and cmap default to their rc settings
237+
*interpolation* and *cmap* default to their rc settings.
238238
239-
cmap is a colors.Colormap instance
240-
norm is a colors.Normalize instance to map luminance to 0-1
239+
*cmap* is a `.colors.Colormap` instance.
240+
*norm* is a `.colors.Normalize` instance to map luminance to 0-1.
241241
242-
extent is data axes (left, right, bottom, top) for making image plots
243-
registered with data plots. Default is to label the pixel
244-
centers with the zero-based row and column indices.
242+
*extent* is a ``(left, right, bottom, top)`` tuple in data coordinates, for
243+
making image plots registered with data plots; the default is to label the
244+
pixel centers with the zero-based row and column indices.
245245
246-
Additional kwargs are matplotlib.artist properties
246+
Additional kwargs are `.Artist` properties.
247247
"""
248+
248249
zorder = 0
249250

250251
def __init__(self, ax,
@@ -733,11 +734,10 @@ def set_interpolation_stage(self, s):
733734
734735
Parameters
735736
----------
736-
s : {'data', 'rgba', 'auto'} or None
737-
Whether to apply up/downsampling interpolation in data or RGBA
738-
space. If None, use :rc:`image.interpolation_stage`.
739-
If 'auto' we will check upsampling rate and if less
740-
than 3 then use 'rgba', otherwise use 'data'.
737+
s : {'data', 'rgba', 'auto'}, default: :rc:`image.interpolation_stage`
738+
Whether to apply resampling interpolation in data or RGBA space.
739+
If 'auto', 'rgba' is used if the upsampling rate is less than 3,
740+
otherwise 'data' is used.
741741
"""
742742
s = mpl._val_or_rc(s, 'image.interpolation_stage')
743743
_api.check_in_list(['data', 'rgba', 'auto'], s=s)
@@ -758,8 +758,7 @@ def set_resample(self, v):
758758
759759
Parameters
760760
----------
761-
v : bool or None
762-
If None, use :rc:`image.resample`.
761+
v : bool, default: :rc:`image.resample`
763762
"""
764763
v = mpl._val_or_rc(v, 'image.resample')
765764
self._resample = v
@@ -788,8 +787,10 @@ def get_filternorm(self):
788787

789788
def set_filterrad(self, filterrad):
790789
"""
791-
Set the resize filter radius only applicable to some
792-
interpolation schemes -- see help for imshow
790+
Set the resize filter radius (only applicable to some
791+
interpolation schemes).
792+
793+
See help for `~.Axes.imshow`.
793794
794795
Parameters
795796
----------

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.