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

__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
 

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

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

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
 

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.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/0.4.2/Linux64/afw/21.0.0-21-g5d80ea29e+5e3c9a3766/python/lsst/afw/image/image/multiband.py