lsst.afw.image.image.multiband.MultibandMask Class Reference

Inheritance diagram for lsst.afw.image.image.multiband.MultibandMask:

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.

    def __init__(self, filters, array, bbox=None):
        super().__init__(filters, array, Mask, bbox)
        # Set Mask specific properties
        self._refMask = self._singles[0]
        refMask = self._refMask
        assert np.all([refMask.getMaskPlaneDict() == m.getMaskPlaneDict() for m in self.singles])
        assert np.all([refMask.getNumPlanesMax() == m.getNumPlanesMax() for m in self.singles])
        assert np.all([refMask.getNumPlanesUsed() == m.getNumPlanesUsed() for m in self.singles])
 

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.

    def __getitem__(self, args):
        """Get a slice of the underlying array
 
        If only a single filter is specified,
        return the single band object sliced
        appropriately.
        """
        if not isinstance(args, tuple):
            indices = (args,)
        else:
            indices = args
 
        # Return the single band object if the first
        # index is not a list or slice.
        filters, filterIndex = self._filterNamesToIndex(indices[0])
        if not isinstance(filterIndex, slice) and len(filterIndex) == 1:
            if len(indices) > 2:
                return self.singles[filterIndex[0]][indices[1:]]
            elif len(indices) == 2:
                return self.singles[filterIndex[0]][indices[1]]
            else:
                return self.singles[filterIndex[0]]
 
        return self._slice(filters=filters, filterIndex=filterIndex, indices=indices[1:])
 

__iand__()

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

Definition at line 541 of file multiband.py.

    def __iand__(self, others):
        _others = self._getOtherMasks(others)
        for s, o in zip(self.singles, _others):
            s &= o
        return self
 

__ior__()

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

Definition at line 535 of file multiband.py.

    def __ior__(self, others):
        _others = self._getOtherMasks(others)
        for s, o in zip(self.singles, _others):
            s |= o
        return self
 

__iter__()

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

inherited

Definition at line 172 of file multiband.py.

    def __iter__(self):
        self._filterIndex = 0
        return self
 

__ixor__()

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

Definition at line 547 of file multiband.py.

    def __ixor__(self, others):
        _others = self._getOtherMasks(others)
        for s, o in zip(self.singles, _others):
            s ^= o
        return self
 
 

__len__()

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

inherited

Definition at line 144 of file multiband.py.

    def __len__(self):
        return len(self.filters)
 

__next__()

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

inherited

Definition at line 176 of file multiband.py.

    def __next__(self):
        if self._filterIndex < len(self.filters):
            result = self.singles[self._filterIndex]
            self._filterIndex += 1
        else:
            raise StopIteration
        return result
 

__repr__()

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

inherited

Definition at line 310 of file multiband.py.

    def __repr__(self):
        result = "<{0}, filters={1}, bbox={2}>".format(
            self.__class__.__name__, self.filters, self.getBBox().__repr__())
        return result
 

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

    def __setitem__(self, args, value):
        """Set a subset of the MultibandImage
        """
        if not isinstance(args, tuple):
            indices = (args,)
        else:
            indices = args
 
        # Return the single band object if the first
        # index is not a list or slice.
        filters, filterIndex = self._filterNamesToIndex(indices[0])
        if len(indices) > 1:
            sy, sx, bbox = imageIndicesToNumpy(indices[1:], self.getBBox)
        else:
            sy = sx = slice(None)
        if hasattr(value, "array"):
            self._array[filterIndex, sy, sx] = value.array
        else:
            self._array[filterIndex, sy, sx] = value
 

__str__()

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

inherited

Definition at line 315 of file multiband.py.

    def __str__(self):
        if hasattr(self, "array"):
            return str(self.array)
        return self.__repr__()

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.

    def addMaskPlane(name):
        """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.
        """
        idx = Mask[MaskPixel].addMaskPlane(name)
        return idx
 

clearAllMaskPlanes()

def lsst.afw.image.image.multiband.MultibandMask.clearAllMaskPlanes

(

self

)

Clear all the pixels

Definition at line 513 of file multiband.py.

    def clearAllMaskPlanes(self):
        """Clear all the pixels
        """
        self._refMask.clearAllMaskPlanes()
 

clearMaskPlaneDict()

def lsst.afw.image.image.multiband.MultibandMask.clearMaskPlaneDict ( )

static

Reset the mask plane dictionary

Definition at line 459 of file multiband.py.

    def clearMaskPlaneDict():
        """Reset the mask plane dictionary
        """
        Mask[MaskPixel].clearMaskPlaneDict()
 

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.

    def clone(self, deep=True):
        """Copy the current object
 
        Parameters
        ----------
        deep : `bool`
           Whether or not to make a deep copy
        """
        if deep:
            array = np.copy(self.array)
            bbox = Box2I(self.getBBox())
        else:
            array = self.array
            bbox = self.getBBox()
        result = type(self)(self.filters, array, bbox)
        return result
 

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.

    def filters(self):
        """List of filter names for the single band objects
        """
        return self._filters
 

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.

    def fromKwargs(filters, filterKwargs, singleType=ImageF, **kwargs):
        """Build a MultibandImage from a set of keyword arguments
 
        see `makeImageFromKwargs` for a description of parameters
        """
        return makeImageFromKwargs(MultibandMask, filters, filterKwargs, singleType, **kwargs)
 

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.

    def fromMasks(filters, singles):
        """Construct a MultibandImage from a collection of single band images
 
        see `fromSingles` for a description of parameters
        """
        return makeImageFromSingles(MultibandMask, filters, singles)
 

