Inheritance diagram for lsst.afw.detection.multiband.MultibandFootprint:

Public Member Functions
	__init__ (self, filters, singles)

	getSpans (self)

	footprint (self)

	mMaskedImage (self)

	spans (self)

	getPeaks (self)

	peaks (self)

	getImage (self, bbox=None, fill=np.nan, imageType=MultibandMaskedImage)

	clone (self, deep=True)

Static Public Member Functions
	fromArrays (filters, image, mask=None, variance=None, footprint=None, xy0=None, thresh=0, peaks=None)

	fromImages (filters, image, mask=None, variance=None, footprint=None, thresh=0, peaks=None)

	fromMaskedImages (filters, maskedImages, footprint=None, thresh=0, peaks=None)

Protected Member Functions
	_slice (self, filters, filterIndex, indices)

Protected Attributes
	_footprint

Detailed Description

Multiband Footprint class

A `MultibandFootprint` is a collection of HeavyFootprints that have
the same `SpanSet` and `peakCatalog` but different flux in each band.

Parameters
----------
filters : `list`
    List of filter names.
singles : `list`
    A list of single band `HeavyFootprint` objects.
    Each `HeavyFootprint` should have the same `PeakCatalog`
    and the same `SpanSet`, however to save CPU cycles there
    is no internal check for consistency of the peak catalog.

Definition at line 83 of file multiband.py.

Constructor & Destructor Documentation

◆ init()

lsst.afw.detection.multiband.MultibandFootprint.__init__	(	self,
		filters,
		singles )

Reimplemented from lsst.afw.multiband.MultibandBase.

Definition at line 99 of file multiband.py.

    def __init__(self, filters, singles):
        super().__init__(filters, singles)
        # Ensure that all HeavyFootprints have the same SpanSet
        spans = singles[0].getSpans()
        if not all([heavy.getSpans() == spans for heavy in singles]):
            raise ValueError("All HeavyFootprints in singles are expected to have the same SpanSet")
 
        # Assume that all footprints have the same SpanSet and PeakCatalog
        footprint = Footprint(spans)
        footprint.setPeakCatalog(singles[0].getPeaks())
        self._footprint = footprint
 

Member Function Documentation

◆ _slice()

lsst.afw.detection.multiband.MultibandFootprint._slice	(	self,
		filters,
		filterIndex,
		indices )

protected

Slice the current object and return the result

`MultibandFootprint` objects cannot be sliced along the image
dimension, so an error is thrown if `indices` has any elements.

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

Reimplemented from lsst.afw.multiband.MultibandBase.

Definition at line 255 of file multiband.py.

    def _slice(self, filters, filterIndex, indices):
        """Slice the current object and return the result
 
        `MultibandFootprint` objects cannot be sliced along the image
        dimension, so an error is thrown if `indices` has any elements.
 
        See `Multiband._slice` for a list of the parameters.
        """
        if len(indices) > 0:
            raise IndexError("MultibandFootprints can only be sliced in the filter dimension")
 
        if isinstance(filterIndex, slice):
            singles = self.singles[filterIndex]
        else:
            singles = [self.singles[idx] for idx in filterIndex]
 
        return MultibandFootprint(filters, singles)
 

◆ clone()

lsst.afw.detection.multiband.MultibandFootprint.clone	(		self,
			deep = True )

Copy the current object

Parameters
----------
deep : `bool`
    Whether or not to make a deep copy

Returns
-------
result : `MultibandFootprint`
    The cloned footprint.

Reimplemented from lsst.afw.multiband.MultibandBase.

Definition at line 312 of file multiband.py.

    def clone(self, deep=True):
        """Copy the current object
 
        Parameters
        ----------
        deep : `bool`
            Whether or not to make a deep copy
 
        Returns
        -------
        result : `MultibandFootprint`
            The cloned footprint.
        """
        if deep:
            footprint = Footprint(self.footprint.getSpans())
            for peak in self.footprint.getPeaks():
                footprint.addPeak(peak.getX(), peak.getY(), peak.getValue())
            mMaskedImage = self.getImage()
            filters = tuple([f for f in self.filters])
            result = MultibandFootprint.fromMaskedImages(filters, mMaskedImage, footprint)
        else:
            result = MultibandFootprint(self.filters, self.singles)
        return result

◆ footprint()

lsst.afw.detection.multiband.MultibandFootprint.footprint ( self )

Common SpanSet and peak catalog for the single band footprints

