LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
|
Public Member Functions | |
__init__ (self, filters, array, bbox=None) | |
getMaskPlane (self, key) | |
getPlaneBitMask (self, names) | |
getNumPlanesMax (self) | |
getNumPlanesUsed (self) | |
getMaskPlaneDict (self) | |
removeAndClearMaskPlane (self, name, removeFromDefault=False) | |
clearAllMaskPlanes (self) | |
__ior__ (self, others) | |
__iand__ (self, others) | |
__ixor__ (self, others) | |
Static Public Member Functions | |
fromMasks (filters, singles) | |
fromKwargs (filters, filterKwargs, singleType=ImageF, **kwargs) | |
clearMaskPlaneDict () | |
addMaskPlane (name) | |
removeMaskPlane (name) | |
Public Attributes | |
singles | |
Protected Member Functions | |
_getOtherMasks (self, others) | |
Protected Attributes | |
_refMask | |
Multiband Mask class See `MultibandImageBase` for a description of the parameters.
Definition at line 353 of file _multiband.py.
lsst.afw.image._image._multiband.MultibandMask.__init__ | ( | self, | |
filters, | |||
array, | |||
bbox = None ) |
Reimplemented from lsst.afw.image._image._multiband.MultibandImageBase.
Definition at line 358 of file _multiband.py.
lsst.afw.image._image._multiband.MultibandMask.__iand__ | ( | self, | |
others ) |
Definition at line 541 of file _multiband.py.
lsst.afw.image._image._multiband.MultibandMask.__ior__ | ( | self, | |
others ) |
Definition at line 535 of file _multiband.py.
lsst.afw.image._image._multiband.MultibandMask.__ixor__ | ( | self, | |
others ) |
Definition at line 547 of file _multiband.py.
|
protected |
Check if two masks can be combined This method checks that `self` and `others` have the same number of bands, or if others is a single value, creates a list to use for updating all of the `singles`.
Definition at line 518 of file _multiband.py.
|
static |
Add a mask to the mask plane Parameters ---------- name : `str` Name of the new mask plane Returns ------- index : `int` Bit value of the mask in the mask plane.
Definition at line 465 of file _multiband.py.
lsst.afw.image._image._multiband.MultibandMask.clearAllMaskPlanes | ( | self | ) |
Clear all the pixels
Definition at line 513 of file _multiband.py.
|
static |
Reset the mask plane dictionary
Definition at line 459 of file _multiband.py.
|
static |
Build a MultibandImage from a set of keyword arguments see `makeImageFromKwargs` for a description of parameters
Definition at line 376 of file _multiband.py.
|
static |
Construct a MultibandImage from a collection of single band images see `fromSingles` for a description of parameters
Definition at line 368 of file _multiband.py.
lsst.afw.image._image._multiband.MultibandMask.getMaskPlane | ( | self, | |
key ) |
Get the bit number of a mask in the `MaskPlaneDict` Each `key` in the mask plane has an associated bit value in the mask. This method returns the bit number of the `key` in the `MaskPlaneDict`. This is in contrast to `getPlaneBitMask`, which returns the value of the bit number. For example, if `getMaskPlane` returns `8`, then `getPlaneBitMask` returns `256`. Parameters ---------- key : `str` Name of the key in the `MaskPlaneDict` Returns ------- bit : `int` Bit number for mask `key`
Definition at line 383 of file _multiband.py.
lsst.afw.image._image._multiband.MultibandMask.getMaskPlaneDict | ( | self | ) |
Dictionary of Mask Plane bit values
Definition at line 453 of file _multiband.py.
lsst.afw.image._image._multiband.MultibandMask.getNumPlanesMax | ( | self | ) |
Maximum number of mask planes available This is required to be the same for all of the single band `Mask` objects.
Definition at line 437 of file _multiband.py.
lsst.afw.image._image._multiband.MultibandMask.getNumPlanesUsed | ( | self | ) |
Number of mask planes used This is required to be the same for all of the single band `Mask` objects.
Definition at line 445 of file _multiband.py.
lsst.afw.image._image._multiband.MultibandMask.getPlaneBitMask | ( | self, | |
names ) |
Get the bit number of a mask in the `MaskPlaneDict` Each `key` in the mask plane has an associated bit value in the mask. This method returns the bit number of the `key` in the `MaskPlaneDict`. This is in contrast to `getPlaneBitMask`, which returns the value of the bit number. For example, if `getMaskPlane` returns `8`, then `getPlaneBitMask` returns `256`. Parameters ---------- names : `str` or list of `str` Name of the key in the `MaskPlaneDict` or a list of keys. If multiple keys are used, the value returned is the integer value of the number with all of the bit values in `names`. For example if `MaskPlaneDict("CR")=3` and `MaskPlaneDict("NO_DATA)=8`, then `getPlaneBitMask(("CR", "NO_DATA"))=264` Returns ------- bit value : `int` Bit value for all of the combined bits described by `names`.
Definition at line 407 of file _multiband.py.
lsst.afw.image._image._multiband.MultibandMask.removeAndClearMaskPlane | ( | self, | |
name, | |||
removeFromDefault = False ) |
Remove and clear a mask from the mask plane Clear all pixels of the specified mask and remove the plane from the mask plane dictionary. Also optionally remove the plane from the default dictionary. Parameters ---------- name : `str` Name of the mask plane to remove removeFromDefault : `bool`, optional Whether to remove the mask plane from the default dictionary. Default is `False`.
Definition at line 492 of file _multiband.py.
|
static |
Remove a mask from the mask plane Parameters ---------- name : `str` Name of the mask plane to remove
Definition at line 482 of file _multiband.py.
|
protected |
Definition at line 361 of file _multiband.py.
lsst.afw.image._image._multiband.MultibandMask.singles |
Definition at line 527 of file _multiband.py.