Inheritance diagram for lsst.afw.image._image._multiband.MultibandMask:

Public Member Functions
	__init__ (self, bands, 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)

	clone (self, deep=True)

	__setitem__ (self, args, value)

	getBBox (self, origin=PARENT)

	y0 (self)

	x0 (self)

	bands (self)

	singles (self)

	getXY0 (self)

	origin (self)

	width (self)

	height (self)

	__len__ (self)

	__getitem__ (self, args)

	__iter__ (self)

	__next__ (self)

	setXY0 (self, xy0)

	shiftedTo (self, xy0)

	shiftedBy (self, offset)

	__repr__ (self)

	__str__ (self)

Static Public Member Functions
	fromMasks (bands, singles)

	fromKwargs (bands, bandKwargs, singleType=ImageF, **kwargs)

	clearMaskPlaneDict ()

	addMaskPlane (name)

	removeMaskPlane (name)

Public Attributes
	y0

	x0

	bands

	singles = Box2I(xy0, self._bbox.getDimensions())

Protected Member Functions
	_getOtherMasks (self, others)

	_getArray (self)

	_setArray (self, value)

	_slice (self, bands, bandIndex, indices)

	_bandNamesToIndex (self, bandIndex)

Protected Attributes
	_refMask = self._singles[0]

	_array = array

	_bands = tuple([f for f in bands])

	_singles = tuple(singles)

	_bbox = self._singles[0].getBBox()

int	_bandIndex = 0

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()

lsst.afw.image._image._multiband.MultibandMask.__init__	(	self,
		bands,
		array,
		bbox = None )

Definition at line 358 of file _multiband.py.

Member Function Documentation

◆ getitem()

lsst.afw.multiband.MultibandBase.__getitem__	(		self,
			args )

inherited

Get a slice of the underlying array

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

Definition at line 147 of file multiband.py.

◆ iand()

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

Definition at line 541 of file _multiband.py.

◆ ior()

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

Definition at line 535 of file _multiband.py.

◆ iter()

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

inherited

Definition at line 172 of file multiband.py.

◆ ixor()

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

Definition at line 547 of file _multiband.py.

◆ len()

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

inherited

Definition at line 144 of file multiband.py.

◆ next()

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

inherited

Definition at line 176 of file multiband.py.

◆ repr()

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

inherited

Definition at line 310 of file multiband.py.

◆ setitem()

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()

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

inherited

Definition at line 315 of file multiband.py.

◆ _bandNamesToIndex()

lsst.afw.multiband.MultibandBase._bandNamesToIndex	(		self,
			bandIndex )

protectedinherited

Convert a list of band names to an index or a slice

Parameters
----------
bandIndex: iterable or `object`
    Index to specify a band or list of bands,
    usually a string or enum.
    For example `bandIndex` can be
    `"R"` or `["R", "G", "B"]` or `[Band.R, Band.G, Band.B]`,
    if `Band` is an enum.

Returns
-------
bandNames: `list`
    Names of the bands in the slice
bandIndex: `slice` or `list` of `int`
    Index of each band in `bandNames` in
    `self.bands`.

Definition at line 184 of file multiband.py.

◆ _getArray()

lsst.afw.image._image._multiband.MultibandImageBase._getArray ( self )

protectedinherited

Data cube array in multiple bands

Returns
-------
self._array : array
   The resulting 3D data cube with shape (bands, y, x).

Definition at line 174 of file _multiband.py.

◆ _getOtherMasks()

lsst.afw.image._image._multiband.MultibandMask._getOtherMasks	(		self,
			others )

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.

◆ _setArray()

lsst.afw.image._image._multiband.MultibandImageBase._setArray	(		self,
			value )

protectedinherited

Set the values of the array

Definition at line 184 of file _multiband.py.

◆ _slice()

lsst.afw.image._image._multiband.MultibandImageBase._slice	(	self,
		bands,
		bandIndex,
		indices )

protectedinherited

Slice the current object and return the result

See `MultibandBase._slice` for a list of the parameters.

Reimplemented from lsst.afw.multiband.MultibandBase.

Definition at line 207 of file _multiband.py.

◆ addMaskPlane()

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.

◆ bands()

lsst.afw.multiband.MultibandBase.bands ( self )

inherited

List of band names for the single band objects

Definition at line 86 of file multiband.py.

◆ clearAllMaskPlanes()

lsst.afw.image._image._multiband.MultibandMask.clearAllMaskPlanes ( self )

Clear all the pixels

Definition at line 513 of file _multiband.py.

◆ clearMaskPlaneDict()