getBBox() [1/2]

def lsst.afw.multiband.MultibandBase.getBBox (   self )

inherited

Bounding box

Definition at line 97 of file multiband.py.

    def getBBox(self):
        """Bounding box
        """
        return self._bbox
 

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.

    def getBBox(self, origin=PARENT):
        """Bounding box
        """
        if origin == PARENT:
            return self._bbox
        elif origin == LOCAL:
            return Box2I(Point2I(0, 0), self._bbox.getDimensions())
        raise ValueError("Unrecognized origin, expected either PARENT or LOCAL")
 
 

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.

    def 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`
        """
        return self._refMask.getMaskPlaneDict()[key]
 

getMaskPlaneDict()

def lsst.afw.image.image.multiband.MultibandMask.getMaskPlaneDict

(

self

)

Dictionary of Mask Plane bit values

Definition at line 453 of file multiband.py.

    def getMaskPlaneDict(self):
        """Dictionary of Mask Plane bit values
        """
        return self._refMask.getMaskPlaneDict()
 

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.

    def getNumPlanesMax(self):
        """Maximum number of mask planes available
 
        This is required to be the same for all of the single
        band `Mask` objects.
        """
        return self._refMask.getNumPlanesMax()
 

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.

    def getNumPlanesUsed(self):
        """Number of mask planes used
 
        This is required to be the same for all of the single
        band `Mask` objects.
        """
        return self._refMask.getNumPlanesUsed()
 

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.

    def 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`.
        """
        return self._refMask.getPlaneBitMask(names)
 

getXY0()

def lsst.afw.multiband.MultibandBase.getXY0 (   self )

inherited

Minimum coordinate in the bounding box

Definition at line 102 of file multiband.py.

    def getXY0(self):
        """Minimum coordinate in the bounding box
        """
        return self.getBBox().getMin()
 

height()

def lsst.afw.multiband.MultibandBase.height (   self )

inherited

Height of the images

Definition at line 139 of file multiband.py.

    def height(self):
        """Height of the images
        """
        return self.getBBox().getHeight()
 

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.

    def origin(self):
        """Minimum (y,x) position
 
        This is the position of `self.getBBox().getMin()`,
        but available as a tuple for numpy array indexing.
        """
        return (self.y0, self.x0)
 

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.

    def 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`.
        """
        # Clear all masks in MultibandMask but leave in default dict for now
        for single in self.singles:
            single.removeAndClearMaskPlane(name, removeFromDefault=False)
        # Now remove from default dict according to removeFromDefault
        self._refMask.removeAndClearMaskPlane(name, removeFromDefault)
 

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.

    def removeMaskPlane(name):
        """Remove a mask from the mask plane
 
        Parameters
        ----------
        name : `str`
           Name of the mask plane to remove
        """
        Mask[MaskPixel].removeMaskPlane(name)
 

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.

    def setXY0(self, xy0):
        """Shift the bounding box but keep the same Extent
 
        Parameters
        ----------
        xy0: `Point2I`
            New minimum bounds of the bounding box
        """
        self._bbox = Box2I(xy0, self._bbox.getDimensions())
        for singleObj in self.singles:
            singleObj.setXY0(xy0)
 

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.

    def shiftedBy(self, offset):
        """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`
        """
        raise NotImplementedError("shiftedBy not implemented until DM-10781")
        xy0 = self._bbox.getMin() + offset
        return self.shiftedTo(xy0)
 

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.

    def shiftedTo(self, xy0):
        """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`.
        """
        raise NotImplementedError("shiftedBy not implemented until DM-10781")
        result = self.clone(False)
        result._bbox = Box2I(xy0, result._bbox.getDimensions())
        for singleObj in result.singles:
            singleObj.setXY0(xy0)
        return result
 

singles()

def lsst.afw.multiband.MultibandBase.singles (   self )

inherited

List of single band objects

Definition at line 92 of file multiband.py.

    def singles(self):
        """List of single band objects
        """
        return self._singles
 

width()

def lsst.afw.multiband.MultibandBase.width (   self )

inherited

Width of the images

Definition at line 133 of file multiband.py.

    def width(self):
        """Width of the images
        """
        return self.getBBox().getWidth()
 

x0()

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

inherited

X0

X component of XY0 `Point2I.getX()`

Definition at line 108 of file multiband.py.

    def x0(self):
        """X0
 
        X component of XY0 `Point2I.getX()`
        """
        return self.getBBox().getMinX()
 

y0()

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

inherited

Y0

Y component of XY0 `Point2I.getY()`

Definition at line 116 of file multiband.py.

    def y0(self):
        """Y0
 
        Y component of XY0 `Point2I.getY()`
        """
        return self.getBBox().getMinY()
 

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:

• /j/snowflake/release/lsstsw/stack/0.4.2/Linux64/afw/21.0.0-21-g5d80ea29e+5e3c9a3766/python/lsst/afw/image/image/multiband.py