BaseStretch

class astropy.visualization.BaseStretch[source]

Bases: astropy.visualization.BaseTransform

Base class for the stretch classes, which, when called with an array of values in the range [0:1], return an transformed array of values, also in the range [0:1].

Attributes Summary

inverse

A stretch object that performs the inverse operation.

Methods Summary

__call__(self, values[, clip, out])

Transform values using this stretch.

Attributes Documentation

inverse

A stretch object that performs the inverse operation.

Methods Documentation

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

Transform values using this stretch.

Parameters
valuesarray-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.