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.NormalizeNormalization class to be used with Matplotlib.
- Parameters
data :
ndarray, optionalThe image array. This input is used only if
intervalis also input.dataandintervalare used to compute the vmin and/or vmax values only ifvminorvmaxare not input.interval :
BaseIntervalsubclass instance, optionalThe interval object to apply to the input
datato determine thevminandvmaxvalues. This input is used only ifdatais also input.dataandintervalare used to compute the vmin and/or vmax values only ifvminorvmaxare not input.vmin, vmax : float, optional
The minimum and maximum levels to show for the data. The
vminandvmaxinputs override any calculated values from theintervalanddatainputs.stretch :
BaseStretchsubclass instanceThe stretch object to apply to the data. The default is
LinearStretch.clip : bool, 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__(values[, clip])Normalize value data in the
[vmin, vmax]interval into the[0.0, 1.0]interval and return it.inverse(values)Methods Documentation