Public Member Functions
	__init__ (self, filterName, footprint, maskedImage, psf, psffwhm, avgNoise, maxNumberOfPeaks, debResult)

	updateFootprintBbox (self)

Public Attributes
	filter

	fp

	maskedImage

	psf

	psffwhm

	img

	imbb

	varimg

	mask

	avgNoise

	debResult

	peakCount

	templateSum

	peaks

	bb

	W

	H

	x0

	y0

	x1

	y1

Detailed Description

Deblender result of a single parent footprint, in a single band

Convenience class to store useful objects used by the deblender for a single band,
such as the maskedImage, psf, etc as well as the results from the deblender.

Parameters
----------
filterName: `str`
    Name of the filter used for `maskedImage`
footprint: list of `afw.detection.Footprint`s
    Parent footprint to deblend in each band.
maskedImages: list of `afw.image.MaskedImageF`s
    Masked image containing the ``footprint`` in each band.
psf: list of `afw.detection.Psf`s
    Psf of the ``maskedImage`` for each band.
psffwhm: list of `float`s
    FWHM of the ``maskedImage``'s ``psf`` in each band.
avgNoise: `float`or list of `float`s, optional
    Average noise level in each ``maskedImage``.
    The default is ``None``, which estimates the noise from the median value of the
    variance plane of ``maskedImage`` for each filter.
maxNumberOfPeaks: `int`, optional
    If positive, the maximum number of peaks to deblend.
    If the total number of peaks is greater than ``maxNumberOfPeaks``,
    then only the first ``maxNumberOfPeaks`` sources are deblended.
    The default is 0, which deblends all of the peaks.
debResult: `DeblenderResult`
    The ``DeblenderResult`` that contains this ``DeblendedParent``.

Definition at line 148 of file baseline.py.

Constructor & Destructor Documentation

◆ init()

lsst.meas.deblender.baseline.DeblendedParent.__init__	(	self,
		filterName,
		footprint,
		maskedImage,
		psf,
		psffwhm,
		avgNoise,
		maxNumberOfPeaks,
		debResult )

Definition at line 178 of file baseline.py.

                 maxNumberOfPeaks, debResult):
        self.filter = filterName
        self.fp = footprint
        self.maskedImage = maskedImage
        self.psf = psf
        self.psffwhm = psffwhm
        self.img = maskedImage.getImage()
        self.imbb = self.img.getBBox()
        self.varimg = maskedImage.getVariance()
        self.mask = maskedImage.getMask()
        self.avgNoise = avgNoise
        self.updateFootprintBbox()
        self.debResult = debResult
        self.peakCount = debResult.peakCount
        self.templateSum = None
 
        # avgNoise is an estiamte of the average noise level for the image in this filter
        if avgNoise is None:
            stats = afwMath.makeStatistics(self.varimg, self.mask, afwMath.MEDIAN)
            avgNoise = np.sqrt(stats.getValue(afwMath.MEDIAN))
            debResult.log.trace('Estimated avgNoise for filter %s = %f', self.filter, avgNoise)
        self.avgNoise = avgNoise
 
        # Store all of the peak information in a single object
        self.peaks = []
        peaks = self.fp.getPeaks()
        for idx in range(self.peakCount):
            deblendedPeak = DeblendedPeak(peaks[idx], idx, self)
            self.peaks.append(deblendedPeak)
 

Member Function Documentation

◆ updateFootprintBbox()

lsst.meas.deblender.baseline.DeblendedParent.updateFootprintBbox ( self )

Update the bounding box of the parent footprint

If the parent Footprint is resized it will be necessary to update the bounding box of the footprint.

Definition at line 209 of file baseline.py.

    def updateFootprintBbox(self):
        """Update the bounding box of the parent footprint
 
        If the parent Footprint is resized it will be necessary to update the bounding box of the footprint.
        """
        # Pull out the image bounds of the parent Footprint
        self.bb = self.fp.getBBox()
        if not self.imbb.contains(self.bb):
            raise ValueError(('Footprint bounding-box %s extends outside image bounding-box %s') %
                             (str(self.bb), str(self.imbb)))
        self.W, self.H = self.bb.getWidth(), self.bb.getHeight()
        self.x0, self.y0 = self.bb.getMinX(), self.bb.getMinY()
        self.x1, self.y1 = self.bb.getMaxX(), self.bb.getMaxY()
 
 

Member Data Documentation

◆ avgNoise

lsst.meas.deblender.baseline.DeblendedParent.avgNoise

Definition at line 189 of file baseline.py.

◆ bb

lsst.meas.deblender.baseline.DeblendedParent.bb

Definition at line 215 of file baseline.py.

◆ debResult

lsst.meas.deblender.baseline.DeblendedParent.debResult

Definition at line 191 of file baseline.py.

◆ filter

lsst.meas.deblender.baseline.DeblendedParent.filter

Definition at line 180 of file baseline.py.

◆ fp

lsst.meas.deblender.baseline.DeblendedParent.fp

Definition at line 181 of file baseline.py.

◆ H

lsst.meas.deblender.baseline.DeblendedParent.H

Definition at line 219 of file baseline.py.

◆ imbb

lsst.meas.deblender.baseline.DeblendedParent.imbb

Definition at line 186 of file baseline.py.

◆ img

lsst.meas.deblender.baseline.DeblendedParent.img

Definition at line 185 of file baseline.py.

◆ mask

lsst.meas.deblender.baseline.DeblendedParent.mask

Definition at line 188 of file baseline.py.

◆ maskedImage

lsst.meas.deblender.baseline.DeblendedParent.maskedImage

Definition at line 182 of file baseline.py.

◆ peakCount

lsst.meas.deblender.baseline.DeblendedParent.peakCount

Definition at line 192 of file baseline.py.

◆ peaks

lsst.meas.deblender.baseline.DeblendedParent.peaks

Definition at line 203 of file baseline.py.

◆ psf

lsst.meas.deblender.baseline.DeblendedParent.psf

Definition at line 183 of file baseline.py.

◆ psffwhm

lsst.meas.deblender.baseline.DeblendedParent.psffwhm

Definition at line 184 of file baseline.py.

◆ templateSum

lsst.meas.deblender.baseline.DeblendedParent.templateSum

Definition at line 193 of file baseline.py.

◆ varimg

lsst.meas.deblender.baseline.DeblendedParent.varimg

Definition at line 187 of file baseline.py.

◆ W

lsst.meas.deblender.baseline.DeblendedParent.W

Definition at line 219 of file baseline.py.

◆ x0

lsst.meas.deblender.baseline.DeblendedParent.x0

Definition at line 220 of file baseline.py.

◆ x1

lsst.meas.deblender.baseline.DeblendedParent.x1

Definition at line 221 of file baseline.py.

◆ y0

lsst.meas.deblender.baseline.DeblendedParent.y0