astropy:docs

BaseStretch

class astropy.visualization.BaseStretch[source] [edit on github]

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 Return a stretch that performs the inverse operation.

Methods Summary

__call__(values[, out, clip]) Transform values using this stretch.

Attributes Documentation

inverse

Return a stretch that performs the inverse operation.

Methods Documentation

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

Transform values using this stretch.

Parameters:

values : ndarray or list

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

out : ndarray, optional

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

clip : bool, optional

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

Returns:

new_values : ndarray

The transformed values.

Page Contents