Inheritance diagram for lsst.pipe.tasks.assembleCoadd.AssembleCoaddTask:

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

def	getOutputDatasetTypes (cls, config)

def	getInputDatasetTypes (cls, config)

def	getPrerequisiteDatasetTypes (cls, config)

def	adaptArgsAndRun (self, inputData, inputDataIds, outputDataIds, butler)

def	runDataRef (self, dataRef, selectDataList=None, warpRefList=None)

def	processResults (self, coaddExposure, dataRef)

def	makeSupplementaryData (self, dataRef, selectDataList=None, warpRefList=None)

def	makeSupplementaryDataGen3 (self, inputData, inputDataIds, outputDataIds, butler)

def	getTempExpRefList (self, patchRef, calExpRefList)

def	prepareInputs (self, refList)

def	prepareStats (self, mask=None)

def	run (self, skyInfo, tempExpRefList, imageScalerList, weightList, altMaskList=None, mask=None, supplementaryData=None)

def	assembleMetadata (self, coaddExposure, tempExpRefList, weightList)

def	assembleSubregion (self, coaddExposure, bbox, tempExpRefList, imageScalerList, weightList, altMaskList, statsFlags, statsCtrl, nImage=None)

def	removeMaskPlanes (self, maskedImage)

def	applyAltMaskPlanes (self, mask, altMaskSpans)

def	shrinkValidPolygons (self, coaddInputs)

def	readBrightObjectMasks (self, dataRef)

def	setBrightObjectMasks (self, exposure, dataId, brightObjectMasks)

def	setInexactPsf (self, mask)

def	selectExposures (self, patchRef, skyInfo=None, selectDataList=[])
	Select exposures to coadd. More...

def	getSkyInfo (self, patchRef)
	Use getSkyinfo to return the skyMap, tract and patch information, wcs and the outer bbox of the patch. More...

def	getCoaddDatasetName (self, warpType="direct")

def	getTempExpDatasetName (self, warpType="direct")

def	getBadPixelMask (self)
	Convenience method to provide the bitmask from the mask plane names. More...

Static Public Member Functions
def	setRejectedMaskMapping (statsCtrl)

Public Attributes
	brightObjectBitmask

	warpType

Static Public Attributes
	ConfigClass = AssembleCoaddConfig

	RunnerClass = CoaddTaskRunner

Detailed Description

Assemble a coadded image from a set of warps (coadded temporary exposures).

We want to assemble a coadded image from a set of Warps (also called
coadded temporary exposures or ``coaddTempExps``).
Each input Warp covers a patch on the sky and corresponds to a single
run/visit/exposure of the covered patch. We provide the task with a list
of Warps (``selectDataList``) from which it selects Warps that cover the
specified patch (pointed at by ``dataRef``).
Each Warp that goes into a coadd will typically have an independent
photometric zero-point. Therefore, we must scale each Warp to set it to
a common photometric zeropoint. WarpType may be one of 'direct' or
'psfMatched', and the boolean configs `config.makeDirect` and
`config.makePsfMatched` set which of the warp types will be coadded.
The coadd is computed as a mean with optional outlier rejection.
Criteria for outlier rejection are set in `AssembleCoaddConfig`.
Finally, Warps can have bad 'NaN' pixels which received no input from the
source calExps. We interpolate over these bad (NaN) pixels.

`AssembleCoaddTask` uses several sub-tasks. These are

- `ScaleZeroPointTask`
- create and use an ``imageScaler`` object to scale the photometric zeropoint for each Warp
- `InterpImageTask`
- interpolate across bad pixels (NaN) in the final coadd

You can retarget these subtasks if you wish.

Notes
-----
The `lsst.pipe.base.cmdLineTask.CmdLineTask` interface supports a
flag ``-d`` to import ``debug.py`` from your ``PYTHONPATH``; see
`baseDebug` for more about ``debug.py`` files. `AssembleCoaddTask` has
no debug variables of its own. Some of the subtasks may support debug
variables. See the documentation for the subtasks for further information.

Examples
--------
`AssembleCoaddTask` assembles a set of warped images into a coadded image.
The `AssembleCoaddTask` can be invoked by running ``assembleCoadd.py``
with the flag '--legacyCoadd'. Usage of assembleCoadd.py expects two
inputs: a data reference to the tract patch and filter to be coadded, and
a list of Warps to attempt to coadd. These are specified using ``--id`` and
``--selectId``, respectively:

