{ } Raw JSON

bundles / skimage 0.26.1rc0.dev0+git20260530.b607368ff / skimage / io / _plugins / matplotlib_plugin / imshow

function

skimage.io._plugins.matplotlib_plugin:imshow

source: /dev/scikit-image/src/skimage/io/_plugins/matplotlib_plugin.py :122

Signature

def   imshow ( image ax = None show_cbar = None ** kwargs )

Summary

Show the input image and return the current axes.

Extended Summary

By default, the image is displayed in grayscale, rather than the matplotlib default colormap.

Images are assumed to have standard range for their type. For example, if a floating point image has values in [0, 0.5], the most intense color will be gray50, not white.

If the image exceeds the standard range, or if the range is too small to display, we fall back on displaying exactly the range of the input image, along with a colorbar to clearly indicate that this range transformation has occurred.

For signed images, we use a diverging colormap centered at 0.

Parameters

image : array, shape (M, N[, 3])

The image to display.

ax : `matplotlib.axes.Axes`, optional

The axis to use for the image, defaults to plt.gca().

show_cbar : bool, optional

Whether to show the colorbar (used to override default behavior).

**kwargs : Any

These are passed directly to matplotlib.pyplot.imshow.

Returns

ax_im : `matplotlib.pyplot.AxesImage`

The AxesImage object returned by plt.imshow.

Aliases

  • skimage.io._plugins.matplotlib_plugin.imshow