HistEqStretch

class astropy.visualization.HistEqStretch(data, values=None)[source]

Bases: BaseStretch

A histogram equalization stretch.

Parameters:
datanumpy:array_like

The data defining the equalization.

valuesnumpy:array_like, optional

The input image values, which should already be normalized to the [0:1] range.

Attributes Summary

inverse

A stretch object that performs the inverse operation.

Methods Summary

__call__(values[, clip, out])

Transform values using this stretch.

Attributes Documentation

inverse

A stretch object that performs the inverse operation.

Methods Documentation

__call__(values, clip=True, out=None)[source]

Transform values using this stretch.

Parameters:
valuesnumpy:array_like

The input values, which should already be normalized to the [0:1] range.

clipbool, optional

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

outndarray, optional

If specified, the output values will be placed in this array (typically used for in-place calculations).

Returns:
resultndarray

The transformed values.