imshow_simple_norm

astropy.visualization.mpl_normalize.imshow_simple_norm(data, ax=None, **kwargs)

A convenience function to call matplotlib’s matplotlib.pyplot.imshow function, using an SimpleNorm object as the normalization.

Parameters:

data2D or 3D numpy:array_like

The data to show. Can be whatever imshow and SimpleNorm both accept. See imshow.

axpython:None or Axes, optional

If None, use pyplot’s imshow. Otherwise, calls imshow method of the supplied axes.

**kwargspython:dict, optional

All other keyword arguments are parsed first by the SimpleNorm initializer, then to imshow.

Returns:

resultpython:tuple

A tuple containing the AxesImage generated by imshow as well as the ImageNormalize instance generated by SimpleNorm.

Notes

The norm matplotlib keyword is not supported.

Examples

import numpy as np
import matplotlib.pyplot as plt
from astropy.visualization import imshow_simple_norm

# Generate and display a test image
image = np.arange(65536).reshape((256, 256))
fig = plt.figure()
ax = fig.add_subplot(1, 1, 1)
im, norm = imshow_simple_norm(image, ax, origin='lower',
                       min_percent=1, max_percent=99.9,
                       stretch='sinh')
fig.colorbar(im)

(png, svg, pdf)