ZScaleInterval¶
-
class
astropy.visualization.
ZScaleInterval
(nsamples=1000, contrast=0.25, max_reject=0.5, min_npixels=5, krej=2.5, max_iterations=5)[source]¶ Bases:
astropy.visualization.BaseInterval
Interval based on IRAF’s zscale.
https://iraf.net/forum/viewtopic.php?showtopic=134139
Original implementation: https://github.com/spacetelescope/stsci.numdisplay/blob/master/lib/stsci/numdisplay/zscale.py
Licensed under a 3-clause BSD style license (see AURA_LICENSE.rst).
- Parameters
- nsamplesint, optional
The number of points in the array to sample for determining scaling factors. Defaults to 1000.
- contrastfloat, optional
The scaling factor (between 0 and 1) for determining the minimum and maximum value. Larger values increase the difference between the minimum and maximum values used for display. Defaults to 0.25.
- max_rejectfloat, optional
If more than
max_reject * npixels
pixels are rejected, then the returned values are the minimum and maximum of the data. Defaults to 0.5.- min_npixelsint, optional
If there are less than
min_npixels
pixels remaining after the pixel rejection, then the returned values are the minimum and maximum of the data. Defaults to 5.- krejfloat, optional
The number of sigma used for the rejection. Defaults to 2.5.
- max_iterationsint, optional
The maximum number of iterations for the rejection. Defaults to 5.
Methods Summary
get_limits
(self, values)Return the minimum and maximum value in the interval based on the values provided.
Methods Documentation