lsst.cp.pipe.cpCombine Namespace Reference

Classes
class	CalibStatsConfig
class	CalibStatsTask
class	CalibCombineConnections
class	CalibCombineConfig
class	CalibCombineTask
class	CalibCombineByFilterConnections
class	CalibCombineByFilterConfig
class	CalibCombineByFilterTask

Functions
def	VignetteExposure (exposure, polygon=None, doUpdateMask=True, maskPlane="NO_DATA", doSetValue=False, vignetteValue=0.0, log=None)

Function Documentation

VignetteExposure()

def lsst.cp.pipe.cpCombine.VignetteExposure	(		exposure,
			polygon = None,
			doUpdateMask = True,
			maskPlane = "NO_DATA",
			doSetValue = False,
			vignetteValue = 0.0,
			log = None
	)

Apply vignetted polygon to image pixels.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Image to be updated.
doUpdateMask : `bool`, optional
    Update the exposure mask for vignetted area?
maskPlane : `str`, optional
    Mask plane to assign.
doSetValue : `bool`, optional
    Set image value for vignetted area?
vignetteValue : `float`, optional
    Value to assign.
log : `lsst.log.Log`, optional
    Log to write to.

Raises
------
RuntimeError
    Raised if no valid polygon exists.

Definition at line 558 of file cpCombine.py.

                     log=None):
    """Apply vignetted polygon to image pixels.
 
    Parameters
    ----------
    exposure : `lsst.afw.image.Exposure`
        Image to be updated.
    doUpdateMask : `bool`, optional
        Update the exposure mask for vignetted area?
    maskPlane : `str`, optional
        Mask plane to assign.
    doSetValue : `bool`, optional
        Set image value for vignetted area?
    vignetteValue : `float`, optional
        Value to assign.
    log : `lsst.log.Log`, optional
        Log to write to.
 
    Raises
    ------
    RuntimeError
        Raised if no valid polygon exists.
    """
    polygon = polygon if polygon else exposure.getInfo().getValidPolygon()
    if not polygon:
        raise RuntimeError("Could not find valid polygon!")
    log = log if log else Log.getLogger(__name__.partition(".")[2])
 
    fullyIlluminated = True
    for corner in exposure.getBBox().getCorners():
        if not polygon.contains(Point2D(corner)):
            fullyIlluminated = False
 
    log.info("Exposure is fully illuminated? %s", fullyIlluminated)
 
    if not fullyIlluminated:
        # Scan pixels.
        mask = exposure.getMask()
        numPixels = mask.getBBox().getArea()
 
        xx, yy = np.meshgrid(np.arange(0, mask.getWidth(), dtype=int),
                             np.arange(0, mask.getHeight(), dtype=int))
 
        vignMask = np.array([not polygon.contains(Point2D(x, y)) for x, y in
                             zip(xx.reshape(numPixels), yy.reshape(numPixels))])
        vignMask = vignMask.reshape(mask.getHeight(), mask.getWidth())
 
        if doUpdateMask:
            bitMask = mask.getPlaneBitMask(maskPlane)
            maskArray = mask.getArray()
            maskArray[vignMask] |= bitMask
        if doSetValue:
            imageArray = exposure.getImage().getArray()
            imageArray[vignMask] = vignetteValue
        log.info("Exposure contains %d vignetted pixels.",
                 np.count_nonzero(vignMask))