lsst.afw.image.exposure.multiband.MultibandExposure Class Reference

Inheritance diagram for lsst.afw.image.exposure.multiband.MultibandExposure:

Public Member Functions
def	__init__ (self, filters, image, mask, variance, psfs=None)
def	computePsfKernelImage (self, position=None)
def	computePsfImage (self, position=None)
def	setXY0 (self, xy0)
def	shiftedTo (self, xy0)
def	clone (self, deep=True)
def	image (self)
def	mask (self)
def	variance (self)
def	getBBox (self, origin=PARENT)
def	getBBox (self)
def	filters (self)
def	singles (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	shiftedBy (self, offset)
def	__repr__ (self)
def	__str__ (self)

Static Public Member Functions
def	fromExposures (filters, singles)
def	fromArrays (filters, image, mask, variance, bbox=None)
def	fromKwargs (filters, filterKwargs, singleType=ExposureF, **kwargs)
def	fromButler (butler, filters, filterKwargs, *args, **kwargs)

Detailed Description

MultibandExposure class

This class acts as a container for multiple `afw.Exposure` objects.
All exposures must have the same bounding box, and the associated
images must all have the same data type.

See `MultibandTripleBase` for parameter definitions.

Definition at line 33 of file multiband.py.

Constructor & Destructor Documentation

__init__()

def lsst.afw.image.exposure.multiband.MultibandExposure.__init__	(		self,
			filters,
			image,
			mask,
			variance,
			psfs = None
	)

Definition at line 42 of file multiband.py.

    def __init__(self, filters, image, mask, variance, psfs=None):
        super().__init__(filters, image, mask, variance)
        if psfs is not None:
            for psf, exposure in zip(psfs, self.singles):
                exposure.setPsf(psf)
 

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
 

__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.MultibandTripleBase.clone (   self,   deep = True  )

inherited

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)
 

computePsfImage()

def lsst.afw.image.exposure.multiband.MultibandExposure.computePsfImage	(		self,
			position = None
	)

Get a multiband PSF image

The PSF Kernel Image is computed for each band
and combined into a (filter, y, x) array and stored
as `self._psfImage`.
The result is not cached, so if the same PSF is expected
to be used multiple times it is a good idea to store the
result in another variable.

Parameters
----------
position: `Point2D` or `tuple`
    Coordinates to evaluate the PSF. If `position` is `None`
    then `Psf.getAveragePosition()` is used.

Returns
-------
self._psfImage: array
    The multiband PSF image.

Definition at line 183 of file multiband.py.

    def computePsfImage(self, position=None):
        """Get a multiband PSF image
 
        The PSF Kernel Image is computed for each band
        and combined into a (filter, y, x) array and stored
        as `self._psfImage`.
        The result is not cached, so if the same PSF is expected
        to be used multiple times it is a good idea to store the
        result in another variable.
 
        Parameters
        ----------
        position: `Point2D` or `tuple`
            Coordinates to evaluate the PSF. If `position` is `None`
            then `Psf.getAveragePosition()` is used.
 
        Returns
        -------
        self._psfImage: array
            The multiband PSF image.
        """
        psfs = []
        # Make the coordinates into a Point2D (if necessary)
        if not isinstance(position, Point2D) and position is not None:
            position = Point2D(position[0], position[1])
        for single in self.singles:
            if position is None:
                psfs.append(single.getPsf().computeImage().array)
            else:
                psfs.append(single.getPsf().computeImage(position).array)
        psfs = np.array(psfs)
        psfImage = MultibandImage(self.filters, array=psfs)
        return psfImage

computePsfKernelImage()

def lsst.afw.image.exposure.multiband.MultibandExposure.computePsfKernelImage	(		self,
			position = None
	)

Get a multiband PSF image

The PSF Kernel Image is computed for each band
and combined into a (filter, y, x) array and stored
as `self._psfImage`.
The result is not cached, so if the same PSF is expected
to be used multiple times it is a good idea to store the
result in another variable.

Parameters
----------
position: `Point2D` or `tuple`
    Coordinates to evaluate the PSF. If `position` is `None`
    then `Psf.getAveragePosition()` is used.

Returns
-------
self._psfImage: array
    The multiband PSF image.

Definition at line 149 of file multiband.py.

    def computePsfKernelImage(self, position=None):
        """Get a multiband PSF image
 
        The PSF Kernel Image is computed for each band
        and combined into a (filter, y, x) array and stored
        as `self._psfImage`.
        The result is not cached, so if the same PSF is expected
        to be used multiple times it is a good idea to store the
        result in another variable.
 
        Parameters
        ----------
        position: `Point2D` or `tuple`
            Coordinates to evaluate the PSF. If `position` is `None`
            then `Psf.getAveragePosition()` is used.
 
        Returns
        -------
        self._psfImage: array
            The multiband PSF image.
        """
        psfs = []
        # Make the coordinates into a Point2D (if necessary)
        if not isinstance(position, Point2D) and position is not None:
            position = Point2D(position[0], position[1])
        for single in self.singles:
            if position is None:
                psfs.append(single.getPsf().computeKernelImage().array)
            else:
                psfs.append(single.getPsf().computeKernelImage(position).array)
        psfs = np.array(psfs)
        psfImage = MultibandImage(self.filters, array=psfs)
        return psfImage
 

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
 

