make_exposure_map

xrtpy.util.make_exposure_map(comp_image_file, qualfiles=None, retsatpix=False, verbose=False)

Make an exposure map for a composite image. That is, using data from the header of a composite image, create an image where the pixel values are the exposure times used in the composite image

Parameters:

comp_image_filestring or pathlib.Path object

input composite image. Can be a double or a triple composite

qualfileslist of strings or Path objects, optional

data quality filenames or paths that correspond to the images that make up the composite image. If the composite is a triple, should be list of two values, medium and long. If the composite is a double, only a single values should be given, the long exposure qualfile. Must be in order, [medium, long] if composite is a triple.

retsatpixboolean, optional

if True, return the saturated pixel (boolean) images for the long image, and if the composite is a triple, also the medium image. If those images are returned then it is in addtiion to the exposure map, as a tuple: expmap, lng_sat or expmap, med_sat, lng_sat

verboseboolean, optional

if True, print diagnostic information

Returns:

exp_mapnumpy array

image in the shape of the input composite image where each pixel has the exposure time that corresponds to that pixel in the composite image

med_satboolean array, optional

if retsatpix is True and the input image is a triple composite, then this array is returned with the pixels for which the medium exposure is saturated set to True and all others False

lng_satboolean array, optional

if retsatpix is True, then this array is returned with the pixels for which the long exposure is saturated set to True and all others False