SinhStretch#
- class astropy.visualization.SinhStretch(a=0.3333333333333333)[source]#
Bases:
BaseStretchA sinh stretch.
The stretch is given by:
\[y = \frac{{\rm sinh}(x / a)}{{\rm sinh}(1 / a)}\]- Parameters:
- a
float, optional The
aparameter used in the above formula. The stretch becomes more linear as theavalue is increased.amust be greater than 0. Default is 1/3.
- a
Attributes Summary
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:
- 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.- out
ndarray, optional If specified, the output values will be placed in this array (typically used for in-place calculations).
- Returns:
- result
ndarray The transformed values.
- result