imutil.pixels.find_satpix

imutil.pixels.find_satpix(
    ccd,
    mask=None,
    satlevel=65535,
    bezels=None,
    order_xyz=True,
    update_header=True,
    verbose=0,
)

Finds saturated pixel values excluding masked pixels.

Parameters

ccd : ~astropy.nddata.CCDData, ~numpy.ndarray: The ccd to find extreme values. If ndarray, update_header will automatically be set to False.
mask : ~astropy.nddata.CCDData-like (e.g., ~astropy.io.fits.PrimaryHDU, ~astropy.io.fits.ImageHDU, ~astropy.io.fits.HDUList), ~numpy.ndarray, path-like, or number-like, optional. = None: The mask to be used. To reduce file I/O time, better to provide ~numpy.ndarray. Default: None.
satlevel : float = 65535: The saturation level. Pixels >= satlevel will be treated as saturated pixels, except for those masked by mask. Default: 65535.
bezels : list of list of int, optional. = None: If given, must be a list of list of int. Each list of int is in the form of [lower, upper], i.e., the first lower and last upper rows/columns are ignored. Default: None.
order_xyz : bool, optional. = True: Whether bezel in xyz order or not (python order: xyz_order[::-1]). Default: True.