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 9866a22

Browse filesBrowse files
committed
Update imshow docs.
- Reword a bit description of X argument. Note that *any* integer data, even if not uint8, is interpreted as 0-255 uint8 (with clipping to that range). - Move the doc for `norm` up to its position in the signature (right after `cmap`). Reword the docs for `cmap` and `norm` to be phrased more similarly. - Move the doc for `alpha` up to its position in the signature (before `vmin`, `vmax`).
1 parent 623b789 commit 9866a22
Copy full SHA for 9866a22

File tree

Expand file treeCollapse file tree

1 file changed

+15
-18
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+15
-18
lines changed

‎lib/matplotlib/axes/_axes.py

Copy file name to clipboardExpand all lines: lib/matplotlib/axes/_axes.py
+15-18Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5406,22 +5406,26 @@ def imshow(self, X, cmap=None, norm=None, aspect=None,
54065406
54075407
- (M, N): an image with scalar data. The data is visualized
54085408
using a colormap.
5409-
- (M, N, 3): an image with RGB values (float or uint8).
5410-
- (M, N, 4): an image with RGBA values (float or uint8), i.e.
5411-
including transparency.
5409+
- (M, N, 3): an image with RGB values (0-1 float or 0-255 int).
5410+
- (M, N, 4): an image with RGBA values (0-1 float or 0-255 int),
5411+
i.e. including transparency.
54125412
54135413
The first two dimensions (M, N) define the rows and columns of
54145414
the image.
54155415
5416-
The RGB(A) values should be in the range [0 .. 1] for floats or
5417-
[0 .. 255] for integers. Out-of-range values will be clipped to
5418-
these bounds.
5416+
Out-of-range RGB(A) values are clipped.
54195417
54205418
cmap : str or `~matplotlib.colors.Colormap`, optional
5421-
A Colormap instance or registered colormap name. The colormap
5422-
maps scalar data to colors. It is ignored for RGB(A) data.
5419+
The Colormap instance or registered colormap name used to map
5420+
scalar data to colors. This parameter is ignored for RGB(A) data.
54235421
Defaults to :rc:`image.cmap`.
54245422
5423+
norm : `~matplotlib.colors.Normalize`, optional
5424+
The `Normalize` instance used to scale scalar data to the [0, 1]
5425+
range before mapping to colors using *cmap*. By default, a linear
5426+
scaling mapping the lowest value to 0 and the highest to 1 is used.
5427+
This parameter is ignored for RGB(A) data.
5428+
54255429
aspect : {'equal', 'auto'} or float, optional
54265430
Controls the aspect ratio of the axes. The aspect is of particular
54275431
relevance for images since it may distort the image, i.e. pixel
@@ -5462,23 +5466,16 @@ def imshow(self, X, cmap=None, norm=None, aspect=None,
54625466
which can be set by *filterrad*. Additionally, the antigrain image
54635467
resize filter is controlled by the parameter *filternorm*.
54645468
5465-
norm : `~matplotlib.colors.Normalize`, optional
5466-
If scalar data are used, the Normalize instance scales the
5467-
data values to the canonical colormap range [0,1] for mapping
5468-
to colors. By default, the data range is mapped to the
5469-
colorbar range using linear scaling. This parameter is ignored for
5470-
RGB(A) data.
5469+
alpha : scalar, optional
5470+
The alpha blending value, between 0 (transparent) and 1 (opaque).
5471+
This parameter is ignored for RGBA input data.
54715472
54725473
vmin, vmax : scalar, optional
54735474
When using scalar data and no explicit *norm*, *vmin* and *vmax*
54745475
define the data range that the colormap covers. By default,
54755476
the colormap covers the complete value range of the supplied
54765477
data. *vmin*, *vmax* are ignored if the *norm* parameter is used.
54775478
5478-
alpha : scalar, optional
5479-
The alpha blending value, between 0 (transparent) and 1 (opaque).
5480-
This parameter is ignored for RGBA input data.
5481-
54825479
origin : {'upper', 'lower'}, optional
54835480
Place the [0,0] index of the array in the upper left or lower left
54845481
corner of the axes. The convention 'upper' is typically used for

0 commit comments

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