Inheritance diagram for lsst.afw.multiband.MultibandBase:

Public Member Functions
def	__init__ (self, filters, singles, bbox=None)

def	clone (self, deep=True)

def	filters (self)

def	singles (self)

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

Detailed Description

Base class for multiband objects

The LSST stack has a number of image-like classes that have
data in multiple bands that are stored as separate objects.
Analyzing the data can be easier using a Multiband object that
wraps the underlying data as a single data cube that can be sliced and
updated as a single object.

`MultibandBase` is designed to contain the most important universal
methods for initializing, slicing, and extracting common parameters
(such as the bounding box or XY0 position) to all of the single band classes,
as long as derived classes either call the base class `__init__`
or set the `_filters`, `_singles`, and `_bbox`.

Parameters
----------
filters: `list`
    List of filter names.
singles: `list`
    List of single band objects
bbox: `Box2I`
    By default `MultibandBase` uses `singles[0].getBBox()` to set
    the bounding box of the multiband

Definition at line 29 of file multiband.py.

Constructor & Destructor Documentation

◆ init()

def lsst.afw.multiband.MultibandBase.__init__	(	self,
		filters,
		singles,
		bbox = `None`
	)

Reimplemented in lsst.afw.image.image._multiband.MultibandPixel, lsst.afw.image.image._multiband.MultibandMask, and lsst.afw.image.image._multiband.MultibandImage.

Definition at line 54 of file multiband.py.

     def __init__(self, filters, singles, bbox=None):
         self._filters = tuple([f for f in filters])
         self._singles = tuple(singles)
  
         if bbox is None:
             self._bbox = self._singles[0].getBBox()
             if not all([s.getBBox() == self.getBBox() for s in self.singles]):
                 bboxes = [s.getBBox() == self.getBBox() for s in self.singles]
                 err = "`singles` are required to have the same bounding box, received {0}"
                 raise ValueError(err.format(bboxes))
         else:
             self._bbox = bbox
  

Member Function Documentation

◆ getitem()

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

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:])
  

◆ iter()

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

Definition at line 172 of file multiband.py.

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

◆ len()

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

Definition at line 144 of file multiband.py.

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

◆ next()

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

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 )

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
  

◆ str()

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

Definition at line 315 of file multiband.py.

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

◆ clone()

def lsst.afw.multiband.MultibandBase.clone	(	self,
		deep = `True`
	)

Copy the current object

This must be overloaded in a subclass of `MultibandBase`

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

Returns
-------
result: `MultibandBase`
    copy of the instance that inherits from `MultibandBase`

Reimplemented in lsst.afw.image.image._multiband.MultibandTripleBase, lsst.afw.image.image._multiband.MultibandImageBase, lsst.afw.image.image._multiband.MultibandPixel, and lsst.afw.detection.multiband.MultibandFootprint.

Definition at line 68 of file multiband.py.

     def clone(self, deep=True):
         """Copy the current object
  
         This must be overloaded in a subclass of `MultibandBase`
  
         Parameters
         ----------
         deep: `bool`
             Whether or not to make a deep copy
  
         Returns
         -------
         result: `MultibandBase`
             copy of the instance that inherits from `MultibandBase`
         """
         pass
  

◆ filters()

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

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
  

◆ getBBox()

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

Bounding box

Definition at line 97 of file multiband.py.

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

◆ getXY0()

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

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 )

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 )

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)
  

◆ setXY0()

def lsst.afw.multiband.MultibandBase.setXY0	(	self,
		xy0
	)

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
	)

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
	)

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 )

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 )

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 )

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 )

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

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/python/lsst/afw/multiband.py

Public Member Functions