Inheritance diagram for lsst.meas.algorithms.subtractBackground.SubtractBackgroundTask:

Public Member Functions
	run (self, exposure, background=None, stats=True, statsKeys=None)

	fitBackground (self, maskedImage, nx=0, ny=0, algorithm=None)

Static Public Attributes
	ConfigClass = SubtractBackgroundConfig

Protected Member Functions
	_addStats (self, exposure, background, statsKeys=None)

Static Protected Attributes
str	_DefaultName = "subtractBackground"

Detailed Description

Subtract the background from an exposure

Definition at line 119 of file subtractBackground.py.

Member Function Documentation

◆ _addStats()

lsst.meas.algorithms.subtractBackground.SubtractBackgroundTask._addStats	(	self,
		exposure,
		background,
		statsKeys = None )

protected

Add statistics about the background to the exposure's metadata

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure whose background was subtracted.
background : `lsst.afw.math.BackgroundList`
    Background model
statsKeys : `tuple`
    Key names used to store the mean and variance of the background in
    the exposure's metadata (a tuple); if None then use
    ("BGMEAN", "BGVAR"); ignored if stats is false.

Definition at line 179 of file subtractBackground.py.

    def _addStats(self, exposure, background, statsKeys=None):
        """Add statistics about the background to the exposure's metadata
 
        Parameters
        ----------
        exposure : `lsst.afw.image.Exposure`
            Exposure whose background was subtracted.
        background : `lsst.afw.math.BackgroundList`
            Background model
        statsKeys : `tuple`
            Key names used to store the mean and variance of the background in
            the exposure's metadata (a tuple); if None then use
            ("BGMEAN", "BGVAR"); ignored if stats is false.
        """
        netBgImg = background.getImage()
        if statsKeys is None:
            statsKeys = ("BGMEAN", "BGVAR")
        mnkey, varkey = statsKeys
        meta = exposure.getMetadata()
        s = afwMath.makeStatistics(netBgImg, afwMath.MEAN | afwMath.VARIANCE)
        bgmean = s.getValue(afwMath.MEAN)
        bgvar = s.getValue(afwMath.VARIANCE)
        meta.addDouble(mnkey, bgmean)
        meta.addDouble(varkey, bgvar)
 

◆ fitBackground()

lsst.meas.algorithms.subtractBackground.SubtractBackgroundTask.fitBackground	(	self,
		maskedImage,
		nx = 0,
		ny = 0,
		algorithm = None )

Estimate the background of a masked image

Parameters
----------
maskedImage : `lsst.afw.image.maskedImage`
    Masked image whose background is to be computed
nx : 'int`
    Number of x bands; if 0 compute from width and `self.config.binSizeX`
ny : `int`
    Number of y bands; if 0 compute from height and `self.config.binSizeY`
algorithm : `str`
    Name of interpolation algorithm; if None use `self.config.algorithm`

Returns
-------
bg : `lsst.afw.math.Background`
    A fit background

Raises
------
RuntimeError
    Raised if lsst.afw.math.makeBackground returns None, an indicator
    of failure.

