lsst.meas.algorithms.dynamicDetection Namespace Reference

Classes
class	DynamicDetectionConfig
class	DynamicDetectionTask

Functions
	countMaskedPixels (maskedIm, maskPlane)

Function Documentation

countMaskedPixels()

lsst.meas.algorithms.dynamicDetection.countMaskedPixels	(		maskedIm,
			maskPlane )

Count the number of pixels in a given mask plane.

Parameters
----------
maskedIm : `lsst.afw.image.MaskedImage`
    Masked image to examine.
maskPlane : `str`
    Name of the mask plane to examine.

Returns
-------
nPixMasked : `int`
    Number of pixels with ``maskPlane`` bit set.

Definition at line 491 of file dynamicDetection.py.

def countMaskedPixels(maskedIm, maskPlane):
    """Count the number of pixels in a given mask plane.
 
    Parameters
    ----------
    maskedIm : `lsst.afw.image.MaskedImage`
        Masked image to examine.
    maskPlane : `str`
        Name of the mask plane to examine.
 
    Returns
    -------
    nPixMasked : `int`
        Number of pixels with ``maskPlane`` bit set.
    """
    maskBit = maskedIm.mask.getPlaneBitMask(maskPlane)
    nPixMasked = np.sum(np.bitwise_and(maskedIm.mask.array, maskBit))/maskBit
    return nPixMasked