MaskObjectsTask#

class lsst.pipe.tasks.background.MaskObjectsTask(*args, **kwargs)#

Bases: Task

Iterative masking of objects on an Exposure

This task makes more exhaustive object mask by iteratively doing detection and background-subtraction. The purpose of this task is to get true background removing faint tails of large objects. This is useful to get a clean sky estimate from relatively small number of visits.

We deliberately use the specified detectSigma instead of the PSF, in order to better pick up the faint wings of objects.

Methods Summary

findObjects(exposure)

Iteratively find objects on an exposure

removeObjects(exposure[, maskPlanes])

Remove objects from exposure

run(exposure[, maskPlanes])

Mask objects on Exposure

Methods Documentation

findObjects(exposure)#

Iteratively find objects on an exposure

Objects are masked with the DETECTED mask plane.

Parameters#

exposurelsst.afw.image.Exposure

Exposure on which to mask objects.

removeObjects(exposure, maskPlanes=None)#

Remove objects from exposure

We interpolate over using a background model if doInterpolate is set; otherwise we simply replace everything with the median.

Parameters#

exposurelsst.afw.image.Exposure

Exposure on which to mask objects.

maskPlanesiterable of str, optional

List of mask planes to remove. DETECTED will be added as well.

run(exposure, maskPlanes=None)#

Mask objects on Exposure

Objects are found and removed.

Parameters#

exposurelsst.afw.image.Exposure

Exposure on which to mask objects.

maskPlanesiterable of str, optional

List of mask planes to remove.