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

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

Public Member Functions
	__init__ (self, filters, array, singleType, bbox=None)
	clone (self, deep=True)
	__setitem__ (self, args, value)
	getBBox (self, origin=PARENT)

Public Attributes
	singles

Protected Member Functions
	_getArray (self)
	_setArray (self, value)
	_slice (self, filters, filterIndex, indices)

Protected Attributes
	_array
	_filters
	_bbox
	_singles

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

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

Reimplemented from lsst.afw.multiband.MultibandBase.

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

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

__setitem__()

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
 

_getArray()

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

protected

Data cube array in multiple bands

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

Definition at line 174 of file _multiband.py.

    def _getArray(self):
        """Data cube array in multiple bands
 
        Returns
        -------
        self._array : array
           The resulting 3D data cube with shape (filters, y, x).
        """
        return self._array
 

_setArray()

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

protected

Set the values of the array

Definition at line 184 of file _multiband.py.

    def _setArray(self, value):
        """Set the values of the array"""
        self.array[:] = value
 

_slice()

lsst.afw.image._image._multiband.MultibandImageBase._slice ( self, filters, filterIndex, indices )

protected

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.

    def _slice(self, filters, filterIndex, indices):
        """Slice the current object and return the result
 
        See `MultibandBase._slice` for a list of the parameters.
        """
        if len(indices) > 0:
            if len(indices) == 1:
                indices = indices[0]
            allSlices = [filterIndex, slice(None), slice(None)]
            sy, sx, bbox = imageIndicesToNumpy(indices, self.getBBox)
            if sy is not None:
                allSlices[-2] = sy
            if sx is not None:
                allSlices[-1] = sx
            array = self._array[tuple(allSlices)]
 
            # Return a scalar or MultibandPixel
            # if the image indices are integers
            if bbox is None:
                if not isinstance(filterIndex, slice) and len(filterIndex) == 1:
                    return array[0]
                result = MultibandPixel(
                    singles=array,
                    filters=filters,
                    position=Point2I(sx + self.x0, sy + self.y0)
                )
                return result
        else:
            array = self._array[filterIndex]
            bbox = self.getBBox()
        result = type(self)(filters, array, bbox)
 
        # Check that the image and array shapes agree
        imageShape = (
            len(result.filters),
            result.getBBox().getHeight(),
            result.getBBox().getWidth()
        )
        assert result.array.shape == imageShape
 
        return result
 

clone()

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
 

getBBox()

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

Bounding box

Reimplemented from lsst.afw.multiband.MultibandBase.

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

Member Data Documentation

_array

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

protected

Definition at line 160 of file _multiband.py.

_bbox

lsst.afw.image._image._multiband.MultibandImageBase._bbox

protected

Definition at line 164 of file _multiband.py.

_filters

lsst.afw.image._image._multiband.MultibandImageBase._filters

protected

Definition at line 161 of file _multiband.py.

_singles

lsst.afw.image._image._multiband.MultibandImageBase._singles

protected

Definition at line 168 of file _multiband.py.

singles

lsst.afw.image._image._multiband.MultibandImageBase.singles

Definition at line 172 of file _multiband.py.

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-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/python/lsst/afw/image/_image/_multiband.py