@@ -5484,15 +5484,21 @@ def imshow(self, X, cmap=None, norm=None, aspect=None,
5484
5484
origin = None ,extent = None ,shape = None ,filternorm = 1 ,
5485
5485
filterrad = 4.0 ,imlim = None ,resample = None ,url = None ,** kwargs ):
5486
5486
"""
5487
- Display an image, i.e. data on a 2D regular raster.
5487
+ Display data as an image; i.e. on a 2D regular raster.
5488
+
5489
+ The input may either be actual RGB(A) data, or 2D scalar data, which
5490
+ will be rendered as a pseudocolor image. Note: For actually displaying
5491
+ a grayscale image set up the color mapping using the parameters
5492
+ ``cmap='gray', vmin=0, vmax=255``.
5488
5493
5489
5494
Parameters
5490
5495
----------
5491
5496
X : array-like or PIL image
5492
5497
The image data. Supported array shapes are:
5493
5498
5494
- - (M, N): an image with scalar data. The data is visualized
5495
- using a colormap.
5499
+ - (M, N): an image with scalar data. The values are mapped to
5500
+ colors using normalization and a colormap. See parameters *norm*,
5501
+ *cmap*, *vmin*, *vmax*.
5496
5502
- (M, N, 3): an image with RGB values (0-1 float or 0-255 int).
5497
5503
- (M, N, 4): an image with RGBA values (0-1 float or 0-255 int),
5498
5504
i.e. including transparency.