Definition at line 204 of file subtractBackground.py.

    def fitBackground(self, maskedImage, nx=0, ny=0, algorithm=None):
        """Estimate the background of a masked image
 
        Parameters
        ----------
        maskedImage : `lsst.afw.image.maskedImage`
            Masked image whose background is to be computed
        nx : 'int`
            Number of x bands; if 0 compute from width and `self.config.binSizeX`
        ny : `int`
            Number of y bands; if 0 compute from height and `self.config.binSizeY`
        algorithm : `str`
            Name of interpolation algorithm; if None use `self.config.algorithm`
 
        Returns
        -------
        bg : `lsst.afw.math.Background`
            A fit background
 
        Raises
        ------
        RuntimeError
            Raised if lsst.afw.math.makeBackground returns None, an indicator
            of failure.
        """
 
        binSizeX = self.config.binSize if self.config.binSizeX == 0 else self.config.binSizeX
        binSizeY = self.config.binSize if self.config.binSizeY == 0 else self.config.binSizeY
 
        if not nx:
            nx = maskedImage.getWidth()//binSizeX + 1
        if not ny:
            ny = maskedImage.getHeight()//binSizeY + 1
 
        unsubFrame = getDebugFrame(self._display, "unsubtracted")
        if unsubFrame:
            unsubDisp = afwDisplay.getDisplay(frame=unsubFrame)
            unsubDisp.mtv(maskedImage, title="unsubtracted")
            xPosts = numpy.rint(numpy.linspace(0, maskedImage.getWidth() + 1, num=nx, endpoint=True))
            yPosts = numpy.rint(numpy.linspace(0, maskedImage.getHeight() + 1, num=ny, endpoint=True))
            with unsubDisp.Buffering():
                for (xMin, xMax), (yMin, yMax) in itertools.product(zip(xPosts[:-1], xPosts[1:]),
                                                                    zip(yPosts[:-1], yPosts[1:])):
                    unsubDisp.line([(xMin, yMin), (xMin, yMax), (xMax, yMax), (xMax, yMin), (xMin, yMin)])
 
        sctrl = afwMath.StatisticsControl()
        badMask = maskedImage.mask.getPlaneBitMask(self.config.ignoredPixelMask)
 
        sctrl.setAndMask(badMask)
        sctrl.setNanSafe(self.config.isNanSafe)
 
        self.log.debug("Ignoring mask planes: %s", ", ".join(self.config.ignoredPixelMask))
        if (maskedImage.mask.getArray() & badMask).all():
            raise pipeBase.TaskError("All pixels masked. Cannot estimate background")
 
        if algorithm is None:
            algorithm = self.config.algorithm
 
        # TODO: DM-22814. This call to a deprecated BackgroundControl constructor
        # is necessary to support the algorithm parameter; it # should be replaced with
        #
        #     afwMath.BackgroundControl(nx, ny, sctrl, self.config.statisticsProperty)
        #
        # when algorithm has been deprecated and removed.
        with suppress_deprecations():
            bctrl = afwMath.BackgroundControl(algorithm, nx, ny,
                                              self.config.undersampleStyle, sctrl,
                                              self.config.statisticsProperty)
 
        # TODO: The following check should really be done within lsst.afw.math.
        #       With the current code structure, it would need to be accounted for in the doGetImage()
        #       function in BackgroundMI.cc (which currently only checks against the interpolation settings,
        #       which is not appropriate when useApprox=True)
        #       and/or the makeApproximate() function in afw/Approximate.cc.
        #       See ticket DM-2920: "Clean up code in afw for Approximate background
        #       estimation" (which includes a note to remove the following and the
        #       similar checks in pipe_tasks/matchBackgrounds.py once implemented)
        #
        # Check that config setting of approxOrder/binSize make sense
        # (i.e. ngrid (= shortDimension/binSize) > approxOrderX) and perform
        # appropriate undersampleStlye behavior.
        if self.config.useApprox:
            if self.config.approxOrderY not in (self.config.approxOrderX, -1):
                raise ValueError("Error: approxOrderY not in (approxOrderX, -1)")
            order = self.config.approxOrderX
            minNumberGridPoints = order + 1
            if min(nx, ny) <= order:
                self.log.warning("Too few points in grid to constrain fit: min(nx, ny) < approxOrder) "
                                 "[min(%d, %d) < %d]", nx, ny, order)
                if self.config.undersampleStyle == "THROW_EXCEPTION":
                    raise ValueError("Too few points in grid (%d, %d) for order (%d) and binSize (%d, %d)" %
                                     (nx, ny, order, binSizeX, binSizeY))
                elif self.config.undersampleStyle == "REDUCE_INTERP_ORDER":
                    if order < 1:
                        raise ValueError("Cannot reduce approxOrder below 0.  "
                                         "Try using undersampleStyle = \"INCREASE_NXNYSAMPLE\" instead?")
                    order = min(nx, ny) - 1
                    self.log.warning("Reducing approxOrder to %d", order)
                elif self.config.undersampleStyle == "INCREASE_NXNYSAMPLE":
                    # Reduce bin size to the largest acceptable square bins
                    newBinSize = min(maskedImage.getWidth(), maskedImage.getHeight())//(minNumberGridPoints-1)
                    if newBinSize < 1:
                        raise ValueError("Binsize must be greater than 0")
                    newNx = maskedImage.getWidth()//newBinSize + 1
                    newNy = maskedImage.getHeight()//newBinSize + 1
                    bctrl.setNxSample(newNx)
                    bctrl.setNySample(newNy)
                    self.log.warning("Decreasing binSize from (%d, %d) to %d for a grid of (%d, %d)",
                                     binSizeX, binSizeY, newBinSize, newNx, newNy)
 
            actrl = afwMath.ApproximateControl(afwMath.ApproximateControl.CHEBYSHEV, order, order,
                                               self.config.weighting)
            bctrl.setApproximateControl(actrl)
 
        bg = afwMath.makeBackground(maskedImage, bctrl)
        if bg is None:
            raise RuntimeError("lsst.afw.math.makeBackground failed to fit a background model")
        return bg