fromArrays()

def lsst.afw.image.exposure.multiband.MultibandExposure.fromArrays (   filters,   image,   mask,   variance,   bbox = None  )

static

Construct a MultibandExposure from a collection of arrays

see `tripleFromArrays` for a description of parameters

Definition at line 58 of file multiband.py.

    def fromArrays(filters, image, mask, variance, bbox=None):
        """Construct a MultibandExposure from a collection of arrays
 
        see `tripleFromArrays` for a description of parameters
        """
        return tripleFromArrays(MultibandExposure, filters, image, mask, variance, bbox)
 

fromButler()

def lsst.afw.image.exposure.multiband.MultibandExposure.fromButler (   butler,   filters,   filterKwargs, *  args, **  kwargs  )

static

Load a multiband exposure from a butler

Because each band is stored in a separate exposure file,
this method can be used to load all of the exposures for
a given set of bands

Parameters
----------
butler: `Butler`
    Butler connection to use to load the single band
    calibrated images
filters: `list` or `str`
    List of filter names for each band
filterKwargs: `dict`
    Keyword arguments to pass to the Butler
    that are different for each filter.
    The keys are the names of the arguments and the values
    should also be dictionaries, with filter names as keys
    and the value of the argument for the given filter as values.
args: `list`
    Arguments to the Butler.
kwargs: `dict`
    Keyword arguments to pass to the Butler
    that are the same in all bands.

Returns
-------
result: `MultibandExposure`
    The new `MultibandExposure` created by combining all of the
    single band exposures.

Definition at line 108 of file multiband.py.

    def fromButler(butler, filters, filterKwargs, *args, **kwargs):
        """Load a multiband exposure from a butler
 
        Because each band is stored in a separate exposure file,
        this method can be used to load all of the exposures for
        a given set of bands
 
        Parameters
        ----------
        butler: `Butler`
            Butler connection to use to load the single band
            calibrated images
        filters: `list` or `str`
            List of filter names for each band
        filterKwargs: `dict`
            Keyword arguments to pass to the Butler
            that are different for each filter.
            The keys are the names of the arguments and the values
            should also be dictionaries, with filter names as keys
            and the value of the argument for the given filter as values.
        args: `list`
            Arguments to the Butler.
        kwargs: `dict`
            Keyword arguments to pass to the Butler
            that are the same in all bands.
 
        Returns
        -------
        result: `MultibandExposure`
            The new `MultibandExposure` created by combining all of the
            single band exposures.
        """
        # Load the Exposure in each band
        exposures = []
        for f in filters:
            if filterKwargs is not None:
                for key, value in filterKwargs:
                    kwargs[key] = value[f]
            exposures.append(butler.get(*args, filter=f, **kwargs))
        return MultibandExposure.fromExposures(filters, exposures)
 

fromExposures()

def lsst.afw.image.exposure.multiband.MultibandExposure.fromExposures (   filters,   singles  )

static

Construct a MultibandImage from a collection of single band images

see `tripleFromExposures` for a description of parameters

Definition at line 49 of file multiband.py.

    def fromExposures(filters, singles):
        """Construct a MultibandImage from a collection of single band images
 
        see `tripleFromExposures` for a description of parameters
        """
        psfs = [s.getPsf() for s in singles]
        return tripleFromSingles(MultibandExposure, filters, singles, psfs=psfs)
 

fromKwargs()

def lsst.afw.image.exposure.multiband.MultibandExposure.fromKwargs (   filters,   filterKwargs,   singleType = ExposureF, **  kwargs  )

static

Build a MultibandImage from a set of keyword arguments

see `makeTripleFromKwargs` for a description of parameters

Definition at line 66 of file multiband.py.

    def fromKwargs(filters, filterKwargs, singleType=ExposureF, **kwargs):
        """Build a MultibandImage from a set of keyword arguments
 
        see `makeTripleFromKwargs` for a description of parameters
        """
        return makeTripleFromKwargs(MultibandExposure, filters, filterKwargs, singleType, **kwargs)
 

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.MultibandTripleBase.getBBox (   self,   origin = PARENT  )

inherited

Bounding box

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

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

image()

def lsst.afw.image.image.multiband.MultibandTripleBase.image (   self )

inherited

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

def lsst.afw.image.image.multiband.MultibandTripleBase.mask (   self )

inherited

The mask of the MultibandMaskedImage

Definition at line 701 of file multiband.py.

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

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.image.image.multiband.MultibandTripleBase.setXY0 (   self,   xy0  )

inherited

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)
 

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.image.image.multiband.MultibandTripleBase.shiftedTo (   self,   xy0  )

inherited

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
 

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
 

variance()

def lsst.afw.image.image.multiband.MultibandTripleBase.variance (   self )

inherited

The variance of the MultibandMaskedImage

Definition at line 706 of file multiband.py.

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

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

---

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/exposure/multiband.py