lsst.coadd.utils.makeBitMask Namespace Reference

Functions
def	makeBitMask

Variables
list	__all__ = ["makeBitMask"]

Function Documentation

def lsst.coadd.utils.makeBitMask.makeBitMask	(		maskPlaneNameList,
			doInvert = False
	)

Generate a bit mask consisting of ORed together Mask bit planes

@deprecated use afwImage.MaskU.getPlaneBitMask(maskPlaneNameList) instead.

@input[in] maskPlaneNameList: list of mask plane names
@input[in] doInvert: if True then invert the result

@return a bit mask consisting of the named bit planes ORed together (with the result possibly inverted)

Definition at line 27 of file makeBitMask.py.

def makeBitMask(maskPlaneNameList, doInvert=False):
    """Generate a bit mask consisting of ORed together Mask bit planes
    
    @deprecated use afwImage.MaskU.getPlaneBitMask(maskPlaneNameList) instead.
    
    @input[in] maskPlaneNameList: list of mask plane names
    @input[in] doInvert: if True then invert the result
    
    @return a bit mask consisting of the named bit planes ORed together (with the result possibly inverted)
    """
    bitMask = afwImage.MaskU.getPlaneBitMask(maskPlaneNameList)
    if doInvert:
        bitMask = (2**afwImage.MaskU_getNumPlanesMax() - 1) - bitMask
    return bitMask

Variable Documentation

list lsst.coadd.utils.makeBitMask.__all__ = ["makeBitMask"]

Definition at line 25 of file makeBitMask.py.