|
def | __init__ (self, filters, array, bbox=None) |
|
def | getMaskPlane (self, key) |
|
def | getPlaneBitMask (self, names) |
|
def | getNumPlanesMax (self) |
|
def | getNumPlanesUsed (self) |
|
def | getMaskPlaneDict (self) |
|
def | removeAndClearMaskPlane (self, name, removeFromDefault=False) |
|
def | clearAllMaskPlanes (self) |
|
def | __ior__ (self, others) |
|
def | __iand__ (self, others) |
|
def | __ixor__ (self, others) |
|
Multiband Mask class
See `MultibandImageBase` for a description of the parameters.
Definition at line 353 of file _multiband.py.
◆ __init__()
def lsst.afw.image._image._multiband.MultibandMask.__init__ |
( |
|
self, |
|
|
|
filters, |
|
|
|
array, |
|
|
|
bbox = None |
|
) |
| |
◆ __iand__()
def lsst.afw.image._image._multiband.MultibandMask.__iand__ |
( |
|
self, |
|
|
|
others |
|
) |
| |
◆ __ior__()
def lsst.afw.image._image._multiband.MultibandMask.__ior__ |
( |
|
self, |
|
|
|
others |
|
) |
| |
◆ __ixor__()
def lsst.afw.image._image._multiband.MultibandMask.__ixor__ |
( |
|
self, |
|
|
|
others |
|
) |
| |
◆ addMaskPlane()
def lsst.afw.image._image._multiband.MultibandMask.addMaskPlane |
( |
|
name | ) |
|
|
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.
◆ clearAllMaskPlanes()
def lsst.afw.image._image._multiband.MultibandMask.clearAllMaskPlanes |
( |
|
self | ) |
|
◆ clearMaskPlaneDict()
def lsst.afw.image._image._multiband.MultibandMask.clearMaskPlaneDict |
( |
| ) |
|
|
static |
◆ fromKwargs()
def lsst.afw.image._image._multiband.MultibandMask.fromKwargs |
( |
|
filters, |
|
|
|
filterKwargs, |
|
|
|
singleType = ImageF , |
|
|
** |
kwargs |
|
) |
| |
|
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.
◆ fromMasks()
def lsst.afw.image._image._multiband.MultibandMask.fromMasks |
( |
|
filters, |
|
|
|
singles |
|
) |
| |
|
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.
◆ getMaskPlane()
def 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.
◆ getMaskPlaneDict()
def lsst.afw.image._image._multiband.MultibandMask.getMaskPlaneDict |
( |
|
self | ) |
|
Dictionary of Mask Plane bit values
Definition at line 453 of file _multiband.py.
◆ getNumPlanesMax()
def 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.
◆ getNumPlanesUsed()
def 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.
◆ getPlaneBitMask()
def 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.
◆ removeAndClearMaskPlane()
def 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.
◆ removeMaskPlane()
def lsst.afw.image._image._multiband.MultibandMask.removeMaskPlane |
( |
|
name | ) |
|
|
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.
The documentation for this class was generated from the following file: