lsst.afw  21.0.0-35-g4939cbb3d+fb0e51fe34
Public Member Functions | Static Public Member Functions | Properties | List of all members
lsst.afw.image.image._multiband.MultibandMask Class Reference
Inheritance diagram for lsst.afw.image.image._multiband.MultibandMask:
lsst.afw.image.image._multiband.MultibandImageBase lsst.afw.multiband.MultibandBase

Public Member Functions

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)
 
def clone (self, deep=True)
 
def __setitem__ (self, args, value)
 
def getBBox (self, origin=PARENT)
 
def getBBox (self)
 
def filters (self)
 
def singles (self)
 
def getXY0 (self)
 
def x0 (self)
 
def y0 (self)
 
def origin (self)
 
def width (self)
 
def height (self)
 
def __len__ (self)
 
def __getitem__ (self, args)
 
def __iter__ (self)
 
def __next__ (self)
 
def setXY0 (self, xy0)
 
def shiftedTo (self, xy0)
 
def shiftedBy (self, offset)
 
def __repr__ (self)
 
def __str__ (self)
 

Static Public Member Functions

def fromMasks (filters, singles)
 
def fromKwargs (filters, filterKwargs, singleType=ImageF, **kwargs)
 
def clearMaskPlaneDict ()
 
def addMaskPlane (name)
 
def removeMaskPlane (name)
 

Properties

 array = property(_getArray, _setArray)
 

Detailed Description

Multiband Mask class

See `MultibandImageBase` for a description of the parameters.

Definition at line 353 of file _multiband.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.afw.image.image._multiband.MultibandMask.__init__ (   self,
  filters,
  array,
  bbox = None 
)

Reimplemented from lsst.afw.multiband.MultibandBase.

Definition at line 358 of file _multiband.py.

Member Function Documentation

◆ __getitem__()

def lsst.afw.multiband.MultibandBase.__getitem__ (   self,
  args 
)
inherited
Get a slice of the underlying array

If only a single filter is specified,
return the single band object sliced
appropriately.

Reimplemented in lsst.afw.image.image._multiband.MultibandPixel.

Definition at line 147 of file multiband.py.

◆ __iand__()

def lsst.afw.image.image._multiband.MultibandMask.__iand__ (   self,
  others 
)

Definition at line 541 of file _multiband.py.

◆ __ior__()

def lsst.afw.image.image._multiband.MultibandMask.__ior__ (   self,
  others 
)

Definition at line 535 of file _multiband.py.

◆ __iter__()

def lsst.afw.multiband.MultibandBase.__iter__ (   self)
inherited

Definition at line 172 of file multiband.py.

◆ __ixor__()

def lsst.afw.image.image._multiband.MultibandMask.__ixor__ (   self,
  others 
)

Definition at line 547 of file _multiband.py.

◆ __len__()

def lsst.afw.multiband.MultibandBase.__len__ (   self)
inherited

Definition at line 144 of file multiband.py.

◆ __next__()

def lsst.afw.multiband.MultibandBase.__next__ (   self)
inherited

Definition at line 176 of file multiband.py.

◆ __repr__()

def lsst.afw.multiband.MultibandBase.__repr__ (   self)
inherited

Definition at line 310 of file multiband.py.

◆ __setitem__()

def lsst.afw.image.image._multiband.MultibandImageBase.__setitem__ (   self,
  args,
  value 
)
inherited
Set a subset of the MultibandImage

Definition at line 249 of file _multiband.py.

◆ __str__()

def lsst.afw.multiband.MultibandBase.__str__ (   self)
inherited

Definition at line 315 of file multiband.py.

◆ 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)
Clear all the pixels

Definition at line 513 of file _multiband.py.

◆ clearMaskPlaneDict()

def lsst.afw.image.image._multiband.MultibandMask.clearMaskPlaneDict ( )
static
Reset the mask plane dictionary

Definition at line 459 of file _multiband.py.

◆ clone()

def lsst.afw.image.image._multiband.MultibandImageBase.clone (   self,
  deep = True 
)
inherited
Copy the current object

Parameters
----------
deep : `bool`
   Whether or not to make a deep copy

Reimplemented from lsst.afw.multiband.MultibandBase.

Definition at line 190 of file _multiband.py.

◆ filters()

def lsst.afw.multiband.MultibandBase.filters (   self)
inherited
List of filter names for the single band objects

Definition at line 86 of file multiband.py.

◆ 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.

◆ getBBox() [1/2]

def lsst.afw.multiband.MultibandBase.getBBox (   self)
inherited
Bounding box

Definition at line 97 of file multiband.py.

◆ getBBox() [2/2]

def lsst.afw.image.image._multiband.MultibandImageBase.getBBox (   self,
  origin = PARENT 
)
inherited
Bounding box

Definition at line 269 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.

◆ getXY0()

def lsst.afw.multiband.MultibandBase.getXY0 (   self)
inherited
Minimum coordinate in the bounding box

Definition at line 102 of file multiband.py.

◆ height()

def lsst.afw.multiband.MultibandBase.height (   self)
inherited
Height of the images

Definition at line 139 of file multiband.py.

◆ origin()

def lsst.afw.multiband.MultibandBase.origin (   self)
inherited
Minimum (y,x) position

This is the position of `self.getBBox().getMin()`,
but available as a tuple for numpy array indexing.

Definition at line 124 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.

◆ setXY0()

def lsst.afw.multiband.MultibandBase.setXY0 (   self,
  xy0 
)
inherited
Shift the bounding box but keep the same Extent

Parameters
----------
xy0: `Point2I`
    New minimum bounds of the bounding box

Reimplemented in lsst.afw.image.image._multiband.MultibandTripleBase.

Definition at line 228 of file multiband.py.

◆ shiftedBy()

def lsst.afw.multiband.MultibandBase.shiftedBy (   self,
  offset 
)
inherited
Shift a bounding box by an offset, but keep the same Extent

This method is broken until DM-10781 is completed.

Parameters
----------
offset: `Extent2I`
    Amount to shift the bounding box in x and y.

Returns
-------
result: `MultibandBase`
    A copy of the object, shifted by `offset`

Definition at line 262 of file multiband.py.

◆ shiftedTo()

def lsst.afw.multiband.MultibandBase.shiftedTo (   self,
  xy0 
)
inherited
Shift the bounding box but keep the same Extent

This method is broken until DM-10781 is completed.

Parameters
----------
xy0: `Point2I`
    New minimum bounds of the bounding box

Returns
-------
result: `MultibandBase`
    A copy of the object, shifted to `xy0`.

Reimplemented in lsst.afw.image.image._multiband.MultibandTripleBase.

Definition at line 240 of file multiband.py.

◆ singles()

def lsst.afw.multiband.MultibandBase.singles (   self)
inherited
List of single band objects

Definition at line 92 of file multiband.py.

◆ width()

def lsst.afw.multiband.MultibandBase.width (   self)
inherited
Width of the images

Definition at line 133 of file multiband.py.

◆ x0()

def lsst.afw.multiband.MultibandBase.x0 (   self)
inherited
X0

X component of XY0 `Point2I.getX()`

Definition at line 108 of file multiband.py.

◆ y0()

def lsst.afw.multiband.MultibandBase.y0 (   self)
inherited
Y0

Y component of XY0 `Point2I.getY()`

Definition at line 116 of file multiband.py.

Property Documentation

◆ array

lsst.afw.image.image._multiband.MultibandImageBase.array = property(_getArray, _setArray)
staticinherited

Definition at line 188 of file _multiband.py.


The documentation for this class was generated from the following file: