lsst.afw.image.image._multiband.MultibandImageBase Class Reference

Inheritance diagram for lsst.afw.image.image._multiband.MultibandImageBase:

Public Member Functions
def	__init__ (self, filters, array, singleType, bbox=None)
def	clone (self, deep=True)
def	__setitem__ (self, args, value)
def	getBBox (self, origin=PARENT)
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)

Properties
	array = property(_getArray, _setArray)

Detailed Description

Multiband Image class

This class acts as a container for multiple `afw.Image` objects.
All images must be contained in the same bounding box,
and have the same data type.
The data is stored in a 3D array (filters, y, x), and the single
band `Image` instances have an internal array that points to the
3D multiband array, so that the single band objects and multiband
array are always in agreement.

Parameters
----------
filters : `list`
   List of filter names.
array : 3D numpy array
   Array (filters, y, x) of multiband data.
   If this is used to initialize a `MultibandImage`,
   either `bbox` or `singles` is also required.
singleType : `type`
   Type of the single band object (eg. `Image`, `Mask`) to
   convert the array into a tuple of single band objects
   that point to the image array.
bbox : `Box2I`
   Location of the array in a larger single band image.
   If `bbox` is `None` then the bounding box is initialized
   at the origin.

Definition at line 128 of file _multiband.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 156 of file _multiband.py.

    def __init__(self, filters, array, singleType, bbox=None):
        # Create the single band objects from the array
        if len(array) != len(filters):
            raise ValueError("`array` and `filters` must have the same length")
        self._array = array
        self._filters = tuple(filters)
        if bbox is None:
            bbox = Box2I(Point2I(0, 0), Extent2I(array.shape[2], array.shape[1]))
        self._bbox = bbox
 
        xy0 = self.getXY0()
        dtype = array.dtype
        self._singles = tuple([singleType(array=array[n], xy0=xy0, dtype=dtype) for n in range(len(array))])
 
        # Make sure that all of the parameters have been setup appropriately
        assert isinstance(self._bbox, Box2I)
        assert len(self.singles) == len(self.filters)
 

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

__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
 

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

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

clone()

def lsst.afw.image.image._multiband.MultibandImageBase.clone	(		self,
			deep = True
	)

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
 

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
	)

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

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)
 

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)

static

Definition at line 188 of file _multiband.py.

---

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/image/image/_multiband.py