ImageNormalize

class astropy.visualization.ImageNormalize(data=None, interval=None, vmin=None, vmax=None, stretch=<astropy.visualization.stretch.LinearStretch object>, clip=False)[source]

Bases: matplotlib.colors.Normalize

Normalization class to be used with Matplotlib.

Parameters
datandarray, optional

The image array. This input is used only if interval is also input. data and interval are used to compute the vmin and/or vmax values only if vmin or vmax are not input.

intervalBaseInterval subclass instance, optional

The interval object to apply to the input data to determine the vmin and vmax values. This input is used only if data is also input. data and interval are used to compute the vmin and/or vmax values only if vmin or vmax are not input.

vmin, vmaxfloat

The minimum and maximum levels to show for the data. The vmin and vmax inputs override any calculated values from the interval and data inputs.

stretchBaseStretch subclass instance, optional

The stretch object to apply to the data. The default is LinearStretch.

clipbool, optional

If True, data values outside the [0:1] range are clipped to the [0:1] range.

If vmin or vmax is not given, they are initialized from the minimum and maximum value respectively of the first input processed. That is, __call__(A) calls autoscale_None(A). If clip is True and the given value falls outside the range, the returned value will be 0 or 1, whichever is closer. Returns 0 if:

vmin==vmax

Works with scalars or arrays, including masked arrays. If clip is True, masked values are set to 1; otherwise they remain masked. Clipping silently defeats the purpose of setting the over, under, and masked colors in the colormap, so it is likely to lead to surprises; therefore the default is clip = False.

Methods Summary

__call__(self, values[, clip])

Normalize value data in the [vmin, vmax] interval into the [0.0, 1.0] interval and return it.

inverse(self, values)

Methods Documentation

__call__(self, values, clip=None)[source]

Normalize value data in the [vmin, vmax] interval into the [0.0, 1.0] interval and return it. clip defaults to self.clip (which defaults to False). If not already initialized, vmin and vmax are initialized using autoscale_None(value).

inverse(self, values)[source]