Inheritance diagram for lsst.pipe.drivers.background.MaskObjectsTask:

Public Member Functions
def	__init__ (self, args, *kwargs)

def	run (self, exposure, maskPlanes=None)

def	findObjects (self, exposure)

def	removeObjects (self, exposure, maskPlanes=None)

Static Public Attributes
	ConfigClass = MaskObjectsConfig

Detailed Description

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.

Definition at line 770 of file background.py.

Constructor & Destructor Documentation

◆ init()

def lsst.pipe.drivers.background.MaskObjectsTask.__init__	(		self,
		*	args,
		**	kwargs
	)

Definition at line 783 of file background.py.

     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         # Disposable schema suppresses warning from SourceDetectionTask.__init__
         self.makeSubtask("detection", schema=afwTable.Schema())
         self.makeSubtask("interpolate")
         self.makeSubtask("subtractBackground")
  

Member Function Documentation

◆ findObjects()

def lsst.pipe.drivers.background.MaskObjectsTask.findObjects	(	self,
		exposure
	)

Iteratively find objects on an exposure

Objects are masked with the ``DETECTED`` mask plane.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure on which to mask objects.

Definition at line 805 of file background.py.

     def findObjects(self, exposure):
         """Iteratively find objects on an exposure
  
         Objects are masked with the ``DETECTED`` mask plane.
  
         Parameters
         ----------
         exposure : `lsst.afw.image.Exposure`
             Exposure on which to mask objects.
         """
         for _ in range(self.config.nIter):
             bg = self.subtractBackground.run(exposure).background
             self.detection.detectFootprints(exposure, sigma=self.config.detectSigma, clearMask=True)
             exposure.maskedImage += bg.getImage()
  

◆ removeObjects()

def lsst.pipe.drivers.background.MaskObjectsTask.removeObjects	(	self,
		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
----------
exposure : `lsst.afw.image.Exposure`
    Exposure on which to mask objects.
maskPlanes : iterable of `str`, optional
    List of mask planes to remove. ``DETECTED`` will be added as well.

Definition at line 820 of file background.py.

     def removeObjects(self, 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
         ----------
         exposure : `lsst.afw.image.Exposure`
             Exposure on which to mask objects.
         maskPlanes : iterable of `str`, optional
             List of mask planes to remove. ``DETECTED`` will be added as well.
         """
         image = exposure.image
         mask = exposure.mask
         maskVal = mask.getPlaneBitMask("DETECTED")
         if maskPlanes is not None:
             maskVal |= mask.getPlaneBitMask(maskPlanes)
         isBad = mask.array & maskVal > 0
  
         if self.config.doInterpolate:
             smooth = self.interpolate.fitBackground(exposure.maskedImage)
             replace = smooth.getImageF().array[isBad]
             mask.array &= ~mask.getPlaneBitMask(["DETECTED"])
         else:
             replace = numpy.median(image.array[~isBad])
         image.array[isBad] = replace
  
  

◆ run()

def lsst.pipe.drivers.background.MaskObjectsTask.run	(	self,
		exposure,
		maskPlanes = `None`
	)

Mask objects on Exposure

Objects are found and removed.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure on which to mask objects.
maskPlanes : iterable of `str`, optional
    List of mask planes to remove.

Definition at line 790 of file background.py.

     def run(self, exposure, maskPlanes=None):
         """Mask objects on Exposure
  
         Objects are found and removed.
  
         Parameters
         ----------
         exposure : `lsst.afw.image.Exposure`
             Exposure on which to mask objects.
         maskPlanes : iterable of `str`, optional
             List of mask planes to remove.
         """
         self.findObjects(exposure)
         self.removeObjects(exposure, maskPlanes)
  

Member Data Documentation

◆ ConfigClass

lsst.pipe.drivers.background.MaskObjectsTask.ConfigClass = MaskObjectsConfig

static

Definition at line 781 of file background.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/pipe_drivers/22.0.0+a28f4c53b1/python/lsst/pipe/drivers/background.py

Public Member Functions

Static Public Attributes