lsst.ip.isr.isrQa Namespace Reference

Classes
class	IsrQaFlatnessConfig
class	IsrQaConfig

Functions
def	makeThumbnail (exposure, isrQaConfig=None)
def	writeThumbnail (dataRef, thumb, dataset)

Function Documentation

makeThumbnail()

def 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
 
 

writeThumbnail()

def lsst.ip.isr.isrQa.writeThumbnail	(		dataRef,
			thumb,
			dataset
	)

Write snapshot thumbnail to disk.

Parameters
----------
dataRef : `daf.persistence.butlerSubset.ButlerDataRef`
    Butler dataref to use to construct the output filename.
thumb : `numpy.ndarray`
    Binned and scaled image to be written as a PNG.
dataset : `str`
    String containing the dataset for this thumbnail.

Raises
------
OSError
    Raised if the output directory cannot be created and does not
    exist.

Definition at line 161 of file isrQa.py.

def writeThumbnail(dataRef, thumb, dataset):
    """Write snapshot thumbnail to disk.
 
    Parameters
    ----------
    dataRef : `daf.persistence.butlerSubset.ButlerDataRef`
        Butler dataref to use to construct the output filename.
    thumb : `numpy.ndarray`
        Binned and scaled image to be written as a PNG.
    dataset : `str`
        String containing the dataset for this thumbnail.
 
    Raises
    ------
    OSError
        Raised if the output directory cannot be created and does not
        exist.
    """
    filename = dataRef.get(dataset + "_filename")[0]
    directory = os.path.dirname(filename)
    if not os.path.exists(directory):
        try:
            os.makedirs(directory)
        except OSError as e:
            # Don't fail if directory exists due to race condition.
            if e.errno != errno.EEXIST:
                raise e
    afwRGB.writeRGB(filename, thumb)