MaskPlane#

class lsst.images.MaskPlane(name: str, description: str)#

Bases: object

Name and description of a single plane in a mask array.

Methods Summary

read_legacy(header, *[, strip])

Read mask plane descriptions written by lsst.afw.image.Mask.writeFits.

Methods Documentation

classmethod read_legacy(header: Header, *, strip: bool = True) → dict[str, int]#

Read mask plane descriptions written by lsst.afw.image.Mask.writeFits.

Parameters#

header: FITS header.
strip: If True (default), delete the MP_ cards from the header after reading them, as appropriate when the mask is being reinterpreted for new code only. If False, leave them in place so they can be propagated for backwards compatibility (re-indexed to the new schema by the caller).

dict [str, int]: A dictionary mapping mask plane name to integer bit index.