BaseInterval

class astropy.visualization.BaseInterval

Bases: BaseTransform

Base class for the interval classes, which, when called with an array of values, return an interval computed following different algorithms.

Methods Summary

__call__(values[, clip, out])	Transform values using this interval.
get_limits(values)	Return the minimum and maximum value in the interval based on the values provided.

Methods Documentation

__call__(values, clip=True, out=None)

Transform values using this interval.

The vmin and vmax values are determined by the get_limits method.

The following transformation is then applied to the values:

\[{\rm result} = \frac{{\rm values} - v_{\rm min}} {v_{\rm max} - v_{\rm min}}\]

If clip is True (default), the result is then clipped to the [0:1] range.

Parameters:

valuesnumpy:array_like

The input values.

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.

abstractmethod get_limits(values)

Return the minimum and maximum value in the interval based on the values provided.

Parameters:

valuesndarray

The image values.

Returns:

vmin, vmaxpython:float

The mininium and maximum image value in the interval.