lsst.afw.image.image._multiband.MultibandPixel Class Reference

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

Public Member Functions
def	__init__ (self, filters, singles, position)
def	clone (self, deep=True)
def	__getitem__ (self, indices)

Properties
	array = property(_getArray, _setArray)

Detailed Description

Multiband Pixel class

This represent acts as a container for a single pixel
(scalar) in multiple bands.

Parameters
----------
singles : `sequence`
   Either a list of single band objects or an array of values.
filters : `list`
   List of filter names. If `singles` is an `OrderedDict` or
   a `MultibandPixel` then this argument is ignored,
   otherwise it is required.
position : `Point2I`
   Location of the pixel in the parent image.
   Unlike other objects that inherit from `MultibandBase`,
   `MultibandPixel` objects don't have a full `Box2I`
   bounding box, since they only contain a single pixel,
   so the bounding box cannot be inherited from the
   list of `singles`.

Definition at line 33 of file _multiband.py.

Constructor & Destructor Documentation

__init__()

def lsst.afw.image.image._multiband.MultibandPixel.__init__	(		self,
			filters,
			singles,
			position
	)

Reimplemented from lsst.afw.multiband.MultibandBase.

Definition at line 55 of file _multiband.py.

    def __init__(self, filters, singles, position):
        if any([arg is None for arg in [singles, filters, position]]):
            err = "Expected an array of `singles`, a list of `filters, and a `bbox`"
            raise NotImplementedError(err)
 
        # Make sure that singles is an array
        singles = np.array(singles, copy=False)
 
        super().__init__(filters, singles, bbox=Box2I(position, Extent2I(1, 1)))
        # In this case we want self.singles to be an array
        self._singles = singles
 
        # Make sure that the bounding box has been setup properly
        assert self.getBBox().getDimensions() == Extent2I(1, 1)
 

Member Function Documentation

__getitem__()

def lsst.afw.image.image._multiband.MultibandPixel.__getitem__	(		self,
			indices
	)

Get a slice of the underlying array

Since a `MultibandPixel` is a scalar in the
spatial dimensions, it can only be indexed with
a filter name, number, or slice.

Reimplemented from lsst.afw.multiband.MultibandBase.

Definition at line 100 of file _multiband.py.

    def __getitem__(self, indices):
        """Get a slice of the underlying array
 
        Since a `MultibandPixel` is a scalar in the
        spatial dimensions, it can only be indexed with
        a filter name, number, or slice.
        """
        if isinstance(indices, tuple):
            err = ("Too many indices: "
                   "`MultibandPixel has no spatial dimensions and "
                   "only accepts a filterIndex")
            raise IndexError(err)
        # Make the index into a valid numpy index or slice
        filters, filterIndex = self._filterNamesToIndex(indices)
        if len(filters) == 1 and not isinstance(filterIndex, slice):
            # The user only requested a pixel in a single band, so return it
            return self.array[filterIndex[0]]
 
        result = self.clone(False)
        result._filters = filters
        result._singles = self._singles[filterIndex]
        # No need to update the bounding box, since pixels can only be sliced in the filter dimension
        return result
 

clone()

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

Make a copy of the current instance

`MultibandPixel.singles` is an array,
so this just makes a copy of the array
(as opposed to a view of the parent array).

Reimplemented from lsst.afw.multiband.MultibandBase.

Definition at line 84 of file _multiband.py.

    def clone(self, deep=True):
        """Make a copy of the current instance
 
        `MultibandPixel.singles` is an array,
        so this just makes a copy of the array
        (as opposed to a view of the parent array).
        """
        if deep:
            singles = np.copy(self.singles)
            position = self.getBBox().getMin()
            return MultibandPixel(filters=self.filters, singles=singles, position=position)
 
        result = MultibandPixel(filters=self.filters, singles=self.singles, position=self.getBBox().getMin())
        result._bbox = self.getBBox()
        return result
 

Property Documentation

array

lsst.afw.image.image._multiband.MultibandPixel.array = property(_getArray, _setArray)

static

Definition at line 82 of file _multiband.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-5.0.1/Linux64/afw/gf46e8334de+81c9a61069/python/lsst/afw/image/image/_multiband.py