Definition at line 232 of file multiband.py.

    def footprint(self):
        """Common SpanSet and peak catalog for the single band footprints"""
        return self._footprint
 

◆ fromArrays()

lsst.afw.detection.multiband.MultibandFootprint.fromArrays	(	filters,
		image,
		mask = None,
		variance = None,
		footprint = None,
		xy0 = None,
		thresh = 0,
		peaks = None )

static

Create a `MultibandFootprint` from an `image`, `mask`, `variance`

Parameters
----------
filters : `list`
    List of filter names.
image: array
    An array to convert into `lsst.afw.detection.HeavyFootprint` objects.
    Only pixels above the `thresh` value for at least one band
    will be included in the `SpanSet` and resulting footprints.
mask : array
    Mask for the `image` array.
variance : array
    Variance of the `image` array.
footprint : `Footprint`
    `Footprint` that contains the `SpanSet` and `PeakCatalog`
    to use for the `HeavyFootprint` in each band.
    If `footprint` is `None` then the `thresh` is used to create a
    `Footprint` based on the pixels above the `thresh` value.
xy0 : `Point2I`
    If `image` is an array and `footprint` is `None` then specifying
    `xy0` gives the location of the minimum `x` and `y` value of the
    `images`.
thresh : `float` or list of floats
    Threshold in each band (or the same threshold to be used in all bands)
    to include a pixel in the `SpanSet` of the `MultibandFootprint`.
    If `Footprint` is not `None` then `thresh` is ignored.
peaks : `PeakCatalog`
    Catalog containing information about the peaks located in the
    footprints.

Returns
-------
result : `MultibandFootprint`
    MultibandFootprint created from the arrays

Definition at line 112 of file multiband.py.

    def fromArrays(filters, image, mask=None, variance=None, footprint=None, xy0=None, thresh=0, peaks=None):
        """Create a `MultibandFootprint` from an `image`, `mask`, `variance`
 
        Parameters
        ----------
        filters : `list`
            List of filter names.
        image: array
            An array to convert into `lsst.afw.detection.HeavyFootprint` objects.
            Only pixels above the `thresh` value for at least one band
            will be included in the `SpanSet` and resulting footprints.
        mask : array
            Mask for the `image` array.
        variance : array
            Variance of the `image` array.
        footprint : `Footprint`
            `Footprint` that contains the `SpanSet` and `PeakCatalog`
            to use for the `HeavyFootprint` in each band.
            If `footprint` is `None` then the `thresh` is used to create a
            `Footprint` based on the pixels above the `thresh` value.
        xy0 : `Point2I`
            If `image` is an array and `footprint` is `None` then specifying
            `xy0` gives the location of the minimum `x` and `y` value of the
            `images`.
        thresh : `float` or list of floats
            Threshold in each band (or the same threshold to be used in all bands)
            to include a pixel in the `SpanSet` of the `MultibandFootprint`.
            If `Footprint` is not `None` then `thresh` is ignored.
        peaks : `PeakCatalog`
            Catalog containing information about the peaks located in the
            footprints.
 
        Returns
        -------
        result : `MultibandFootprint`
            MultibandFootprint created from the arrays
        """
        # Generate a new Footprint if one has not been specified
        if footprint is None:
            spans, imageBBox = getSpanSetFromImages(image, thresh, xy0)
            footprint = Footprint(spans)
        else:
            imageBBox = footprint.getBBox()
 
        if peaks is not None:
            footprint.setPeakCatalog(peaks)
        mMaskedImage = MultibandMaskedImage.fromArrays(filters, image, mask, variance, imageBBox)
        singles = [makeHeavyFootprint(footprint, maskedImage) for maskedImage in mMaskedImage]
        return MultibandFootprint(filters, singles)
 

◆ fromImages()

lsst.afw.detection.multiband.MultibandFootprint.fromImages	(	filters,
		image,
		mask = None,
		variance = None,
		footprint = None,
		thresh = 0,
		peaks = None )

static

Create a `MultibandFootprint` from an `image`, `mask`, `variance`

Parameters
----------
filters : `list`
    List of filter names.
image : `lsst.afw.image.MultibandImage`, or list of `lsst.afw.image.Image`
    A `lsst.afw.image.MultibandImage` (or collection of images in each band)
    to convert into `HeavyFootprint` objects.
    Only pixels above the `thresh` value for at least one band
    will be included in the `SpanSet` and resulting footprints.