.. code-block:: none

   --id = [KEY=VALUE1[^VALUE2[^VALUE3...] [KEY=VALUE1[^VALUE2[^VALUE3...] ...]]
   --selectId [KEY=VALUE1[^VALUE2[^VALUE3...] [KEY=VALUE1[^VALUE2[^VALUE3...] ...]]

Only the Warps that cover the specified tract and patch will be coadded.
A list of the available optional arguments can be obtained by calling
``assembleCoadd.py`` with the ``--help`` command line argument:

.. code-block:: none

   assembleCoadd.py --help

To demonstrate usage of the `AssembleCoaddTask` in the larger context of
multi-band processing, we will generate the HSC-I & -R band coadds from
HSC engineering test data provided in the ``ci_hsc`` package. To begin,
assuming that the lsst stack has been already set up, we must set up the
obs_subaru and ``ci_hsc`` packages. This defines the environment variable
``$CI_HSC_DIR`` and points at the location of the package. The raw HSC
data live in the ``$CI_HSC_DIR/raw directory``. To begin assembling the
coadds, we must first

- processCcd
- process the individual ccds in $CI_HSC_RAW to produce calibrated exposures
- makeSkyMap
- create a skymap that covers the area of the sky present in the raw exposures
- makeCoaddTempExp
- warp the individual calibrated exposures to the tangent plane of the coadd

We can perform all of these steps by running

.. code-block:: none

   $CI_HSC_DIR scons warp-903986 warp-904014 warp-903990 warp-904010 warp-903988

This will produce warped exposures for each visit. To coadd the warped
data, we call assembleCoadd.py as follows:

.. code-block:: none

   assembleCoadd.py --legacyCoadd $CI_HSC_DIR/DATA --id patch=5,4 tract=0 filter=HSC-I \
   --selectId visit=903986 ccd=16 --selectId visit=903986 ccd=22 --selectId visit=903986 ccd=23 \
   --selectId visit=903986 ccd=100 --selectId visit=904014 ccd=1 --selectId visit=904014 ccd=6 \
   --selectId visit=904014 ccd=12 --selectId visit=903990 ccd=18 --selectId visit=903990 ccd=25 \
   --selectId visit=904010 ccd=4 --selectId visit=904010 ccd=10 --selectId visit=904010 ccd=100 \
   --selectId visit=903988 ccd=16 --selectId visit=903988 ccd=17 --selectId visit=903988 ccd=23 \
   --selectId visit=903988 ccd=24

that will process the HSC-I band data. The results are written in
``$CI_HSC_DIR/DATA/deepCoadd-results/HSC-I``.

You may also choose to run:

.. code-block:: none

   scons warp-903334 warp-903336 warp-903338 warp-903342 warp-903344 warp-903346
   assembleCoadd.py --legacyCoadd $CI_HSC_DIR/DATA --id patch=5,4 tract=0 filter=HSC-R \
   --selectId visit=903334 ccd=16 --selectId visit=903334 ccd=22 --selectId visit=903334 ccd=23 \
   --selectId visit=903334 ccd=100 --selectId visit=903336 ccd=17 --selectId visit=903336 ccd=24 \
   --selectId visit=903338 ccd=18 --selectId visit=903338 ccd=25 --selectId visit=903342 ccd=4 \
   --selectId visit=903342 ccd=10 --selectId visit=903342 ccd=100 --selectId visit=903344 ccd=0 \
   --selectId visit=903344 ccd=5 --selectId visit=903344 ccd=11 --selectId visit=903346 ccd=1 \
   --selectId visit=903346 ccd=6 --selectId visit=903346 ccd=12

to generate the coadd for the HSC-R band if you are interested in
following multiBand Coadd processing as discussed in `pipeTasks_multiBand`
(but note that normally, one would use the `SafeClipAssembleCoaddTask`
rather than `AssembleCoaddTask` to make the coadd.

Definition at line 228 of file assembleCoadd.py.

Constructor & Destructor Documentation

◆ init()

def lsst.pipe.tasks.assembleCoadd.AssembleCoaddTask.__init__	(	self,
		args,
		kwargs
	)

Definition at line 345 of file assembleCoadd.py.

     def __init__(self, *args, **kwargs):
         # TODO: DM-17415 better way to handle previously allowed passed args e.g.`AssembleCoaddTask(config)`
         if args:
             argNames = ["config", "name", "parentTask", "log"]
             kwargs.update({k: v for k, v in zip(argNames, args)})
             warnings.warn("AssembleCoadd received positional args, and casting them as kwargs: %s. "
                           "PipelineTask will not take positional args" % argNames, FutureWarning)
 
         super().__init__(**kwargs)
         self.makeSubtask("interpImage")
         self.makeSubtask("scaleZeroPoint")
 
         if self.config.doMaskBrightObjects:
             mask = afwImage.Mask()
             try:
                 self.brightObjectBitmask = 1 << mask.addMaskPlane(self.config.brightObjectMaskName)
             except pexExceptions.LsstCppException:
                 raise RuntimeError("Unable to define mask plane for bright objects; planes used are %s" %
                                    mask.getMaskPlaneDict().keys())
             del mask
 
         self.warpType = self.config.warpType
 

Member Function Documentation

◆ adaptArgsAndRun()

def lsst.pipe.tasks.assembleCoadd.AssembleCoaddTask.adaptArgsAndRun	(	self,
		inputData,
		inputDataIds,
		outputDataIds,
		butler
	)

Assemble a coadd from a set of Warps.

PipelineTask (Gen3) entry point to Coadd a set of Warps.
Analogous to `runDataRef`, it prepares all the data products to be
passed to `run`, and processes the results before returning to struct
of results to be written out. AssembleCoadd cannot fit all Warps in memory.
Therefore, its inputs are accessed subregion by subregion
by the `lsst.daf.butler.ShimButler` that quacks like a Gen2
`lsst.daf.persistence.Butler`. Updates to this method should
correspond to an update in `runDataRef` while both entry points
are used.

Parameters
----------
inputData : `dict`
    Keys are the names of the configs describing input dataset types.
    Values are input Python-domain data objects (or lists of objects)
    retrieved from data butler.
inputDataIds : `dict`
    Keys are the names of the configs describing input dataset types.
    Values are DataIds (or lists of DataIds) that task consumes for
    corresponding dataset type.
outputDataIds : `dict`
    Keys are the names of the configs describing input dataset types.
    Values are DataIds (or lists of DataIds) that task is to produce
    for corresponding dataset type.
butler : `lsst.daf.butler.Butler`
    Gen3 Butler object for fetching additional data products before
    running the Task

Returns
-------
result : `lsst.pipe.base.Struct`
   Result struct with components:

   - ``coaddExposure`` : coadded exposure (``lsst.afw.image.Exposure``)
   - ``nImage``: N Image (``lsst.afw.image.Image``)

Definition at line 394 of file assembleCoadd.py.

     def adaptArgsAndRun(self, inputData, inputDataIds, outputDataIds, butler):
         """Assemble a coadd from a set of Warps.
 
         PipelineTask (Gen3) entry point to Coadd a set of Warps.
         Analogous to `runDataRef`, it prepares all the data products to be
         passed to `run`, and processes the results before returning to struct
         of results to be written out. AssembleCoadd cannot fit all Warps in memory.
         Therefore, its inputs are accessed subregion by subregion
         by the `lsst.daf.butler.ShimButler` that quacks like a Gen2
         `lsst.daf.persistence.Butler`. Updates to this method should
         correspond to an update in `runDataRef` while both entry points
         are used.
 
         Parameters
         ----------
         inputData : `dict`
             Keys are the names of the configs describing input dataset types.
             Values are input Python-domain data objects (or lists of objects)
             retrieved from data butler.
         inputDataIds : `dict`
             Keys are the names of the configs describing input dataset types.
             Values are DataIds (or lists of DataIds) that task consumes for
             corresponding dataset type.
         outputDataIds : `dict`
             Keys are the names of the configs describing input dataset types.
             Values are DataIds (or lists of DataIds) that task is to produce
             for corresponding dataset type.
         butler : `lsst.daf.butler.Butler`
             Gen3 Butler object for fetching additional data products before
             running the Task
 
         Returns
         -------
         result : `lsst.pipe.base.Struct`
            Result struct with components:
 
            - ``coaddExposure`` : coadded exposure (``lsst.afw.image.Exposure``)
            - ``nImage``: N Image (``lsst.afw.image.Image``)
         """
         # Construct skyInfo expected by run
         # Do not remove skyMap from inputData in case makeSupplementaryDataGen3 needs it
         skyMap = inputData["skyMap"]
         outputDataId = next(iter(outputDataIds.values()))
         inputData['skyInfo'] = makeSkyInfo(skyMap,
                                            tractId=outputDataId['tract'],
                                            patchId=outputDataId['patch'])
 
         # Construct list of input Shim DataRefs that quack like Gen2 DataRefs
         butlerShim = ShimButler(butler)
         warpRefList = [butlerShim.dataRef(self.config.inputWarps.name, dataId=dataId)
                        for dataId in inputDataIds['inputWarps']]
 
         # Construct output Shim DataRef
         patchRef = butlerShim.dataRef(self.config.coaddExposure.name, dataId=outputDataIds['coaddExposure'])
 
         # Perform same middle steps as `runDataRef` does
         inputs = self.prepareInputs(warpRefList)
         self.log.info("Found %d %s", len(inputs.tempExpRefList),
                       self.getTempExpDatasetName(self.warpType))
         if len(inputs.tempExpRefList) == 0:
             self.log.warn("No coadd temporary exposures found")
             return
 
         supplementaryData = self.makeSupplementaryDataGen3(inputData, inputDataIds, outputDataIds, butler)
 
         retStruct = self.run(inputData['skyInfo'], inputs.tempExpRefList, inputs.imageScalerList,
                              inputs.weightList, supplementaryData=supplementaryData)
 
         self.processResults(retStruct.coaddExposure, patchRef)
         return retStruct
 

◆ applyAltMaskPlanes()

def lsst.pipe.tasks.assembleCoadd.AssembleCoaddTask.applyAltMaskPlanes	(	self,
		mask,
		altMaskSpans
	)

Apply in place alt mask formatted as SpanSets to a mask.

Parameters
----------
mask : `lsst.afw.image.Mask`
    Original mask.
altMaskSpans : `dict`
    SpanSet lists to apply. Each element contains the new mask
    plane name (e.g. "CLIPPED and/or "NO_DATA") as the key,
    and list of SpanSets to apply to the mask.

Returns
-------
mask : `lsst.afw.image.Mask`
    Updated mask.

Definition at line 984 of file assembleCoadd.py.

     def applyAltMaskPlanes(self, mask, altMaskSpans):
         """Apply in place alt mask formatted as SpanSets to a mask.
 
         Parameters
         ----------
         mask : `lsst.afw.image.Mask`
             Original mask.
         altMaskSpans : `dict`
             SpanSet lists to apply. Each element contains the new mask
             plane name (e.g. "CLIPPED and/or "NO_DATA") as the key,
             and list of SpanSets to apply to the mask.
 
         Returns
         -------
         mask : `lsst.afw.image.Mask`
             Updated mask.
         """
         if self.config.doUsePsfMatchedPolygons:
             if ("NO_DATA" in altMaskSpans) and ("NO_DATA" in self.config.badMaskPlanes):
                 # Clear away any other masks outside the validPolygons. These pixels are no longer
                 # contributing to inexact PSFs, and will still be rejected because of NO_DATA
                 # self.config.doUsePsfMatchedPolygons should be True only in CompareWarpAssemble
                 # This mask-clearing step must only occur *before* applying the new masks below
                 for spanSet in altMaskSpans['NO_DATA']:
                     spanSet.clippedTo(mask.getBBox()).clearMask(mask, self.getBadPixelMask())
 
         for plane, spanSetList in altMaskSpans.items():
             maskClipValue = mask.addMaskPlane(plane)
             for spanSet in spanSetList:
                 spanSet.clippedTo(mask.getBBox()).setMask(mask, 2**maskClipValue)
         return mask
 

◆ assembleMetadata()

def lsst.pipe.tasks.assembleCoadd.AssembleCoaddTask.assembleMetadata	(	self,
		coaddExposure,
		tempExpRefList,
		weightList
	)

Set the metadata for the coadd.

This basic implementation sets the filter from the first input.

Parameters
----------
coaddExposure : `lsst.afw.image.Exposure`
    The target exposure for the coadd.
tempExpRefList : `list`
    List of data references to tempExp.
weightList : `list`
    List of weights.

Definition at line 813 of file assembleCoadd.py.

     def assembleMetadata(self, coaddExposure, tempExpRefList, weightList):
         """Set the metadata for the coadd.
 
         This basic implementation sets the filter from the first input.
 
         Parameters
         ----------
         coaddExposure : `lsst.afw.image.Exposure`
             The target exposure for the coadd.
         tempExpRefList : `list`
             List of data references to tempExp.
         weightList : `list`
             List of weights.
         """
         assert len(tempExpRefList) == len(weightList), "Length mismatch"
         tempExpName = self.getTempExpDatasetName(self.warpType)
         # We load a single pixel of each coaddTempExp, because we just want to get at the metadata
         # (and we need more than just the PropertySet that contains the header), which is not possible
         # with the current butler (see #2777).
         tempExpList = [tempExpRef.get(tempExpName + "_sub",
                                       bbox=geom.Box2I(coaddExposure.getBBox().getMin(),
                                                       geom.Extent2I(1, 1)), immediate=True)
                        for tempExpRef in tempExpRefList]
         numCcds = sum(len(tempExp.getInfo().getCoaddInputs().ccds) for tempExp in tempExpList)
 
         coaddExposure.setFilter(tempExpList[0].getFilter())
         coaddInputs = coaddExposure.getInfo().getCoaddInputs()
         coaddInputs.ccds.reserve(numCcds)
         coaddInputs.visits.reserve(len(tempExpList))
 
         for tempExp, weight in zip(tempExpList, weightList):
             self.inputRecorder.addVisitToCoadd(coaddInputs, tempExp, weight)
 
         if self.config.doUsePsfMatchedPolygons:
             self.shrinkValidPolygons(coaddInputs)
 
         coaddInputs.visits.sort()
         if self.warpType == "psfMatched":
             # The modelPsf BBox for a psfMatchedWarp/coaddTempExp was dynamically defined by
             # ModelPsfMatchTask as the square box bounding its spatially-variable, pre-matched WarpedPsf.
             # Likewise, set the PSF of a PSF-Matched Coadd to the modelPsf
             # having the maximum width (sufficient because square)
             modelPsfList = [tempExp.getPsf() for tempExp in tempExpList]
             modelPsfWidthList = [modelPsf.computeBBox().getWidth() for modelPsf in modelPsfList]
             psf = modelPsfList[modelPsfWidthList.index(max(modelPsfWidthList))]
         else:
             psf = measAlg.CoaddPsf(coaddInputs.ccds, coaddExposure.getWcs(),
                                    self.config.coaddPsf.makeControl())
         coaddExposure.setPsf(psf)
         apCorrMap = measAlg.makeCoaddApCorrMap(coaddInputs.ccds, coaddExposure.getBBox(afwImage.PARENT),
                                                coaddExposure.getWcs())
         coaddExposure.getInfo().setApCorrMap(apCorrMap)
         if self.config.doAttachTransmissionCurve:
             transmissionCurve = measAlg.makeCoaddTransmissionCurve(coaddExposure.getWcs(), coaddInputs.ccds)
             coaddExposure.getInfo().setTransmissionCurve(transmissionCurve)
 

◆ assembleSubregion()

def lsst.pipe.tasks.assembleCoadd.AssembleCoaddTask.assembleSubregion	(	self,
		coaddExposure,
		bbox,
		tempExpRefList,
		imageScalerList,
		weightList,
		altMaskList,
		statsFlags,
		statsCtrl,
		nImage = `None`
	)

Assemble the coadd for a sub-region.

For each coaddTempExp, check for (and swap in) an alternative mask
if one is passed. Remove mask planes listed in
`config.removeMaskPlanes`. Finally, stack the actual exposures using
`lsst.afw.math.statisticsStack` with the statistic specified by
statsFlags. Typically, the statsFlag will be one of lsst.afw.math.MEAN for
a mean-stack or `lsst.afw.math.MEANCLIP` for outlier rejection using
an N-sigma clipped mean where N and iterations are specified by
statsCtrl.  Assign the stacked subregion back to the coadd.

Parameters
----------
coaddExposure : `lsst.afw.image.Exposure`
    The target exposure for the coadd.
bbox : `lsst.geom.Box`
    Sub-region to coadd.
tempExpRefList : `list`
    List of data reference to tempExp.
imageScalerList : `list`
    List of image scalers.
weightList : `list`
    List of weights.
altMaskList : `list`
    List of alternate masks to use rather than those stored with
    tempExp, or None.  Each element is dict with keys = mask plane
    name to which to add the spans.
statsFlags : `lsst.afw.math.Property`
    Property object for statistic for coadd.
statsCtrl : `lsst.afw.math.StatisticsControl`
    Statistics control object for coadd.
nImage : `lsst.afw.image.ImageU`, optional
    Keeps track of exposure count for each pixel.

Definition at line 870 of file assembleCoadd.py.

                           altMaskList, statsFlags, statsCtrl, nImage=None):
         """Assemble the coadd for a sub-region.
 
         For each coaddTempExp, check for (and swap in) an alternative mask
         if one is passed. Remove mask planes listed in
         `config.removeMaskPlanes`. Finally, stack the actual exposures using
         `lsst.afw.math.statisticsStack` with the statistic specified by
         statsFlags. Typically, the statsFlag will be one of lsst.afw.math.MEAN for
         a mean-stack or `lsst.afw.math.MEANCLIP` for outlier rejection using
         an N-sigma clipped mean where N and iterations are specified by
         statsCtrl.  Assign the stacked subregion back to the coadd.
 
         Parameters
         ----------
         coaddExposure : `lsst.afw.image.Exposure`
             The target exposure for the coadd.
         bbox : `lsst.geom.Box`
             Sub-region to coadd.
         tempExpRefList : `list`
             List of data reference to tempExp.
         imageScalerList : `list`
             List of image scalers.
         weightList : `list`
             List of weights.
         altMaskList : `list`
             List of alternate masks to use rather than those stored with
             tempExp, or None.  Each element is dict with keys = mask plane
             name to which to add the spans.
         statsFlags : `lsst.afw.math.Property`
             Property object for statistic for coadd.
         statsCtrl : `lsst.afw.math.StatisticsControl`
             Statistics control object for coadd.
         nImage : `lsst.afw.image.ImageU`, optional
             Keeps track of exposure count for each pixel.
         """
         self.log.debug("Computing coadd over %s", bbox)
         tempExpName = self.getTempExpDatasetName(self.warpType)
         coaddExposure.mask.addMaskPlane("REJECTED")
         coaddExposure.mask.addMaskPlane("CLIPPED")
         coaddExposure.mask.addMaskPlane("SENSOR_EDGE")
         maskMap = self.setRejectedMaskMapping(statsCtrl)
         clipped = afwImage.Mask.getPlaneBitMask("CLIPPED")
         maskedImageList = []
         if nImage is not None:
             subNImage = afwImage.ImageU(bbox.getWidth(), bbox.getHeight())
         for tempExpRef, imageScaler, altMask in zip(tempExpRefList, imageScalerList, altMaskList):
             exposure = tempExpRef.get(tempExpName + "_sub", bbox=bbox)
             maskedImage = exposure.getMaskedImage()
             mask = maskedImage.getMask()
             if altMask is not None:
                 self.applyAltMaskPlanes(mask, altMask)
             imageScaler.scaleMaskedImage(maskedImage)
 
             # Add 1 for each pixel which is not excluded by the exclude mask.
             # In legacyCoadd, pixels may also be excluded by afwMath.statisticsStack.
             if nImage is not None:
                 subNImage.getArray()[maskedImage.getMask().getArray() & statsCtrl.getAndMask() == 0] += 1
             if self.config.removeMaskPlanes:
                 self.removeMaskPlanes(maskedImage)
             maskedImageList.append(maskedImage)
 
         with self.timer("stack"):
             coaddSubregion = afwMath.statisticsStack(maskedImageList, statsFlags, statsCtrl, weightList,
                                                      clipped,  # also set output to CLIPPED if sigma-clipped
                                                      maskMap)
         coaddExposure.maskedImage.assign(coaddSubregion, bbox)
         if nImage is not None:
             nImage.assign(subNImage, bbox)
 

◆ getBadPixelMask()

def lsst.pipe.tasks.coaddBase.CoaddBaseTask.getBadPixelMask ( self )

inherited

Convenience method to provide the bitmask from the mask plane names.

Definition at line 200 of file coaddBase.py.

     def getBadPixelMask(self):
         """!
         @brief Convenience method to provide the bitmask from the mask plane names
         """
         return afwImage.Mask.getPlaneBitMask(self.config.badMaskPlanes)
 
 

◆ getCoaddDatasetName()

def lsst.pipe.tasks.coaddBase.CoaddBaseTask.getCoaddDatasetName	(	self,
		warpType = `"direct"`
	)

inherited

Return coadd name for given warpType and task config

Parameters
----------
warpType : string
    Either 'direct' or 'psfMatched'

Returns
-------
CoaddDatasetName : `string`

Definition at line 150 of file coaddBase.py.

     def getCoaddDatasetName(self, warpType="direct"):
         """Return coadd name for given warpType and task config
 
         Parameters
         ----------
         warpType : string
             Either 'direct' or 'psfMatched'
 
         Returns
         -------
         CoaddDatasetName : `string`
         """
         suffix = "" if warpType == "direct" else warpType[0].upper() + warpType[1:]
         return self.config.coaddName + "Coadd" + suffix
 

◆ getInputDatasetTypes()

def lsst.pipe.tasks.assembleCoadd.AssembleCoaddTask.getInputDatasetTypes	(	cls,
		config
	)

Return input dataset type descriptors

Remove input dataset types not used by the Task

Definition at line 380 of file assembleCoadd.py.

     def getInputDatasetTypes(cls, config):
         """Return input dataset type descriptors
 
         Remove input dataset types not used by the Task
         """
         inputTypeDict = super().getInputDatasetTypes(config)
         if not config.doMaskBrightObjects:
             inputTypeDict.pop("brightObjectMask", None)
         return inputTypeDict
 

◆ getOutputDatasetTypes()

def lsst.pipe.tasks.assembleCoadd.AssembleCoaddTask.getOutputDatasetTypes	(	cls,
		config
	)

Return output dataset type descriptors

Remove output dataset types not produced by the Task

Definition at line 369 of file assembleCoadd.py.

     def getOutputDatasetTypes(cls, config):
         """Return output dataset type descriptors
 
         Remove output dataset types not produced by the Task
         """
         outputTypeDict = super().getOutputDatasetTypes(config)
         if not config.doNImage:
             outputTypeDict.pop("nImage", None)
         return outputTypeDict
 

◆ getPrerequisiteDatasetTypes()

def lsst.pipe.tasks.assembleCoadd.AssembleCoaddTask.getPrerequisiteDatasetTypes	(	cls,
		config
	)

Definition at line 391 of file assembleCoadd.py.

     def getPrerequisiteDatasetTypes(cls, config):
         return frozenset(["brightObjectMask"])
 

◆ getSkyInfo()

def lsst.pipe.tasks.coaddBase.CoaddBaseTask.getSkyInfo	(	self,
		patchRef
	)

inherited

Use getSkyinfo to return the skyMap, tract and patch information, wcs and the outer bbox of the patch.

Parameters

[in] patchRef data reference for sky map. Must include keys "tract" and "patch"

Returns

pipe_base Struct containing:

skyMap: sky map
tractInfo: information for chosen tract of sky map
patchInfo: information about chosen patch of tract
wcs: WCS of tract
bbox: outer bbox of patch, as an geom Box2I

Definition at line 134 of file coaddBase.py.

     def getSkyInfo(self, patchRef):
         """!
         @brief Use @ref getSkyinfo to return the skyMap, tract and patch information, wcs and the outer bbox
         of the patch.
 
         @param[in] patchRef  data reference for sky map. Must include keys "tract" and "patch"
 
         @return pipe_base Struct containing:
         - skyMap: sky map
         - tractInfo: information for chosen tract of sky map
         - patchInfo: information about chosen patch of tract
         - wcs: WCS of tract
         - bbox: outer bbox of patch, as an geom Box2I
         """
         return getSkyInfo(coaddName=self.config.coaddName, patchRef=patchRef)
 

◆ getTempExpDatasetName()

def lsst.pipe.tasks.coaddBase.CoaddBaseTask.getTempExpDatasetName	(	self,
		warpType = `"direct"`
	)

inherited

Return warp name for given warpType and task config

Parameters
----------
warpType : string
    Either 'direct' or 'psfMatched'

Returns
-------
WarpDatasetName : `string`

Definition at line 165 of file coaddBase.py.

     def getTempExpDatasetName(self, warpType="direct"):
         """Return warp name for given warpType and task config
 
         Parameters
         ----------
         warpType : string
             Either 'direct' or 'psfMatched'
 
         Returns
         -------
         WarpDatasetName : `string`
         """
         return self.config.coaddName + "Coadd_" + warpType + "Warp"
 

◆ getTempExpRefList()

def lsst.pipe.tasks.assembleCoadd.AssembleCoaddTask.getTempExpRefList	(	self,
		patchRef,
		calExpRefList
	)

Generate list data references corresponding to warped exposures
that lie within the patch to be coadded.

Parameters
----------
patchRef : `dataRef`
    Data reference for patch.
calExpRefList : `list`
    List of data references for input calexps.

Returns
-------
tempExpRefList : `list`
    List of Warp/CoaddTempExp data references.

Definition at line 612 of file assembleCoadd.py.

     def getTempExpRefList(self, patchRef, calExpRefList):
         """Generate list data references corresponding to warped exposures
         that lie within the patch to be coadded.
 
         Parameters
         ----------
         patchRef : `dataRef`
             Data reference for patch.
         calExpRefList : `list`
             List of data references for input calexps.
 
         Returns
         -------
         tempExpRefList : `list`
             List of Warp/CoaddTempExp data references.
         """
         butler = patchRef.getButler()
         groupData = groupPatchExposures(patchRef, calExpRefList, self.getCoaddDatasetName(self.warpType),
                                         self.getTempExpDatasetName(self.warpType))
         tempExpRefList = [getGroupDataRef(butler, self.getTempExpDatasetName(self.warpType),
                                           g, groupData.keys) for
                           g in groupData.groups.keys()]
         return tempExpRefList
 

◆ makeSupplementaryData()

def lsst.pipe.tasks.assembleCoadd.AssembleCoaddTask.makeSupplementaryData	(	self,
		dataRef,
		selectDataList = `None`,
		warpRefList = `None`
	)

Make additional inputs to run() specific to subclasses (Gen2)

Duplicates interface of `runDataRef` method
Available to be implemented by subclasses only if they need the
coadd dataRef for performing preliminary processing before
assembling the coadd.

Parameters
----------
dataRef : `lsst.daf.persistence.ButlerDataRef`
    Butler data reference for supplementary data.
selectDataList : `list`
    List of data references to Warps.

Definition at line 561 of file assembleCoadd.py.

     def makeSupplementaryData(self, dataRef, selectDataList=None, warpRefList=None):
         """Make additional inputs to run() specific to subclasses (Gen2)
 
         Duplicates interface of `runDataRef` method
         Available to be implemented by subclasses only if they need the
         coadd dataRef for performing preliminary processing before
         assembling the coadd.
 
         Parameters
         ----------
         dataRef : `lsst.daf.persistence.ButlerDataRef`
             Butler data reference for supplementary data.
         selectDataList : `list`
             List of data references to Warps.
         """
         pass
 

◆ makeSupplementaryDataGen3()

def lsst.pipe.tasks.assembleCoadd.AssembleCoaddTask.makeSupplementaryDataGen3	(	self,
		inputData,
		inputDataIds,
		outputDataIds,
		butler
	)

Make additional inputs to run() specific to subclasses (Gen3)

Duplicates interface of`adaptArgsAndRun` method.
Available to be implemented by subclasses only if they need the
coadd dataRef for performing preliminary processing before
assembling the coadd.

Parameters
----------
inputData : `dict`
    Keys are the names of the configs describing input dataset types.
    Values are input Python-domain data objects (or lists of objects)
    retrieved from data butler.
inputDataIds : `dict`
    Keys are the names of the configs describing input dataset types.
    Values are DataIds (or lists of DataIds) that task consumes for
    corresponding dataset type.
    DataIds are guaranteed to match data objects in ``inputData``.
outputDataIds : `dict`
    Keys are the names of the configs describing input dataset types.
    Values are DataIds (or lists of DataIds) that task is to produce
    for corresponding dataset type.
butler : `lsst.daf.butler.Butler`
    Gen3 Butler object for fetching additional data products before
    running the Task

Returns
-------
result : `lsst.pipe.base.Struct`
    Contains whatever additional data the subclass's `run` method needs

Definition at line 578 of file assembleCoadd.py.

     def makeSupplementaryDataGen3(self, inputData, inputDataIds, outputDataIds, butler):
         """Make additional inputs to run() specific to subclasses (Gen3)
 
         Duplicates interface of`adaptArgsAndRun` method.
         Available to be implemented by subclasses only if they need the
         coadd dataRef for performing preliminary processing before
         assembling the coadd.
 
         Parameters
         ----------
         inputData : `dict`
             Keys are the names of the configs describing input dataset types.
             Values are input Python-domain data objects (or lists of objects)
             retrieved from data butler.
         inputDataIds : `dict`
             Keys are the names of the configs describing input dataset types.
             Values are DataIds (or lists of DataIds) that task consumes for
             corresponding dataset type.
             DataIds are guaranteed to match data objects in ``inputData``.
         outputDataIds : `dict`
             Keys are the names of the configs describing input dataset types.
             Values are DataIds (or lists of DataIds) that task is to produce
             for corresponding dataset type.
         butler : `lsst.daf.butler.Butler`
             Gen3 Butler object for fetching additional data products before
             running the Task
 
         Returns
         -------
         result : `lsst.pipe.base.Struct`
             Contains whatever additional data the subclass's `run` method needs
         """
         pass
 

◆ prepareInputs()

def lsst.pipe.tasks.assembleCoadd.AssembleCoaddTask.prepareInputs	(	self,
		refList
	)

Prepare the input warps for coaddition by measuring the weight for
each warp and the scaling for the photometric zero point.

Each Warp has its own photometric zeropoint and background variance.
Before coadding these Warps together, compute a scale factor to
normalize the photometric zeropoint and compute the weight for each Warp.

Parameters
----------
refList : `list`
    List of data references to tempExp

Returns
-------
result : `lsst.pipe.base.Struct`
   Result struct with components:

   - ``tempExprefList``: `list` of data references to tempExp.
   - ``weightList``: `list` of weightings.
   - ``imageScalerList``: `list` of image scalers.

Definition at line 636 of file assembleCoadd.py.

     def prepareInputs(self, refList):
         """Prepare the input warps for coaddition by measuring the weight for
         each warp and the scaling for the photometric zero point.
 
         Each Warp has its own photometric zeropoint and background variance.
         Before coadding these Warps together, compute a scale factor to
         normalize the photometric zeropoint and compute the weight for each Warp.
 
         Parameters
         ----------
         refList : `list`
             List of data references to tempExp
 
         Returns
         -------
         result : `lsst.pipe.base.Struct`
            Result struct with components:
 
            - ``tempExprefList``: `list` of data references to tempExp.
            - ``weightList``: `list` of weightings.
            - ``imageScalerList``: `list` of image scalers.
         """
         statsCtrl = afwMath.StatisticsControl()
         statsCtrl.setNumSigmaClip(self.config.sigmaClip)
         statsCtrl.setNumIter(self.config.clipIter)
         statsCtrl.setAndMask(self.getBadPixelMask())
         statsCtrl.setNanSafe(True)
         # compute tempExpRefList: a list of tempExpRef that actually exist
         # and weightList: a list of the weight of the associated coadd tempExp
         # and imageScalerList: a list of scale factors for the associated coadd tempExp
         tempExpRefList = []
         weightList = []
         imageScalerList = []
         tempExpName = self.getTempExpDatasetName(self.warpType)
         for tempExpRef in refList:
             if not tempExpRef.datasetExists(tempExpName):
                 self.log.warn("Could not find %s %s; skipping it", tempExpName, tempExpRef.dataId)
                 continue
 
             tempExp = tempExpRef.get(tempExpName, immediate=True)
             # Ignore any input warp that is empty of data
             if numpy.isnan(tempExp.image.array).all():
                 continue
             maskedImage = tempExp.getMaskedImage()
             imageScaler = self.scaleZeroPoint.computeImageScaler(
                 exposure=tempExp,
                 dataRef=tempExpRef,
             )
             try:
                 imageScaler.scaleMaskedImage(maskedImage)
             except Exception as e:
                 self.log.warn("Scaling failed for %s (skipping it): %s", tempExpRef.dataId, e)
                 continue
             statObj = afwMath.makeStatistics(maskedImage.getVariance(), maskedImage.getMask(),
                                              afwMath.MEANCLIP, statsCtrl)
             meanVar, meanVarErr = statObj.getResult(afwMath.MEANCLIP)
             weight = 1.0 / float(meanVar)
             if not numpy.isfinite(weight):
                 self.log.warn("Non-finite weight for %s: skipping", tempExpRef.dataId)
                 continue
             self.log.info("Weight of %s %s = %0.3f", tempExpName, tempExpRef.dataId, weight)
 
             del maskedImage
             del tempExp
 
             tempExpRefList.append(tempExpRef)
             weightList.append(weight)
             imageScalerList.append(imageScaler)
 
         return pipeBase.Struct(tempExpRefList=tempExpRefList, weightList=weightList,
                                imageScalerList=imageScalerList)
 

◆ prepareStats()

def lsst.pipe.tasks.assembleCoadd.AssembleCoaddTask.prepareStats	(	self,
		mask = `None`
	)

Prepare the statistics for coadding images.

Parameters
----------
mask : `int`, optional
    Bit mask value to exclude from coaddition.

Returns
-------
stats : `lsst.pipe.base.Struct`
    Statistics structure with the following fields:

    - ``statsCtrl``: Statistics control object for coadd
(`lsst.afw.math.StatisticsControl`)
    - ``statsFlags``: Statistic for coadd (`lsst.afw.math.Property`)

Definition at line 708 of file assembleCoadd.py.

     def prepareStats(self, mask=None):
         """Prepare the statistics for coadding images.
 
         Parameters
         ----------
         mask : `int`, optional
             Bit mask value to exclude from coaddition.
 
         Returns
         -------
         stats : `lsst.pipe.base.Struct`
             Statistics structure with the following fields:
 
             - ``statsCtrl``: Statistics control object for coadd
                 (`lsst.afw.math.StatisticsControl`)
             - ``statsFlags``: Statistic for coadd (`lsst.afw.math.Property`)
         """
         if mask is None:
             mask = self.getBadPixelMask()
         statsCtrl = afwMath.StatisticsControl()
         statsCtrl.setNumSigmaClip(self.config.sigmaClip)
         statsCtrl.setNumIter(self.config.clipIter)
         statsCtrl.setAndMask(mask)
         statsCtrl.setNanSafe(True)
         statsCtrl.setWeighted(True)
         statsCtrl.setCalcErrorFromInputVariance(self.config.calcErrorFromInputVariance)
         for plane, threshold in self.config.maskPropagationThresholds.items():
             bit = afwImage.Mask.getMaskPlane(plane)
             statsCtrl.setMaskPropagationThreshold(bit, threshold)
         statsFlags = afwMath.stringToStatisticsProperty(self.config.statistic)
         return pipeBase.Struct(ctrl=statsCtrl, flags=statsFlags)
 

◆ processResults()

def lsst.pipe.tasks.assembleCoadd.AssembleCoaddTask.processResults	(	self,
		coaddExposure,
		dataRef
	)

Interpolate over missing data and mask bright stars.

Parameters
----------
coaddExposure : `lsst.afw.image.Exposure`
    The coadded exposure to process.
dataRef : `lsst.daf.persistence.ButlerDataRef`
    Butler data reference for supplementary data.

Definition at line 540 of file assembleCoadd.py.

     def processResults(self, coaddExposure, dataRef):
         """Interpolate over missing data and mask bright stars.
 
         Parameters
         ----------
         coaddExposure : `lsst.afw.image.Exposure`
             The coadded exposure to process.
         dataRef : `lsst.daf.persistence.ButlerDataRef`
             Butler data reference for supplementary data.
         """
         if self.config.doInterp:
             self.interpImage.run(coaddExposure.getMaskedImage(), planeName="NO_DATA")
             # The variance must be positive; work around for DM-3201.
             varArray = coaddExposure.variance.array
             with numpy.errstate(invalid="ignore"):
                 varArray[:] = numpy.where(varArray > 0, varArray, numpy.inf)
 
         if self.config.doMaskBrightObjects:
             brightObjectMasks = self.readBrightObjectMasks(dataRef)
             self.setBrightObjectMasks(coaddExposure, dataRef.dataId, brightObjectMasks)
 

◆ readBrightObjectMasks()

def lsst.pipe.tasks.assembleCoadd.AssembleCoaddTask.readBrightObjectMasks	(	self,
		dataRef
	)

Retrieve the bright object masks.

Returns None on failure.

Parameters
----------
dataRef : `lsst.daf.persistence.butlerSubset.ButlerDataRef`
    A Butler dataRef.

Returns
-------
result : `lsst.daf.persistence.butlerSubset.ButlerDataRef`
    Bright object mask from the Butler object, or None if it cannot
    be retrieved.

Definition at line 1038 of file assembleCoadd.py.

     def readBrightObjectMasks(self, dataRef):
         """Retrieve the bright object masks.
 
         Returns None on failure.
 
         Parameters
         ----------
         dataRef : `lsst.daf.persistence.butlerSubset.ButlerDataRef`
             A Butler dataRef.
 
         Returns
         -------
         result : `lsst.daf.persistence.butlerSubset.ButlerDataRef`
             Bright object mask from the Butler object, or None if it cannot
             be retrieved.
         """
         try:
             return dataRef.get("brightObjectMask", immediate=True)
         except Exception as e:
             self.log.warn("Unable to read brightObjectMask for %s: %s", dataRef.dataId, e)
             return None
 

◆ removeMaskPlanes()

def lsst.pipe.tasks.assembleCoadd.AssembleCoaddTask.removeMaskPlanes	(	self,
		maskedImage
	)

Unset the mask of an image for mask planes specified in the config.

Parameters
----------
maskedImage : `lsst.afw.image.MaskedImage`
    The masked image to be modified.

Definition at line 939 of file assembleCoadd.py.

     def removeMaskPlanes(self, maskedImage):
         """Unset the mask of an image for mask planes specified in the config.
 
         Parameters
         ----------
         maskedImage : `lsst.afw.image.MaskedImage`
             The masked image to be modified.
         """
         mask = maskedImage.getMask()
         for maskPlane in self.config.removeMaskPlanes:
             try:
                 mask &= ~mask.getPlaneBitMask(maskPlane)
             except pexExceptions.InvalidParameterError:
                 self.log.debug("Unable to remove mask plane %s: no mask plane with that name was found.",
                                maskPlane)
 

◆ run()

def lsst.pipe.tasks.assembleCoadd.AssembleCoaddTask.run	(	self,
		skyInfo,
		tempExpRefList,
		imageScalerList,
		weightList,
		altMaskList = `None`,
		mask = `None`,
		supplementaryData = `None`
	)

Assemble a coadd from input warps

Assemble the coadd using the provided list of coaddTempExps. Since
the full coadd covers a patch (a large area), the assembly is
performed over small areas on the image at a time in order to
conserve memory usage. Iterate over subregions within the outer
bbox of the patch using `assembleSubregion` to stack the corresponding
subregions from the coaddTempExps with the statistic specified.
Set the edge bits the coadd mask based on the weight map.

Parameters
----------
skyInfo : `lsst.pipe.base.Struct`
    Struct with geometric information about the patch.
tempExpRefList : `list`
    List of data references to Warps (previously called CoaddTempExps).
imageScalerList : `list`
    List of image scalers.
weightList : `list`
    List of weights
altMaskList : `list`, optional
    List of alternate masks to use rather than those stored with
    tempExp.
mask : `int`, optional
    Bit mask value to exclude from coaddition.
supplementaryData : lsst.pipe.base.Struct, optional
    Struct with additional data products needed to assemble coadd.
    Only used by subclasses that implement `makeSupplementaryData`
    and override `run`.

Returns
-------
result : `lsst.pipe.base.Struct`
   Result struct with components:

   - ``coaddExposure``: coadded exposure (``lsst.afw.image.Exposure``).
   - ``nImage``: exposure count image (``lsst.afw.image.Image``).

Definition at line 741 of file assembleCoadd.py.

             altMaskList=None, mask=None, supplementaryData=None):
         """Assemble a coadd from input warps
 
         Assemble the coadd using the provided list of coaddTempExps. Since
         the full coadd covers a patch (a large area), the assembly is
         performed over small areas on the image at a time in order to
         conserve memory usage. Iterate over subregions within the outer
         bbox of the patch using `assembleSubregion` to stack the corresponding
         subregions from the coaddTempExps with the statistic specified.
         Set the edge bits the coadd mask based on the weight map.
 
         Parameters
         ----------
         skyInfo : `lsst.pipe.base.Struct`
             Struct with geometric information about the patch.
         tempExpRefList : `list`
             List of data references to Warps (previously called CoaddTempExps).
         imageScalerList : `list`
             List of image scalers.
         weightList : `list`
             List of weights
         altMaskList : `list`, optional
             List of alternate masks to use rather than those stored with
             tempExp.
         mask : `int`, optional
             Bit mask value to exclude from coaddition.
         supplementaryData : lsst.pipe.base.Struct, optional
             Struct with additional data products needed to assemble coadd.
             Only used by subclasses that implement `makeSupplementaryData`
             and override `run`.
 
         Returns
         -------
         result : `lsst.pipe.base.Struct`
            Result struct with components:
 
            - ``coaddExposure``: coadded exposure (``lsst.afw.image.Exposure``).
            - ``nImage``: exposure count image (``lsst.afw.image.Image``).
         """
         tempExpName = self.getTempExpDatasetName(self.warpType)
         self.log.info("Assembling %s %s", len(tempExpRefList), tempExpName)
         stats = self.prepareStats(mask=mask)
 
         if altMaskList is None:
             altMaskList = [None]*len(tempExpRefList)
 
         coaddExposure = afwImage.ExposureF(skyInfo.bbox, skyInfo.wcs)
         coaddExposure.setPhotoCalib(self.scaleZeroPoint.getPhotoCalib())
         coaddExposure.getInfo().setCoaddInputs(self.inputRecorder.makeCoaddInputs())
         self.assembleMetadata(coaddExposure, tempExpRefList, weightList)
         coaddMaskedImage = coaddExposure.getMaskedImage()
         subregionSizeArr = self.config.subregionSize
         subregionSize = geom.Extent2I(subregionSizeArr[0], subregionSizeArr[1])
         # if nImage is requested, create a zero one which can be passed to assembleSubregion
         if self.config.doNImage:
             nImage = afwImage.ImageU(skyInfo.bbox)
         else:
             nImage = None
         for subBBox in self._subBBoxIter(skyInfo.bbox, subregionSize):
             try:
                 self.assembleSubregion(coaddExposure, subBBox, tempExpRefList, imageScalerList,
                                        weightList, altMaskList, stats.flags, stats.ctrl,
                                        nImage=nImage)
             except Exception as e:
                 self.log.fatal("Cannot compute coadd %s: %s", subBBox, e)
 
         self.setInexactPsf(coaddMaskedImage.getMask())
         # Despite the name, the following doesn't really deal with "EDGE" pixels: it identifies
         # pixels that didn't receive any unmasked inputs (as occurs around the edge of the field).
         coaddUtils.setCoaddEdgeBits(coaddMaskedImage.getMask(), coaddMaskedImage.getVariance())
         return pipeBase.Struct(coaddExposure=coaddExposure, nImage=nImage)
 

◆ runDataRef()

def lsst.pipe.tasks.assembleCoadd.AssembleCoaddTask.runDataRef	(	self,
		dataRef,
		selectDataList = `None`,
		warpRefList = `None`
	)

Assemble a coadd from a set of Warps.

Pipebase.CmdlineTask entry point to Coadd a set of Warps.
Compute weights to be applied to each Warp and
find scalings to match the photometric zeropoint to a reference Warp.
Assemble the Warps using `run`. Interpolate over NaNs and
optionally write the coadd to disk. Return the coadded exposure.

Parameters
----------
dataRef : `lsst.daf.persistence.butlerSubset.ButlerDataRef`
    Data reference defining the patch for coaddition and the
    reference Warp (if ``config.autoReference=False``).
    Used to access the following data products:
    - ``self.config.coaddName + "Coadd_skyMap"``
    - ``self.config.coaddName + "Coadd_ + <warpType> + "Warp"`` (optionally)
    - ``self.config.coaddName + "Coadd"``
selectDataList : `list`
    List of data references to Calexps. Data to be coadded will be
    selected from this list based on overlap with the patch defined
    by dataRef, grouped by visit, and converted to a list of data
    references to warps.
warpRefList : `list`
    List of data references to Warps to be coadded.
    Note: `warpRefList` is just the new name for `tempExpRefList`.

Returns
-------
retStruct : `lsst.pipe.base.Struct`
   Result struct with components:

   - ``coaddExposure``: coadded exposure (``Exposure``).
   - ``nImage``: exposure count image (``Image``).

Definition at line 466 of file assembleCoadd.py.

     def runDataRef(self, dataRef, selectDataList=None, warpRefList=None):
         """Assemble a coadd from a set of Warps.
 
         Pipebase.CmdlineTask entry point to Coadd a set of Warps.
         Compute weights to be applied to each Warp and
         find scalings to match the photometric zeropoint to a reference Warp.
         Assemble the Warps using `run`. Interpolate over NaNs and
         optionally write the coadd to disk. Return the coadded exposure.
 
         Parameters
         ----------
         dataRef : `lsst.daf.persistence.butlerSubset.ButlerDataRef`
             Data reference defining the patch for coaddition and the
             reference Warp (if ``config.autoReference=False``).
             Used to access the following data products:
             - ``self.config.coaddName + "Coadd_skyMap"``
             - ``self.config.coaddName + "Coadd_ + <warpType> + "Warp"`` (optionally)
             - ``self.config.coaddName + "Coadd"``
         selectDataList : `list`
             List of data references to Calexps. Data to be coadded will be
             selected from this list based on overlap with the patch defined
             by dataRef, grouped by visit, and converted to a list of data
             references to warps.
         warpRefList : `list`
             List of data references to Warps to be coadded.
             Note: `warpRefList` is just the new name for `tempExpRefList`.
 
         Returns
         -------
         retStruct : `lsst.pipe.base.Struct`
            Result struct with components:
 
            - ``coaddExposure``: coadded exposure (``Exposure``).
            - ``nImage``: exposure count image (``Image``).
         """
         if selectDataList and warpRefList:
             raise RuntimeError("runDataRef received both a selectDataList and warpRefList, "
                                "and which to use is ambiguous. Please pass only one.")
 
         skyInfo = self.getSkyInfo(dataRef)
         if warpRefList is None:
             calExpRefList = self.selectExposures(dataRef, skyInfo, selectDataList=selectDataList)
             if len(calExpRefList) == 0:
                 self.log.warn("No exposures to coadd")
                 return
             self.log.info("Coadding %d exposures", len(calExpRefList))
 
             warpRefList = self.getTempExpRefList(dataRef, calExpRefList)
 
         inputData = self.prepareInputs(warpRefList)
         self.log.info("Found %d %s", len(inputData.tempExpRefList),
                       self.getTempExpDatasetName(self.warpType))
         if len(inputData.tempExpRefList) == 0:
             self.log.warn("No coadd temporary exposures found")
             return
 
         supplementaryData = self.makeSupplementaryData(dataRef, warpRefList=inputData.tempExpRefList)
 
         retStruct = self.run(skyInfo, inputData.tempExpRefList, inputData.imageScalerList,
                              inputData.weightList, supplementaryData=supplementaryData)
 
         self.processResults(retStruct.coaddExposure, dataRef)
         if self.config.doWrite:
             if self.getCoaddDatasetName(self.warpType) == "deepCoadd" and self.config.hasFakes:
                 coaddDatasetName = "fakes_" + self.getCoaddDatasetName(self.warpType)
             else:
                 coaddDatasetName = self.getCoaddDatasetName(self.warpType)
             self.log.info("Persisting %s" % coaddDatasetName)
             dataRef.put(retStruct.coaddExposure, coaddDatasetName)
         if self.config.doNImage and retStruct.nImage is not None:
             dataRef.put(retStruct.nImage, self.getCoaddDatasetName(self.warpType) + '_nImage')
 
         return retStruct
 

◆ selectExposures()

def lsst.pipe.tasks.coaddBase.CoaddBaseTask.selectExposures	(	self,
		patchRef,
		skyInfo = `None`,
		selectDataList = `[]`
	)

inherited

Select exposures to coadd.

Get the corners of the bbox supplied in skyInfo using geom::Box2D and convert the pixel positions of the bbox corners to sky coordinates using skyInfo.wcs.pixelToSky. Use the WcsSelectImagesTask to select exposures that lie inside the patch indicated by the dataRef.

Parameters

[in]	patchRef	data reference for sky map patch. Must include keys "tract", "patch", plus the camera-specific filter key (e.g. "filter" or "band")
[in]	skyInfo	geometry for the patch; output from getSkyInfo

Returns: a list of science exposures to coadd, as butler data references

Definition at line 114 of file coaddBase.py.

     def selectExposures(self, patchRef, skyInfo=None, selectDataList=[]):
         """!
         @brief Select exposures to coadd
 
         Get the corners of the bbox supplied in skyInfo using @ref geom.Box2D and convert the pixel
         positions of the bbox corners to sky coordinates using @ref skyInfo.wcs.pixelToSky. Use the
         @ref WcsSelectImagesTask_ "WcsSelectImagesTask" to select exposures that lie inside the patch
         indicated by the dataRef.
 
         @param[in] patchRef  data reference for sky map patch. Must include keys "tract", "patch",
                              plus the camera-specific filter key (e.g. "filter" or "band")
         @param[in] skyInfo   geometry for the patch; output from getSkyInfo
         @return    a list of science exposures to coadd, as butler data references
         """
         if skyInfo is None:
             skyInfo = self.getSkyInfo(patchRef)
         cornerPosList = geom.Box2D(skyInfo.bbox).getCorners()
         coordList = [skyInfo.wcs.pixelToSky(pos) for pos in cornerPosList]
         return self.select.runDataRef(patchRef, coordList, selectDataList=selectDataList).dataRefList
 

◆ setBrightObjectMasks()

def lsst.pipe.tasks.assembleCoadd.AssembleCoaddTask.setBrightObjectMasks	(	self,
		exposure,
		dataId,
		brightObjectMasks
	)

Set the bright object masks.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure under consideration.
dataId : `lsst.daf.persistence.dataId`
    Data identifier dict for patch.
brightObjectMasks : `lsst.afw.table`
    Table of bright objects to mask.

Definition at line 1060 of file assembleCoadd.py.

     def setBrightObjectMasks(self, exposure, dataId, brightObjectMasks):
         """Set the bright object masks.
 
         Parameters
         ----------
         exposure : `lsst.afw.image.Exposure`
             Exposure under consideration.
         dataId : `lsst.daf.persistence.dataId`
             Data identifier dict for patch.
         brightObjectMasks : `lsst.afw.table`
             Table of bright objects to mask.
         """
 
         if brightObjectMasks is None:
             self.log.warn("Unable to apply bright object mask: none supplied")
             return
         self.log.info("Applying %d bright object masks to %s", len(brightObjectMasks), dataId)
         mask = exposure.getMaskedImage().getMask()
         wcs = exposure.getWcs()
         plateScale = wcs.getPixelScale().asArcseconds()
 
         for rec in brightObjectMasks:
             center = geom.PointI(wcs.skyToPixel(rec.getCoord()))
             if rec["type"] == "box":
                 assert rec["angle"] == 0.0, ("Angle != 0 for mask object %s" % rec["id"])
                 width = rec["width"].asArcseconds()/plateScale    # convert to pixels
                 height = rec["height"].asArcseconds()/plateScale  # convert to pixels
 
                 halfSize = geom.ExtentI(0.5*width, 0.5*height)
                 bbox = geom.Box2I(center - halfSize, center + halfSize)
 
                 bbox = geom.BoxI(geom.PointI(int(center[0] - 0.5*width), int(center[1] - 0.5*height)),
                                  geom.PointI(int(center[0] + 0.5*width), int(center[1] + 0.5*height)))
                 spans = afwGeom.SpanSet(bbox)
             elif rec["type"] == "circle":
                 radius = int(rec["radius"].asArcseconds()/plateScale)   # convert to pixels
                 spans = afwGeom.SpanSet.fromShape(radius, offset=center)
             else:
                 self.log.warn("Unexpected region type %s at %s" % rec["type"], center)
                 continue
             spans.clippedTo(mask.getBBox()).setMask(mask, self.brightObjectBitmask)
 

◆ setInexactPsf()

def lsst.pipe.tasks.assembleCoadd.AssembleCoaddTask.setInexactPsf	(	self,
		mask
	)

Set INEXACT_PSF mask plane.

If any of the input images isn't represented in the coadd (due to
clipped pixels or chip gaps), the `CoaddPsf` will be inexact. Flag
these pixels.

Parameters
----------
mask : `lsst.afw.image.Mask`
    Coadded exposure's mask, modified in-place.

Definition at line 1102 of file assembleCoadd.py.

     def setInexactPsf(self, mask):
         """Set INEXACT_PSF mask plane.
 
         If any of the input images isn't represented in the coadd (due to
         clipped pixels or chip gaps), the `CoaddPsf` will be inexact. Flag
         these pixels.
 
         Parameters
         ----------
         mask : `lsst.afw.image.Mask`
             Coadded exposure's mask, modified in-place.
         """
         mask.addMaskPlane("INEXACT_PSF")
         inexactPsf = mask.getPlaneBitMask("INEXACT_PSF")
         sensorEdge = mask.getPlaneBitMask("SENSOR_EDGE")  # chip edges (so PSF is discontinuous)
         clipped = mask.getPlaneBitMask("CLIPPED")  # pixels clipped from coadd
         rejected = mask.getPlaneBitMask("REJECTED")  # pixels rejected from coadd due to masks
         array = mask.getArray()
         selected = array & (sensorEdge | clipped | rejected) > 0
         array[selected] |= inexactPsf
 

◆ setRejectedMaskMapping()

def lsst.pipe.tasks.assembleCoadd.AssembleCoaddTask.setRejectedMaskMapping ( statsCtrl )

static

Map certain mask planes of the warps to new planes for the coadd.

If a pixel is rejected due to a mask value other than EDGE, NO_DATA,
or CLIPPED, set it to REJECTED on the coadd.
If a pixel is rejected due to EDGE, set the coadd pixel to SENSOR_EDGE.
If a pixel is rejected due to CLIPPED, set the coadd pixel to CLIPPED.

Parameters
----------
statsCtrl : `lsst.afw.math.StatisticsControl`
    Statistics control object for coadd

Returns
-------
maskMap : `list` of `tuple` of `int`
    A list of mappings of mask planes of the warped exposures to
    mask planes of the coadd.

Definition at line 956 of file assembleCoadd.py.

     def setRejectedMaskMapping(statsCtrl):
         """Map certain mask planes of the warps to new planes for the coadd.
 
         If a pixel is rejected due to a mask value other than EDGE, NO_DATA,
         or CLIPPED, set it to REJECTED on the coadd.
         If a pixel is rejected due to EDGE, set the coadd pixel to SENSOR_EDGE.
         If a pixel is rejected due to CLIPPED, set the coadd pixel to CLIPPED.
 
         Parameters
         ----------
         statsCtrl : `lsst.afw.math.StatisticsControl`
             Statistics control object for coadd
 
         Returns
         -------
         maskMap : `list` of `tuple` of `int`
             A list of mappings of mask planes of the warped exposures to
             mask planes of the coadd.
         """
         edge = afwImage.Mask.getPlaneBitMask("EDGE")
         noData = afwImage.Mask.getPlaneBitMask("NO_DATA")
         clipped = afwImage.Mask.getPlaneBitMask("CLIPPED")
         toReject = statsCtrl.getAndMask() & (~noData) & (~edge) & (~clipped)
         maskMap = [(toReject, afwImage.Mask.getPlaneBitMask("REJECTED")),
                    (edge, afwImage.Mask.getPlaneBitMask("SENSOR_EDGE")),
                    (clipped, clipped)]
         return maskMap
 

◆ shrinkValidPolygons()

def lsst.pipe.tasks.assembleCoadd.AssembleCoaddTask.shrinkValidPolygons	(	self,
		coaddInputs
	)

Shrink coaddInputs' ccds' ValidPolygons in place.

Either modify each ccd's validPolygon in place, or if CoaddInputs
does not have a validPolygon, create one from its bbox.

Parameters
----------
coaddInputs : `lsst.afw.image.coaddInputs`
    Original mask.

Definition at line 1016 of file assembleCoadd.py.

     def shrinkValidPolygons(self, coaddInputs):
         """Shrink coaddInputs' ccds' ValidPolygons in place.
 
         Either modify each ccd's validPolygon in place, or if CoaddInputs
         does not have a validPolygon, create one from its bbox.
 
         Parameters
         ----------
         coaddInputs : `lsst.afw.image.coaddInputs`
             Original mask.
 
         """
         for ccd in coaddInputs.ccds:
             polyOrig = ccd.getValidPolygon()
             validPolyBBox = polyOrig.getBBox() if polyOrig else ccd.getBBox()
             validPolyBBox.grow(-self.config.matchingKernelSize//2)
             if polyOrig:
                 validPolygon = polyOrig.intersectionSingle(validPolyBBox)
             else:
                 validPolygon = afwGeom.polygon.Polygon(geom.Box2D(validPolyBBox))
             ccd.setValidPolygon(validPolygon)
 

Member Data Documentation

◆ brightObjectBitmask

lsst.pipe.tasks.assembleCoadd.AssembleCoaddTask.brightObjectBitmask

Definition at line 360 of file assembleCoadd.py.

◆ ConfigClass

lsst.pipe.tasks.assembleCoadd.AssembleCoaddTask.ConfigClass = AssembleCoaddConfig

static

Definition at line 342 of file assembleCoadd.py.

◆ RunnerClass

lsst.pipe.tasks.coaddBase.CoaddBaseTask.RunnerClass = CoaddTaskRunner

staticinherited

Definition at line 107 of file coaddBase.py.

◆ warpType

lsst.pipe.tasks.assembleCoadd.AssembleCoaddTask.warpType

Definition at line 366 of file assembleCoadd.py.

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

/j/snowflake/release/lsstsw/stack/Linux64/pipe_tasks/18.1.0-11-gb2589d7b/python/lsst/pipe/tasks/assembleCoadd.py

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ adaptArgsAndRun()

◆ applyAltMaskPlanes()

◆ assembleMetadata()

◆ assembleSubregion()

◆ getBadPixelMask()

◆ getCoaddDatasetName()

◆ getInputDatasetTypes()

◆ getOutputDatasetTypes()

◆ getPrerequisiteDatasetTypes()

◆ getSkyInfo()

◆ getTempExpDatasetName()

◆ getTempExpRefList()

◆ makeSupplementaryData()

◆ makeSupplementaryDataGen3()

◆ prepareInputs()

◆ prepareStats()

◆ processResults()

◆ readBrightObjectMasks()

◆ removeMaskPlanes()

◆ run()

◆ runDataRef()

◆ selectExposures()

◆ setBrightObjectMasks()

◆ setInexactPsf()

◆ setRejectedMaskMapping()

◆ shrinkValidPolygons()

Member Data Documentation

◆ brightObjectBitmask

◆ ConfigClass

◆ RunnerClass

◆ warpType

◆ init()