lsst.meas.algorithms.reinterpolate_pixels.ReinterpolatePixelsTask Class Reference

Inheritance diagram for lsst.meas.algorithms.reinterpolate_pixels.ReinterpolatePixelsTask:

Public Member Functions
	run (self, exposure)

Static Public Attributes
	ConfigClass = ReinterpolatePixelsConfig

Protected Member Functions
	_fromFootprintList (self, fpList)
	_interpolateDefectList (self, exposure, defectList)

Static Protected Attributes
str	_DefaultName = "reinterpolatePixels"

Detailed Description

Task to reinterpolate pixels

Definition at line 49 of file reinterpolate_pixels.py.

Member Function Documentation

_fromFootprintList()

lsst.meas.algorithms.reinterpolate_pixels.ReinterpolatePixelsTask._fromFootprintList ( self, fpList )

protected

Compute a defect list from a footprint list.

Parameters
----------
fpList : `list` of `lsst.afw.detection.Footprint`
    Footprint list to process.

Returns
-------
defects : `list` of `lsst.meas.algorithms.Defect`
    List of defects.

Notes
-----
By using `itertools.chain.from_iterable()`, the nested iterables are merged into a flat iterable,
allowing convenient iteration over all `lsst.meas.algorithms.Defect` objects.

Definition at line 76 of file reinterpolate_pixels.py.

    def _fromFootprintList(self, fpList):
        """Compute a defect list from a footprint list.
 
        Parameters
        ----------
        fpList : `list` of `lsst.afw.detection.Footprint`
            Footprint list to process.
 
        Returns
        -------
        defects : `list` of `lsst.meas.algorithms.Defect`
            List of defects.
 
        Notes
        -----
        By using `itertools.chain.from_iterable()`, the nested iterables are merged into a flat iterable,
        allowing convenient iteration over all `lsst.meas.algorithms.Defect` objects.
        """
        return list(
            itertools.chain.from_iterable(map(Defect, afwDetection.footprintToBBoxList(fp)) for fp in fpList)
        )
 

_interpolateDefectList()

lsst.meas.algorithms.reinterpolate_pixels.ReinterpolatePixelsTask._interpolateDefectList ( self, exposure, defectList )

protected

Interpolate over defects specified in a defect list.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure to process.
defectList : `list` of `lsst.meas.algorithms.Defect`
    List of defects to interpolate over.

Notes
-----
``exposure`` is modified in place and will become the reinterpolated exposure.
When reinterpolating following the interpolation in ip_isr, be aware that the masks are intentionally
left grown as a side-effect of that interpolation.

Definition at line 98 of file reinterpolate_pixels.py.

    def _interpolateDefectList(self, exposure, defectList):
        """Interpolate over defects specified in a defect list.
 
        Parameters
        ----------
        exposure : `lsst.afw.image.Exposure`
            Exposure to process.
        defectList : `list` of `lsst.meas.algorithms.Defect`
            List of defects to interpolate over.
 
        Notes
        -----
        ``exposure`` is modified in place and will become the reinterpolated exposure.
        When reinterpolating following the interpolation in ip_isr, be aware that the masks are intentionally
        left grown as a side-effect of that interpolation.
        """
 
        # Although `interpolateOverDefects` requires the
        # `lsst.afw.detection.Psf` argument to be passed, it does not actually
        # utilize it. A dummy `lsst.afw.detection.Psf` object must still be
        # provided to prevent a TypeError.
        dummyPsf = afwDetection.Psf()
        if self.config.fallbackValue is None:
            fallbackValue = afwMath.makeStatistics(exposure.image, afwMath.MEANCLIP).getValue()
        else:
            fallbackValue = self.config.fallbackValue
        if "INTRP" not in exposure.mask.getMaskPlaneDict():
            exposure.mask.addMaskPlane("INTRP")
        interpolateOverDefects(exposure.maskedImage, dummyPsf, defectList, fallbackValue, True)

run()

lsst.meas.algorithms.reinterpolate_pixels.ReinterpolatePixelsTask.run	(		self,
			exposure )

Reinterpolate pixels over ``exposure``.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure to interpolate over.

Notes
-----
``exposure`` is modified in place and will become the reinterpolated exposure.

Definition at line 55 of file reinterpolate_pixels.py.

    def run(self, exposure):
        """Reinterpolate pixels over ``exposure``.
 
        Parameters
        ----------
        exposure : `lsst.afw.image.Exposure`
            Exposure to interpolate over.
 
        Notes
        -----
        ``exposure`` is modified in place and will become the reinterpolated exposure.
        """
        mask = exposure.mask
 
        thresh = afwDetection.Threshold(
            mask.getPlaneBitMask(self.config.maskNameList), afwDetection.Threshold.BITMASK
        )
        fpSet = afwDetection.FootprintSet(mask, thresh)
        defectList = self._fromFootprintList(fpSet.getFootprints())
        self._interpolateDefectList(exposure, defectList)
 

Member Data Documentation

_DefaultName

str lsst.meas.algorithms.reinterpolate_pixels.ReinterpolatePixelsTask._DefaultName = "reinterpolatePixels"

staticprotected

Definition at line 53 of file reinterpolate_pixels.py.

ConfigClass

lsst.meas.algorithms.reinterpolate_pixels.ReinterpolatePixelsTask.ConfigClass = ReinterpolatePixelsConfig

static

Definition at line 52 of file reinterpolate_pixels.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/g0603fd7c41+022847dfd1/python/lsst/meas/algorithms/reinterpolate_pixels.py