mask : `MultibandMask` or list of `Mask`
    Mask for the `image`.
variance : `lsst.afw.image.MultibandImage`, or list of `lsst.afw.image.Image`
    Variance of the `image`.
thresh : `float` or `list` of floats
    Threshold in each band (or the same threshold to be used in all bands)
    to include a pixel in the `SpanSet` of the `MultibandFootprint`.
    If `Footprint` is not `None` then `thresh` is ignored.
peaks : `PeakCatalog`
    Catalog containing information about the peaks located in the
    footprints.

Returns
-------
result : `MultibandFootprint`
    MultibandFootprint created from the image, mask, and variance

Definition at line 163 of file multiband.py.

    def fromImages(filters, image, mask=None, variance=None, footprint=None, thresh=0, peaks=None):
        """Create a `MultibandFootprint` from an `image`, `mask`, `variance`
 
        Parameters
        ----------
        filters : `list`
            List of filter names.
        image : `lsst.afw.image.MultibandImage`, or list of `lsst.afw.image.Image`
            A `lsst.afw.image.MultibandImage` (or collection of images in each band)
            to convert into `HeavyFootprint` objects.
            Only pixels above the `thresh` value for at least one band
            will be included in the `SpanSet` and resulting footprints.
        mask : `MultibandMask` or list of `Mask`
            Mask for the `image`.
        variance : `lsst.afw.image.MultibandImage`, or list of `lsst.afw.image.Image`
            Variance of the `image`.
        thresh : `float` or `list` of floats
            Threshold in each band (or the same threshold to be used in all bands)
            to include a pixel in the `SpanSet` of the `MultibandFootprint`.
            If `Footprint` is not `None` then `thresh` is ignored.
        peaks : `PeakCatalog`
            Catalog containing information about the peaks located in the
            footprints.
 
        Returns
        -------
        result : `MultibandFootprint`
            MultibandFootprint created from the image, mask, and variance
        """
        # Generate a new Footprint if one has not been specified
        if footprint is None:
            spans, imageBBox = getSpanSetFromImages(image, thresh)
            footprint = Footprint(spans)
 
        if peaks is not None:
            footprint.setPeakCatalog(peaks)
        mMaskedImage = MultibandMaskedImage(filters, image, mask, variance)
        singles = [makeHeavyFootprint(footprint, maskedImage) for maskedImage in mMaskedImage]
        return MultibandFootprint(filters, singles)
 

◆ fromMaskedImages()

lsst.afw.detection.multiband.MultibandFootprint.fromMaskedImages	(	filters,
		maskedImages,
		footprint = None,
		thresh = 0,
		peaks = None )

static

Create a `MultibandFootprint` from a list of `MaskedImage`

See `fromImages` for a description of the parameters not listed below

Parameters
----------
maskedImages : `list` of `lsst.afw.image.MaskedImage`
    MaskedImages to extract the single band heavy footprints from.
    Like `fromImages`, if a `footprint` is not specified then all
    pixels above `thresh` will be used, and `peaks` will be added
    to the `PeakCatalog`.

Returns
-------
result : `MultibandFootprint`
    MultibandFootprint created from the image, mask, and variance

Definition at line 204 of file multiband.py.

    def fromMaskedImages(filters, maskedImages, footprint=None, thresh=0, peaks=None):
        """Create a `MultibandFootprint` from a list of `MaskedImage`
 
        See `fromImages` for a description of the parameters not listed below
 
        Parameters
        ----------
        maskedImages : `list` of `lsst.afw.image.MaskedImage`
            MaskedImages to extract the single band heavy footprints from.
            Like `fromImages`, if a `footprint` is not specified then all
            pixels above `thresh` will be used, and `peaks` will be added
            to the `PeakCatalog`.
 
        Returns
        -------
        result : `MultibandFootprint`
            MultibandFootprint created from the image, mask, and variance
        """
        image = [maskedImage.image for maskedImage in maskedImages]
        mask = [maskedImage.mask for maskedImage in maskedImages]
        variance = [maskedImage.variance for maskedImage in maskedImages]
        return MultibandFootprint.fromImages(filters, image, mask, variance, footprint, thresh, peaks)
 

◆ getImage()

lsst.afw.detection.multiband.MultibandFootprint.getImage	(	self,
		bbox = None,
		fill = np.nan,
		imageType = MultibandMaskedImage )

Convert a `MultibandFootprint` to a `MultibandImage`