◆ run()

lsst.meas.algorithms.subtractBackground.SubtractBackgroundTask.run	(	self,
		exposure,
		background = None,
		stats = True,
		statsKeys = None )

Fit and subtract the background of an exposure.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure whose background is to be subtracted.
background : `lsst.afw.math.BackgroundList`
    Initial background model already subtracted. May be None if no background
    has been subtracted.
stats : `bool`
    If True then measure the mean and variance of the full background model and
    record the results in the exposure's metadata.
statsKeys : `tuple`
    Key names used to store the mean and variance of the background in the
    exposure's metadata (another tuple); if None then use ("BGMEAN", "BGVAR");
    ignored if stats is false.

Returns
-------
background : `lsst.afw.math.BackgroundLst`
    Full background model (initial model with changes), contained in an
    `lsst.pipe.base.Struct`.

Definition at line 125 of file subtractBackground.py.

    def run(self, exposure, background=None, stats=True, statsKeys=None):
        """Fit and subtract the background of an exposure.
 
        Parameters
        ----------
        exposure : `lsst.afw.image.Exposure`
            Exposure whose background is to be subtracted.
        background : `lsst.afw.math.BackgroundList`
            Initial background model already subtracted. May be None if no background
            has been subtracted.
        stats : `bool`
            If True then measure the mean and variance of the full background model and
            record the results in the exposure's metadata.
        statsKeys : `tuple`
            Key names used to store the mean and variance of the background in the
            exposure's metadata (another tuple); if None then use ("BGMEAN", "BGVAR");
            ignored if stats is false.
 
        Returns
        -------
        background : `lsst.afw.math.BackgroundLst`
            Full background model (initial model with changes), contained in an
            `lsst.pipe.base.Struct`.
        """
        if background is None:
            background = afwMath.BackgroundList()
 
        maskedImage = exposure.getMaskedImage()
        fitBg = self.fitBackground(maskedImage)
        maskedImage -= fitBg.getImageF(self.config.algorithm, self.config.undersampleStyle)
 
        actrl = fitBg.getBackgroundControl().getApproximateControl()
        background.append((fitBg, getattr(afwMath.Interpolate, self.config.algorithm),
                           fitBg.getAsUsedUndersampleStyle(), actrl.getStyle(),
                           actrl.getOrderX(), actrl.getOrderY(), actrl.getWeighting()))
 
        if stats:
            self._addStats(exposure, background, statsKeys=statsKeys)
 
        subFrame = getDebugFrame(self._display, "subtracted")
        if subFrame:
            subDisp = afwDisplay.getDisplay(frame=subFrame)
            subDisp.mtv(exposure, title="subtracted")
 
        bgFrame = getDebugFrame(self._display, "background")
        if bgFrame:
            bgDisp = afwDisplay.getDisplay(frame=bgFrame)
            bgImage = background.getImage()
            bgDisp.mtv(bgImage, title="background")
 
        return pipeBase.Struct(
            background=background,
        )
 

Member Data Documentation

◆ _DefaultName

str lsst.meas.algorithms.subtractBackground.SubtractBackgroundTask._DefaultName = "subtractBackground"

staticprotected

Definition at line 123 of file subtractBackground.py.

◆ ConfigClass

lsst.meas.algorithms.subtractBackground.SubtractBackgroundTask.ConfigClass = SubtractBackgroundConfig

static

Definition at line 122 of file subtractBackground.py.

The documentation for this class was generated from the following file:

/j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_algorithms/ge6526c86ff+889fc9d533/python/lsst/meas/algorithms/subtractBackground.py

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Attributes