lsst.ip.isr.isrQa Namespace Reference

Classes
class	IsrQaConfig
class	IsrQaFlatnessConfig

Functions
	makeThumbnail (exposure, isrQaConfig=None)

Function Documentation

makeThumbnail()

lsst.ip.isr.isrQa.makeThumbnail	(		exposure,
			isrQaConfig = None )

Create a snapshot thumbnail from input exposure.

The output thumbnail image is constructed based on the parameters
in the configuration file.  Currently, the asinh mapping is the
only mapping method used.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    The exposure to be converted into a thumbnail.
isrQaConfig : `Config`
    Configuration object containing all parameters to control the
    thumbnail generation.

Returns
-------
rgbImage : `numpy.ndarray`
    Binned and scaled version of the exposure, converted to an
    integer array to allow it to be written as PNG.

Definition at line 119 of file isrQa.py.

def makeThumbnail(exposure, isrQaConfig=None):
    """Create a snapshot thumbnail from input exposure.
 
    The output thumbnail image is constructed based on the parameters
    in the configuration file.  Currently, the asinh mapping is the
    only mapping method used.
 
    Parameters
    ----------
    exposure : `lsst.afw.image.Exposure`
        The exposure to be converted into a thumbnail.
    isrQaConfig : `Config`
        Configuration object containing all parameters to control the
        thumbnail generation.
 
    Returns
    -------
    rgbImage : `numpy.ndarray`
        Binned and scaled version of the exposure, converted to an
        integer array to allow it to be written as PNG.
    """
    if isrQaConfig is not None:
        binning = isrQaConfig.thumbnailBinning
        binnedImage = afwMath.binImage(exposure.getMaskedImage(), binning, binning, afwMath.MEAN)
 
        statsCtrl = afwMath.StatisticsControl()
        statsCtrl.setAndMask(binnedImage.getMask().getPlaneBitMask(["SAT", "BAD", "INTRP"]))
        stats = afwMath.makeStatistics(binnedImage,
                                       afwMath.MEDIAN | afwMath.STDEVCLIP | afwMath.MAX, statsCtrl)
 
        low = stats.getValue(afwMath.MEDIAN) - isrQaConfig.thumbnailStdev*stats.getValue(afwMath.STDEVCLIP)
 
        if isrQaConfig.thumbnailSatBorder:
            afwRGB.replaceSaturatedPixels(binnedImage, binnedImage, binnedImage,
                                          isrQaConfig.thumbnailSatBorder, stats.getValue(afwMath.MAX))
 
        asinhMap = afwRGB.AsinhMapping(low, isrQaConfig.thumbnailRange, Q=isrQaConfig.thumbnailQ)
        rgbImage = asinhMap.makeRgbImage(binnedImage)
 
        return rgbImage