This returns the heavy footprints converted into an `MultibandImage` or
`MultibandMaskedImage` (depending on `imageType`).
This might be different than the internal `mMaskedImage` property
of the `MultibandFootprint`, as the `mMaskedImage` might contain
some non-zero pixels not contained in the footprint but present in
the images.

Parameters
----------
bbox : `Box2I`
    Bounding box of the resulting image.
    If no bounding box is specified, then the bounding box
    of the footprint is used.
fill : `float`
    Value to use for any pixel in the resulting image
    outside of the `SpanSet`.
imageType : `type`
    This should be either a `MultibandMaskedImage`
    or `MultibandImage` and describes the type of the output image.

Returns
-------
result : `MultibandBase`
    The resulting `MultibandImage` or `MultibandMaskedImage` created
    from the `MultibandHeavyFootprint`.

Definition at line 273 of file multiband.py.

    def getImage(self, bbox=None, fill=np.nan, imageType=MultibandMaskedImage):
        """Convert a `MultibandFootprint` to a `MultibandImage`
 
        This returns the heavy footprints converted into an `MultibandImage` or
        `MultibandMaskedImage` (depending on `imageType`).
        This might be different than the internal `mMaskedImage` property
        of the `MultibandFootprint`, as the `mMaskedImage` might contain
        some non-zero pixels not contained in the footprint but present in
        the images.
 
        Parameters
        ----------
        bbox : `Box2I`
            Bounding box of the resulting image.
            If no bounding box is specified, then the bounding box
            of the footprint is used.
        fill : `float`
            Value to use for any pixel in the resulting image
            outside of the `SpanSet`.
        imageType : `type`
            This should be either a `MultibandMaskedImage`
            or `MultibandImage` and describes the type of the output image.
 
        Returns
        -------
        result : `MultibandBase`
            The resulting `MultibandImage` or `MultibandMaskedImage` created
            from the `MultibandHeavyFootprint`.
        """
        if imageType == MultibandMaskedImage:
            singleType = MaskedImage
        elif imageType == MultibandImage:
            singleType = Image
        else:
            raise TypeError("Expected imageType to be either MultibandImage or MultibandMaskedImage")
        maskedImages = [heavy.extractImage(fill, bbox, singleType) for heavy in self.singles]
        mMaskedImage = imageType.fromImages(self.filters, maskedImages)
        return mMaskedImage
 

◆ getPeaks()

lsst.afw.detection.multiband.MultibandFootprint.getPeaks ( self )

Get the `PeakCatalog`

Definition at line 246 of file multiband.py.

    def getPeaks(self):
        """Get the `PeakCatalog`"""
        return self._footprint.getPeaks()
 

◆ getSpans()

lsst.afw.detection.multiband.MultibandFootprint.getSpans ( self )

Get the full `SpanSet`

Definition at line 227 of file multiband.py.

    def getSpans(self):
        """Get the full `SpanSet`"""
        return self._footprint.getSpans()
 

◆ mMaskedImage()

lsst.afw.detection.multiband.MultibandFootprint.mMaskedImage ( self )

MultibandMaskedImage that the footprints present a view into

Definition at line 237 of file multiband.py.

    def mMaskedImage(self):
        """MultibandMaskedImage that the footprints present a view into"""
        return self._mMaskedImage
 

◆ peaks()

lsst.afw.detection.multiband.MultibandFootprint.peaks ( self )

`PeakCatalog` of the `MultibandFootprint`

Definition at line 251 of file multiband.py.

    def peaks(self):
        """`PeakCatalog` of the `MultibandFootprint`"""
        return self._footprint.getPeaks()
 

◆ spans()

lsst.afw.detection.multiband.MultibandFootprint.spans ( self )

`SpanSet` of the `MultibandFootprint`

Definition at line 242 of file multiband.py.

    def spans(self):
        """`SpanSet` of the `MultibandFootprint`"""
        return self._footprint.getSpans()
 

Member Data Documentation

◆ _footprint

lsst.afw.detection.multiband.MultibandFootprint._footprint

protected

Definition at line 109 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/detection/multiband.py

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _slice()

◆ clone()

◆ footprint()

◆ fromArrays()

◆ fromImages()

◆ fromMaskedImages()

◆ getImage()

◆ getPeaks()

◆ getSpans()

◆ mMaskedImage()

◆ peaks()

◆ spans()

Member Data Documentation

◆ _footprint

◆ init()