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

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

Public Member Functions
	__init__ (self, filters, image, mask, variance)
	setXY0 (self, xy0)
	shiftedTo (self, xy0)
	clone (self, deep=True)
	image (self)
	mask (self)
	variance (self)
	getBBox (self, origin=PARENT)

Public Attributes
	filters

Protected Member Functions
	_slice (self, filters, filterIndex, indices)
	_verifyUpdate (self, image=None, mask=None, variance=None)

Protected Attributes
	_filters
	_image
	_mask
	_variance
	_singles
	_bbox

Detailed Description

MultibandTripleBase class

This is a base class inherited by multiband classes
with `image`, `mask`, and `variance` objects,
such as `MultibandMaskedImage` and `MultibandExposure`.

Parameters
----------
filters : `list`
   List of filter names. If `singles` is an `OrderedDict`
   then this argument is ignored, otherwise it is required.
image : `list` or `MultibandImage`
   List of `Image` objects that represent the image in each band or
   a `MultibandImage`.
   Ignored if `singles` is not `None`.
mask : `list` or `MultibandMask`
   List of `Mask` objects that represent the mask in each bandor
   a `MultibandMask`.
   Ignored if `singles` is not `None`.
variance : `list` or `MultibandImage`
   List of `Image` objects that represent the variance in each bandor
   a `MultibandImage`.
   Ignored if `singles` is not `None`.

Definition at line 554 of file _multiband.py.

Constructor & Destructor Documentation

__init__()

lsst.afw.image._image._multiband.MultibandTripleBase.__init__	(		self,
			filters,
			image,
			mask,
			variance )

Reimplemented from lsst.afw.multiband.MultibandBase.

Reimplemented in lsst.afw.image._exposure._multiband.MultibandExposure, and lsst.afw.image._image._multiband.MultibandMaskedImage.

Definition at line 579 of file _multiband.py.

    def __init__(self, filters, image, mask, variance):
        self._filters = tuple(filters)
        # Convert single band images into multiband images
        if not isinstance(image, MultibandBase):
            image = MultibandImage.fromImages(filters, image)
            if mask is not None:
                mask = MultibandMask.fromMasks(filters, mask)
            if variance is not None:
                variance = MultibandImage.fromImages(filters, variance)
        self._image = image
        self._mask = mask
        self._variance = variance
 
        self._singles = self._buildSingles(self._image, self._mask, self._variance)
        self._bbox = self.singles[0].getBBox()
 

Member Function Documentation

_slice()

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

protected

Slice the current object and return the result

See `Multiband._slice` for a list of the parameters.

Reimplemented from lsst.afw.multiband.MultibandBase.

Reimplemented in lsst.afw.image._exposure._multiband.MultibandExposure.

Definition at line 653 of file _multiband.py.

    def _slice(self, filters, filterIndex, indices):
        """Slice the current object and return the result
 
        See `Multiband._slice` for a list of the parameters.
        """
        image = self.image._slice(filters, filterIndex, indices)
        if self.mask is not None:
            mask = self._mask._slice(filters, filterIndex, indices)
        else:
            mask = None
        if self.variance is not None:
            variance = self._variance._slice(filters, filterIndex, indices)
        else:
            variance = None
 
        # If only a single pixel is selected, return the tuple of MultibandPixels
        if isinstance(image, MultibandPixel):
            if mask is not None:
                assert isinstance(mask, MultibandPixel)
            if variance is not None:
                assert isinstance(variance, MultibandPixel)
            return (image, mask, variance)
 
        result = type(self)(filters=filters, image=image, mask=mask, variance=variance)
        assert all([r.getBBox() == result._bbox for r in [result._mask, result._variance]])
        return result
 

_verifyUpdate()

lsst.afw.image._image._multiband.MultibandTripleBase._verifyUpdate ( self, image = None, mask = None, variance = None )

protected

Check that the new image, mask, or variance is valid

This basically means checking that the update to the
property matches the current bounding box and inherits
from the `MultibandBase` class.

Definition at line 680 of file _multiband.py.

    def _verifyUpdate(self, image=None, mask=None, variance=None):
        """Check that the new image, mask, or variance is valid
 
        This basically means checking that the update to the
        property matches the current bounding box and inherits
        from the `MultibandBase` class.
        """
        for prop in [image, mask, variance]:
            if prop is not None:
                if prop.getBBox() != self.getBBox():
                    raise ValueError("Bounding box does not match the current class")
                if not isinstance(prop, MultibandBase):
                    err = "image, mask, and variance should all inherit from the MultibandBase class"
                    raise ValueError(err)
 

clone()

lsst.afw.image._image._multiband.MultibandTripleBase.clone	(		self,
			deep = True )

Make a copy of the current instance

Reimplemented from lsst.afw.multiband.MultibandBase.