lsst.afw.image._image._multiband.MultibandMask.clearMaskPlaneDict ( )

static

Reset the mask plane dictionary

Definition at line 459 of file _multiband.py.

◆ clone()

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.

◆ fromKwargs()

lsst.afw.image._image._multiband.MultibandMask.fromKwargs	(		bands,
			bandKwargs,
			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()

lsst.afw.image._image._multiband.MultibandMask.fromMasks	(		bands,
			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()

lsst.afw.image._image._multiband.MultibandImageBase.getBBox	(		self,
			origin = PARENT )

inherited

Bounding box

Reimplemented from lsst.afw.multiband.MultibandBase.

Definition at line 269 of file _multiband.py.

◆ getMaskPlane()

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()

lsst.afw.image._image._multiband.MultibandMask.getMaskPlaneDict ( self )

Dictionary of Mask Plane bit values

Definition at line 453 of file _multiband.py.

◆ getNumPlanesMax()

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()

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()

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()

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

inherited

Minimum coordinate in the bounding box

Definition at line 102 of file multiband.py.

◆ height()

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

inherited

Height of the images

Definition at line 139 of file multiband.py.

◆ origin()

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()

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()

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()

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()

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()

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()

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

inherited

List of single band objects

Definition at line 92 of file multiband.py.

◆ width()

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

inherited

Width of the images

Definition at line 133 of file multiband.py.

◆ x0()

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

inherited

X0

X component of XY0 `Point2I.getX()`

Definition at line 108 of file multiband.py.

◆ y0()

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

inherited

Y0

Y component of XY0 `Point2I.getY()`

Definition at line 116 of file multiband.py.

Member Data Documentation

◆ _array

lsst.afw.image._image._multiband.MultibandImageBase._array = array

protectedinherited

Definition at line 160 of file _multiband.py.

◆ _bandIndex

int lsst.afw.multiband.MultibandBase._bandIndex = 0

protectedinherited

Definition at line 173 of file multiband.py.

◆ _bands

lsst.afw.multiband.MultibandBase._bands = tuple([f for f in bands])

protectedinherited

Definition at line 55 of file multiband.py.

◆ _bbox

lsst.afw.multiband.MultibandBase._bbox = self._singles[0].getBBox()

protectedinherited

Definition at line 59 of file multiband.py.

◆ _refMask

lsst.afw.image._image._multiband.MultibandMask._refMask = self._singles[0]

protected

Definition at line 361 of file _multiband.py.

◆ _singles

lsst.afw.multiband.MultibandBase._singles = tuple(singles)

protectedinherited

Definition at line 56 of file multiband.py.

◆ bands

lsst.afw.multiband.MultibandBase.bands

inherited

Definition at line 145 of file multiband.py.

◆ singles

lsst.afw.multiband.MultibandBase.singles = Box2I(xy0, self._bbox.getDimensions())

inherited

Definition at line 237 of file multiband.py.

◆ x0

lsst.afw.multiband.MultibandBase.x0

inherited

Definition at line 130 of file multiband.py.

◆ y0

lsst.afw.multiband.MultibandBase.y0

inherited

Definition at line 130 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:

python/lsst/afw/image/_image/_multiband.py

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __getitem__()

◆ __iand__()

◆ __ior__()

◆ __iter__()

◆ __ixor__()

◆ __len__()

◆ __next__()

◆ __repr__()

◆ __setitem__()

◆ __str__()

◆ _bandNamesToIndex()

◆ _getArray()

◆ _getOtherMasks()

◆ _setArray()

◆ _slice()

◆ addMaskPlane()

◆ bands()

◆ clearAllMaskPlanes()

◆ clearMaskPlaneDict()

◆ clone()

◆ fromKwargs()

◆ fromMasks()

◆ getBBox()

◆ getMaskPlane()

◆ getMaskPlaneDict()

◆ getNumPlanesMax()

◆ getNumPlanesUsed()

◆ getPlaneBitMask()

◆ getXY0()

◆ height()

◆ origin()

◆ removeAndClearMaskPlane()

◆ removeMaskPlane()

◆ setXY0()

◆ shiftedBy()

◆ shiftedTo()

◆ singles()

◆ width()

◆ x0()

◆ y0()

Member Data Documentation

◆ _array

◆ _bandIndex

◆ _bands

◆ _bbox

◆ _refMask

◆ _singles

◆ bands

◆ singles

◆ x0

◆ y0

Property Documentation

◆ array

◆ init()

◆ getitem()

◆ iand()

◆ ior()

◆ iter()

◆ ixor()

◆ len()

◆ next()

◆ repr()

◆ setitem()

◆ str()