Definition at line 639 of file _multiband.py.

    def clone(self, deep=True):
        """Make a copy of the current instance
        """
        image = self.image.clone(deep)
        if self.mask is not None:
            mask = self.mask.clone(deep)
        else:
            mask = None
        if self.variance is not None:
            variance = self.variance.clone(deep)
        else:
            variance = None
        return type(self)(self.filters, image, mask, variance)
 

getBBox()

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

Bounding box

Reimplemented from lsst.afw.multiband.MultibandBase.

Definition at line 710 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")
 
 

image()

lsst.afw.image._image._multiband.MultibandTripleBase.image

(

self

)

The image of the MultibandMaskedImage

Definition at line 696 of file _multiband.py.

    def image(self):
        """The image of the MultibandMaskedImage"""
        return self._image
 

mask()

lsst.afw.image._image._multiband.MultibandTripleBase.mask

(

self

)

The mask of the MultibandMaskedImage

Definition at line 701 of file _multiband.py.

    def mask(self):
        """The mask of the MultibandMaskedImage"""
        return self._mask
 

setXY0()

lsst.afw.image._image._multiband.MultibandTripleBase.setXY0	(		self,
			xy0 )

Shift the bounding box but keep the same Extent
This is different than `MultibandBase.setXY0`
because the multiband `image`, `mask`, and `variance` objects
must all have their bounding boxes updated.
Parameters
----------
xy0 : `Point2I`
   New minimum bounds of the bounding box

Reimplemented from lsst.afw.multiband.MultibandBase.

Definition at line 595 of file _multiband.py.

    def setXY0(self, xy0):
        """Shift the bounding box but keep the same Extent
        This is different than `MultibandBase.setXY0`
        because the multiband `image`, `mask`, and `variance` objects
        must all have their bounding boxes updated.
        Parameters
        ----------
        xy0 : `Point2I`
           New minimum bounds of the bounding box
        """
        super().setXY0(xy0)
        self.image.setXY0(xy0)
        if self.mask is not None:
            self.mask.setXY0(xy0)
        if self.variance is not None:
            self.variance.setXY0(xy0)
 

shiftedTo()

lsst.afw.image._image._multiband.MultibandTripleBase.shiftedTo	(		self,
			xy0 )

Shift the bounding box but keep the same Extent

This is different than `MultibandBase.shiftedTo`
because the multiband `image`, `mask`, and `variance` objects
must all have their bounding boxes updated.

Parameters
----------
xy0 : `Point2I`
   New minimum bounds of the bounding box

Returns
-------
result : `MultibandBase`
   A copy of the object, shifted to `xy0`.

Reimplemented from lsst.afw.multiband.MultibandBase.

Definition at line 612 of file _multiband.py.

    def shiftedTo(self, xy0):
        """Shift the bounding box but keep the same Extent
 
        This is different than `MultibandBase.shiftedTo`
        because the multiband `image`, `mask`, and `variance` objects
        must all have their bounding boxes updated.
 
        Parameters
        ----------
        xy0 : `Point2I`
           New minimum bounds of the bounding box
 
        Returns
        -------
        result : `MultibandBase`
           A copy of the object, shifted to `xy0`.
        """
        raise NotImplementedError("shiftedTo not implemented until DM-10781")
        result = self.clone(False)
        result._image = result.image.shiftedTo(xy0)
        if self.mask is not None:
            result._mask = result.mask.shiftedTo(xy0)
        if self.variance is not None:
            result._variance = result.variance.shiftedTo(xy0)
        result._bbox = result.image.getBBox()
        return result
 

variance()

lsst.afw.image._image._multiband.MultibandTripleBase.variance

(

self

)

The variance of the MultibandMaskedImage

Definition at line 706 of file _multiband.py.

    def variance(self):
        """The variance of the MultibandMaskedImage"""
        return self._variance
 

Member Data Documentation

_bbox

lsst.afw.image._image._multiband.MultibandTripleBase._bbox

protected

Definition at line 593 of file _multiband.py.

_filters

lsst.afw.image._image._multiband.MultibandTripleBase._filters

protected

Definition at line 580 of file _multiband.py.

_image

lsst.afw.image._image._multiband.MultibandTripleBase._image

protected

Definition at line 588 of file _multiband.py.

_mask

lsst.afw.image._image._multiband.MultibandTripleBase._mask

protected

Definition at line 589 of file _multiband.py.

_singles

lsst.afw.image._image._multiband.MultibandTripleBase._singles

protected

Definition at line 592 of file _multiband.py.

_variance

lsst.afw.image._image._multiband.MultibandTripleBase._variance

protected

Definition at line 590 of file _multiband.py.

filters

lsst.afw.image._image._multiband.MultibandTripleBase.filters

Definition at line 651 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