35 from .coaddBase
import CoaddBaseTask, makeSkyInfo
36 from .warpAndPsfMatch
import WarpAndPsfMatchTask
37 from .coaddHelpers
import groupPatchExposures, getGroupDataRef
39 __all__ = [
"MakeCoaddTempExpTask",
"MakeWarpTask",
"MakeWarpConfig"]
43 """Raised when data cannot be retrieved for an exposure.
44 When processing patches, sometimes one exposure is missing; this lets us
45 distinguish bewteen that case, and other errors.
51 """Config for MakeCoaddTempExpTask
53 warpAndPsfMatch = pexConfig.ConfigurableField(
54 target=WarpAndPsfMatchTask,
55 doc=
"Task to warp and PSF-match calexp",
57 doWrite = pexConfig.Field(
58 doc=
"persist <coaddName>Coadd_<warpType>Warp",
62 bgSubtracted = pexConfig.Field(
63 doc=
"Work with a background subtracted calexp?",
67 coaddPsf = pexConfig.ConfigField(
68 doc=
"Configuration for CoaddPsf",
71 makeDirect = pexConfig.Field(
72 doc=
"Make direct Warp/Coadds",
76 makePsfMatched = pexConfig.Field(
77 doc=
"Make Psf-Matched Warp/Coadd?",
82 doWriteEmptyWarps = pexConfig.Field(
85 doc=
"Write out warps even if they are empty"
88 hasFakes = pexConfig.Field(
89 doc=
"Should be set to True if fake sources have been inserted into the input data.",
93 doApplySkyCorr = pexConfig.Field(dtype=bool, default=
False, doc=
"Apply sky correction?")
96 CoaddBaseTask.ConfigClass.validate(self)
98 raise RuntimeError(
"At least one of config.makePsfMatched and config.makeDirect must be True")
101 log.warn(
"Config doPsfMatch deprecated. Setting makePsfMatched=True and makeDirect=False")
106 CoaddBaseTask.ConfigClass.setDefaults(self)
107 self.
warpAndPsfMatchwarpAndPsfMatch.psfMatch.kernel.active.kernelSize = self.matchingKernelSize
118 r"""!Warp and optionally PSF-Match calexps onto an a common projection.
120 @anchor MakeCoaddTempExpTask_
122 @section pipe_tasks_makeCoaddTempExp_Contents Contents
124 - @ref pipe_tasks_makeCoaddTempExp_Purpose
125 - @ref pipe_tasks_makeCoaddTempExp_Initialize
126 - @ref pipe_tasks_makeCoaddTempExp_IO
127 - @ref pipe_tasks_makeCoaddTempExp_Config
128 - @ref pipe_tasks_makeCoaddTempExp_Debug
129 - @ref pipe_tasks_makeCoaddTempExp_Example
131 @section pipe_tasks_makeCoaddTempExp_Purpose Description
133 Warp and optionally PSF-Match calexps onto a common projection, by
134 performing the following operations:
135 - Group calexps by visit/run
136 - For each visit, generate a Warp by calling method @ref makeTempExp.
137 makeTempExp loops over the visit's calexps calling @ref WarpAndPsfMatch
140 The result is a `directWarp` (and/or optionally a `psfMatchedWarp`).
142 @section pipe_tasks_makeCoaddTempExp_Initialize Task Initialization
144 @copydoc \_\_init\_\_
146 This task has one special keyword argument: passing reuse=True will cause
147 the task to skip the creation of warps that are already present in the
150 @section pipe_tasks_makeCoaddTempExp_IO Invoking the Task
152 This task is primarily designed to be run from the command line.
154 The main method is `runDataRef`, which takes a single butler data reference for the patch(es)
159 WarpType identifies the types of convolutions applied to Warps (previously CoaddTempExps).
160 Only two types are available: direct (for regular Warps/Coadds) and psfMatched
161 (for Warps/Coadds with homogenized PSFs). We expect to add a third type, likelihood,
162 for generating likelihood Coadds with Warps that have been correlated with their own PSF.
164 @section pipe_tasks_makeCoaddTempExp_Config Configuration parameters
166 See @ref MakeCoaddTempExpConfig and parameters inherited from
167 @link lsst.pipe.tasks.coaddBase.CoaddBaseConfig CoaddBaseConfig @endlink
169 @subsection pipe_tasks_MakeCoaddTempExp_psfMatching Guide to PSF-Matching Configs
171 To make `psfMatchedWarps`, select `config.makePsfMatched=True`. The subtask
172 @link lsst.ip.diffim.modelPsfMatch.ModelPsfMatchTask ModelPsfMatchTask @endlink
173 is responsible for the PSF-Matching, and its config is accessed via `config.warpAndPsfMatch.psfMatch`.
174 The optimal configuration depends on aspects of dataset: the pixel scale, average PSF FWHM and
175 dimensions of the PSF kernel. These configs include the requested model PSF, the matching kernel size,
176 padding of the science PSF thumbnail and spatial sampling frequency of the PSF.
178 *Config Guidelines*: The user must specify the size of the model PSF to which to match by setting
179 `config.modelPsf.defaultFwhm` in units of pixels. The appropriate values depends on science case.
180 In general, for a set of input images, this config should equal the FWHM of the visit
181 with the worst seeing. The smallest it should be set to is the median FWHM. The defaults
182 of the other config options offer a reasonable starting point.
183 The following list presents the most common problems that arise from a misconfigured
184 @link lsst.ip.diffim.modelPsfMatch.ModelPsfMatchTask ModelPsfMatchTask @endlink
185 and corresponding solutions. All assume the default Alard-Lupton kernel, with configs accessed via
186 ```config.warpAndPsfMatch.psfMatch.kernel['AL']```. Each item in the list is formatted as:
187 Problem: Explanation. *Solution*
189 *Troublshooting PSF-Matching Configuration:*
190 - Matched PSFs look boxy: The matching kernel is too small. _Increase the matching kernel size.
193 config.warpAndPsfMatch.psfMatch.kernel['AL'].kernelSize=27 # default 21
195 Note that increasing the kernel size also increases runtime.
196 - Matched PSFs look ugly (dipoles, quadropoles, donuts): unable to find good solution
197 for matching kernel. _Provide the matcher with more data by either increasing
198 the spatial sampling by decreasing the spatial cell size,_
200 config.warpAndPsfMatch.psfMatch.kernel['AL'].sizeCellX = 64 # default 128
201 config.warpAndPsfMatch.psfMatch.kernel['AL'].sizeCellY = 64 # default 128
203 _or increasing the padding around the Science PSF, for example:_
205 config.warpAndPsfMatch.psfMatch.autoPadPsfTo=1.6 # default 1.4
207 Increasing `autoPadPsfTo` increases the minimum ratio of input PSF dimensions to the
208 matching kernel dimensions, thus increasing the number of pixels available to fit
209 after convolving the PSF with the matching kernel.
210 Optionally, for debugging the effects of padding, the level of padding may be manually
211 controlled by setting turning off the automatic padding and setting the number
212 of pixels by which to pad the PSF:
214 config.warpAndPsfMatch.psfMatch.doAutoPadPsf = False # default True
215 config.warpAndPsfMatch.psfMatch.padPsfBy = 6 # pixels. default 0
217 - Deconvolution: Matching a large PSF to a smaller PSF produces
218 a telltale noise pattern which looks like ripples or a brain.
219 _Increase the size of the requested model PSF. For example:_
221 config.modelPsf.defaultFwhm = 11 # Gaussian sigma in units of pixels.
223 - High frequency (sometimes checkered) noise: The matching basis functions are too small.
224 _Increase the width of the Gaussian basis functions. For example:_
226 config.warpAndPsfMatch.psfMatch.kernel['AL'].alardSigGauss=[1.5, 3.0, 6.0]
227 # from default [0.7, 1.5, 3.0]
230 @section pipe_tasks_makeCoaddTempExp_Debug Debug variables
232 MakeCoaddTempExpTask has no debug output, but its subtasks do.
234 @section pipe_tasks_makeCoaddTempExp_Example A complete example of using MakeCoaddTempExpTask
236 This example uses the package ci_hsc to show how MakeCoaddTempExp fits
237 into the larger Data Release Processing.
242 # if not built already:
243 python $(which scons) # this will take a while
245 The following assumes that `processCcd.py` and `makeSkyMap.py` have previously been run
246 (e.g. by building `ci_hsc` above) to generate a repository of calexps and an
247 output respository with the desired SkyMap. The command,
249 makeCoaddTempExp.py $CI_HSC_DIR/DATA --rerun ci_hsc \
250 --id patch=5,4 tract=0 filter=HSC-I \
251 --selectId visit=903988 ccd=16 --selectId visit=903988 ccd=17 \
252 --selectId visit=903988 ccd=23 --selectId visit=903988 ccd=24 \
253 --config doApplyExternalPhotoCalib=False doApplyExternalSkyWcs=False \
254 makePsfMatched=True modelPsf.defaultFwhm=11
256 writes a direct and PSF-Matched Warp to
257 - `$CI_HSC_DIR/DATA/rerun/ci_hsc/deepCoadd/HSC-I/0/5,4/warp-HSC-I-0-5,4-903988.fits` and
258 - `$CI_HSC_DIR/DATA/rerun/ci_hsc/deepCoadd/HSC-I/0/5,4/psfMatchedWarp-HSC-I-0-5,4-903988.fits`
261 @note PSF-Matching in this particular dataset would benefit from adding
262 `--configfile ./matchingConfig.py` to
263 the command line arguments where `matchingConfig.py` is defined by:
266 config.warpAndPsfMatch.psfMatch.kernel['AL'].kernelSize=27
267 config.warpAndPsfMatch.psfMatch.kernel['AL'].alardSigGauss=[1.5, 3.0, 6.0]" > matchingConfig.py
270 Add the option `--help` to see more options.
272 ConfigClass = MakeCoaddTempExpConfig
273 _DefaultName =
"makeCoaddTempExp"
276 CoaddBaseTask.__init__(self, **kwargs)
278 self.makeSubtask(
"warpAndPsfMatch")
279 if self.config.hasFakes:
286 """!Produce <coaddName>Coadd_<warpType>Warp images by warping and optionally PSF-matching.
288 @param[in] patchRef: data reference for sky map patch. Must include keys "tract", "patch",
289 plus the camera-specific filter key (e.g. "filter" or "band")
290 @return: dataRefList: a list of data references for the new <coaddName>Coadd_directWarps
291 if direct or both warp types are requested and <coaddName>Coadd_psfMatchedWarps if only psfMatched
294 @warning: this task assumes that all exposures in a warp (coaddTempExp) have the same filter.
296 @warning: this task sets the PhotoCalib of the coaddTempExp to the PhotoCalib of the first calexp
297 with any good pixels in the patch. For a mosaic camera the resulting PhotoCalib should be ignored
298 (assembleCoadd should determine zeropoint scaling without referring to it).
303 if self.config.makePsfMatched
and not self.config.makeDirect:
308 calExpRefList = self.
selectExposuresselectExposures(patchRef, skyInfo, selectDataList=selectDataList)
310 if len(calExpRefList) == 0:
311 self.log.warn(
"No exposures to coadd for patch %s", patchRef.dataId)
313 self.log.info(
"Selected %d calexps for patch %s", len(calExpRefList), patchRef.dataId)
314 calExpRefList = [calExpRef
for calExpRef
in calExpRefList
if calExpRef.datasetExists(self.
calexpTypecalexpType)]
315 self.log.info(
"Processing %d existing calexps for patch %s", len(calExpRefList), patchRef.dataId)
319 self.log.info(
"Processing %d warp exposures for patch %s", len(groupData.groups), patchRef.dataId)
322 for i, (tempExpTuple, calexpRefList)
in enumerate(groupData.groups.items()):
324 tempExpTuple, groupData.keys)
325 if self.
reusereuse
and tempExpRef.datasetExists(datasetType=primaryWarpDataset, write=
True):
326 self.log.info(
"Skipping makeCoaddTempExp for %s; output already exists.", tempExpRef.dataId)
327 dataRefList.append(tempExpRef)
329 self.log.info(
"Processing Warp %d/%d: id=%s", i, len(groupData.groups), tempExpRef.dataId)
335 visitId = int(tempExpRef.dataId[
"visit"])
336 except (KeyError, ValueError):
343 for calExpInd, calExpRef
in enumerate(calexpRefList):
344 self.log.info(
"Reading calexp %s of %s for Warp id=%s", calExpInd+1, len(calexpRefList),
347 ccdId = calExpRef.get(
"ccdExposureId", immediate=
True)
354 calExpRef = calExpRef.butlerSubset.butler.dataRef(self.
calexpTypecalexpType,
355 dataId=calExpRef.dataId,
356 tract=skyInfo.tractInfo.getId())
357 calExp = self.
getCalibratedExposuregetCalibratedExposure(calExpRef, bgSubtracted=self.config.bgSubtracted)
358 except Exception
as e:
359 self.log.warn(
"Calexp %s not found; skipping it: %s", calExpRef.dataId, e)
362 if self.config.doApplySkyCorr:
365 calExpList.append(calExp)
366 ccdIdList.append(ccdId)
367 dataIdList.append(calExpRef.dataId)
369 exps = self.
runrun(calExpList, ccdIdList, skyInfo, visitId, dataIdList).exposures
371 if any(exps.values()):
372 dataRefList.append(tempExpRef)
374 self.log.warn(
"Warp %s could not be created", tempExpRef.dataId)
376 if self.config.doWrite:
377 for (warpType, exposure)
in exps.items():
378 if exposure
is not None:
385 def run(self, calExpList, ccdIdList, skyInfo, visitId=0, dataIdList=None, **kwargs):
386 """Create a Warp from inputs
388 We iterate over the multiple calexps in a single exposure to construct
389 the warp (previously called a coaddTempExp) of that exposure to the
390 supplied tract/patch.
392 Pixels that receive no pixels are set to NAN; this is not correct
393 (violates LSST algorithms group policy), but will be fixed up by
394 interpolating after the coaddition.
396 @param calexpRefList: List of data references for calexps that (may)
397 overlap the patch of interest
398 @param skyInfo: Struct from CoaddBaseTask.getSkyInfo() with geometric
399 information about the patch
400 @param visitId: integer identifier for visit, for the table that will
402 @return a pipeBase Struct containing:
403 - exposures: a dictionary containing the warps requested:
404 "direct": direct warp if config.makeDirect
405 "psfMatched": PSF-matched warp if config.makePsfMatched
409 totGoodPix = {warpType: 0
for warpType
in warpTypeList}
410 didSetMetadata = {warpType:
False for warpType
in warpTypeList}
411 coaddTempExps = {warpType: self.
_prepareEmptyExposure_prepareEmptyExposure(skyInfo)
for warpType
in warpTypeList}
412 inputRecorder = {warpType: self.inputRecorder.makeCoaddTempExpRecorder(visitId, len(calExpList))
413 for warpType
in warpTypeList}
415 modelPsf = self.config.modelPsf.apply()
if self.config.makePsfMatched
else None
416 if dataIdList
is None:
417 dataIdList = ccdIdList
419 for calExpInd, (calExp, ccdId, dataId)
in enumerate(zip(calExpList, ccdIdList, dataIdList)):
420 self.log.info(
"Processing calexp %d of %d for this Warp: id=%s",
421 calExpInd+1, len(calExpList), dataId)
424 warpedAndMatched = self.warpAndPsfMatch.
run(calExp, modelPsf=modelPsf,
425 wcs=skyInfo.wcs, maxBBox=skyInfo.bbox,
426 makeDirect=self.config.makeDirect,
427 makePsfMatched=self.config.makePsfMatched)
428 except Exception
as e:
429 self.log.warn(
"WarpAndPsfMatch failed for calexp %s; skipping it: %s", dataId, e)
432 numGoodPix = {warpType: 0
for warpType
in warpTypeList}
433 for warpType
in warpTypeList:
434 exposure = warpedAndMatched.getDict()[warpType]
437 coaddTempExp = coaddTempExps[warpType]
438 if didSetMetadata[warpType]:
439 mimg = exposure.getMaskedImage()
440 mimg *= (coaddTempExp.getPhotoCalib().getInstFluxAtZeroMagnitude()
441 / exposure.getPhotoCalib().getInstFluxAtZeroMagnitude())
443 numGoodPix[warpType] = coaddUtils.copyGoodPixels(
444 coaddTempExp.getMaskedImage(), exposure.getMaskedImage(), self.
getBadPixelMaskgetBadPixelMask())
445 totGoodPix[warpType] += numGoodPix[warpType]
446 self.log.debug(
"Calexp %s has %d good pixels in this patch (%.1f%%) for %s",
447 dataId, numGoodPix[warpType],
448 100.0*numGoodPix[warpType]/skyInfo.bbox.getArea(), warpType)
449 if numGoodPix[warpType] > 0
and not didSetMetadata[warpType]:
450 coaddTempExp.setPhotoCalib(exposure.getPhotoCalib())
451 coaddTempExp.setFilterLabel(exposure.getFilterLabel())
452 coaddTempExp.getInfo().setVisitInfo(exposure.getInfo().getVisitInfo())
454 coaddTempExp.setPsf(exposure.getPsf())
455 didSetMetadata[warpType] =
True
458 inputRecorder[warpType].addCalExp(calExp, ccdId, numGoodPix[warpType])
460 except Exception
as e:
461 self.log.warn(
"Error processing calexp %s; skipping it: %s", dataId, e)
464 for warpType
in warpTypeList:
465 self.log.info(
"%sWarp has %d good pixels (%.1f%%)",
466 warpType, totGoodPix[warpType], 100.0*totGoodPix[warpType]/skyInfo.bbox.getArea())
468 if totGoodPix[warpType] > 0
and didSetMetadata[warpType]:
469 inputRecorder[warpType].finish(coaddTempExps[warpType], totGoodPix[warpType])
470 if warpType ==
"direct":
471 coaddTempExps[warpType].setPsf(
472 CoaddPsf(inputRecorder[warpType].coaddInputs.ccds, skyInfo.wcs,
473 self.config.coaddPsf.makeControl()))
475 if not self.config.doWriteEmptyWarps:
477 coaddTempExps[warpType] =
None
479 result = pipeBase.Struct(exposures=coaddTempExps)
483 """Return one calibrated Exposure, possibly with an updated SkyWcs.
485 @param[in] dataRef a sensor-level data reference
486 @param[in] bgSubtracted return calexp with background subtracted? If False get the
487 calexp's background background model and add it to the calexp.
488 @return calibrated exposure
490 @raises MissingExposureError If data for the exposure is not available.
492 If config.doApplyExternalPhotoCalib is `True`, the photometric calibration
493 (`photoCalib`) is taken from `config.externalPhotoCalibName` via the
494 `name_photoCalib` dataset. Otherwise, the photometric calibration is
495 retrieved from the processed exposure. When
496 `config.doApplyExternalSkyWcs` is `True`, the astrometric calibration
497 is taken from `config.externalSkyWcsName` with the `name_wcs` dataset.
498 Otherwise, the astrometric calibration is taken from the processed
502 exposure = dataRef.get(self.
calexpTypecalexpType, immediate=
True)
503 except dafPersist.NoResults
as e:
507 background = dataRef.get(
"calexpBackground", immediate=
True)
508 mi = exposure.getMaskedImage()
509 mi += background.getImage()
512 if self.config.doApplyExternalPhotoCalib:
513 source = f
"{self.config.externalPhotoCalibName}_photoCalib"
514 self.log.debug(
"Applying external photoCalib to %s from %s", dataRef.dataId, source)
515 photoCalib = dataRef.get(source)
516 exposure.setPhotoCalib(photoCalib)
518 photoCalib = exposure.getPhotoCalib()
520 if self.config.doApplyExternalSkyWcs:
521 source = f
"{self.config.externalSkyWcsName}_wcs"
522 self.log.debug(
"Applying external skyWcs to %s from %s", dataRef.dataId, source)
523 skyWcs = dataRef.get(source)
524 exposure.setWcs(skyWcs)
526 exposure.maskedImage = photoCalib.calibrateImage(exposure.maskedImage,
527 includeScaleUncertainty=self.config.includeCalibVar)
528 exposure.maskedImage /= photoCalib.getCalibrationMean()
534 def _prepareEmptyExposure(skyInfo):
535 """Produce an empty exposure for a given patch"""
536 exp = afwImage.ExposureF(skyInfo.bbox, skyInfo.wcs)
537 exp.getMaskedImage().set(numpy.nan, afwImage.Mask
538 .getPlaneBitMask(
"NO_DATA"), numpy.inf)
542 """Return list of requested warp types per the config.
545 if self.config.makeDirect:
546 warpTypeList.append(
"direct")
547 if self.config.makePsfMatched:
548 warpTypeList.append(
"psfMatched")
552 """Apply correction to the sky background level
554 Sky corrections can be generated with the 'skyCorrection.py'
555 executable in pipe_drivers. Because the sky model used by that
556 code extends over the entire focal plane, this can produce
557 better sky subtraction.
559 The calexp is updated in-place.
563 dataRef : `lsst.daf.persistence.ButlerDataRef`
564 Data reference for calexp.
565 calexp : `lsst.afw.image.Exposure` or `lsst.afw.image.MaskedImage`
568 bg = dataRef.get(
"skyCorr")
569 self.log.debug(
"Applying sky correction to %s", dataRef.dataId)
570 if isinstance(calexp, afwImage.Exposure):
571 calexp = calexp.getMaskedImage()
572 calexp -= bg.getImage()
576 dimensions=(
"tract",
"patch",
"skymap",
"instrument",
"visit"),
577 defaultTemplates={
"coaddName":
"deep",
578 "skyWcsName":
"jointcal",
579 "photoCalibName":
"fgcmcal"}):
580 calExpList = connectionTypes.Input(
581 doc=
"Input exposures to be resampled and optionally PSF-matched onto a SkyMap projection/patch",
583 storageClass=
"ExposureF",
584 dimensions=(
"instrument",
"visit",
"detector"),
588 backgroundList = connectionTypes.Input(
589 doc=
"Input backgrounds to be added back into the calexp if bgSubtracted=False",
590 name=
"calexpBackground",
591 storageClass=
"Background",
592 dimensions=(
"instrument",
"visit",
"detector"),
595 skyCorrList = connectionTypes.Input(
596 doc=
"Input Sky Correction to be subtracted from the calexp if doApplySkyCorr=True",
598 storageClass=
"Background",
599 dimensions=(
"instrument",
"visit",
"detector"),
602 skyMap = connectionTypes.Input(
603 doc=
"Input definition of geometry/bbox and projection/wcs for warped exposures",
604 name=BaseSkyMap.SKYMAP_DATASET_TYPE_NAME,
605 storageClass=
"SkyMap",
606 dimensions=(
"skymap",),
608 externalSkyWcsTractCatalog = connectionTypes.Input(
609 doc=(
"Per-tract, per-visit wcs calibrations. These catalogs use the detector "
610 "id for the catalog id, sorted on id for fast lookup."),
611 name=
"{skyWcsName}SkyWcsCatalog",
612 storageClass=
"ExposureCatalog",
613 dimensions=(
"instrument",
"visit",
"tract"),
615 externalSkyWcsGlobalCatalog = connectionTypes.Input(
616 doc=(
"Per-visit wcs calibrations computed globally (with no tract information). "
617 "These catalogs use the detector id for the catalog id, sorted on id for "
619 name=
"{skyWcsName}SkyWcsCatalog",
620 storageClass=
"ExposureCatalog",
621 dimensions=(
"instrument",
"visit"),
623 externalPhotoCalibTractCatalog = connectionTypes.Input(
624 doc=(
"Per-tract, per-visit photometric calibrations. These catalogs use the "
625 "detector id for the catalog id, sorted on id for fast lookup."),
626 name=
"{photoCalibName}PhotoCalibCatalog",
627 storageClass=
"ExposureCatalog",
628 dimensions=(
"instrument",
"visit",
"tract"),
630 externalPhotoCalibGlobalCatalog = connectionTypes.Input(
631 doc=(
"Per-visit photometric calibrations computed globally (with no tract "
632 "information). These catalogs use the detector id for the catalog id, "
633 "sorted on id for fast lookup."),
634 name=
"{photoCalibName}PhotoCalibCatalog",
635 storageClass=
"ExposureCatalog",
636 dimensions=(
"instrument",
"visit"),
638 direct = connectionTypes.Output(
639 doc=(
"Output direct warped exposure (previously called CoaddTempExp), produced by resampling ",
640 "calexps onto the skyMap patch geometry."),
641 name=
"{coaddName}Coadd_directWarp",
642 storageClass=
"ExposureF",
643 dimensions=(
"tract",
"patch",
"skymap",
"visit",
"instrument"),
645 psfMatched = connectionTypes.Output(
646 doc=(
"Output PSF-Matched warped exposure (previously called CoaddTempExp), produced by resampling ",
647 "calexps onto the skyMap patch geometry and PSF-matching to a model PSF."),
648 name=
"{coaddName}Coadd_psfMatchedWarp",
649 storageClass=
"ExposureF",
650 dimensions=(
"tract",
"patch",
"skymap",
"visit",
"instrument"),
653 wcsList = connectionTypes.Input(
654 doc=
"WCSs of calexps used by SelectImages subtask to determine if the calexp overlaps the patch",
657 dimensions=(
"instrument",
"visit",
"detector"),
660 bboxList = connectionTypes.Input(
661 doc=
"BBoxes of calexps used by SelectImages subtask to determine if the calexp overlaps the patch",
663 storageClass=
"Box2I",
664 dimensions=(
"instrument",
"visit",
"detector"),
667 srcList = connectionTypes.Input(
668 doc=
"src catalogs used by PsfWcsSelectImages subtask to further select on PSF stability",
670 storageClass=
"SourceCatalog",
671 dimensions=(
"instrument",
"visit",
"detector"),
674 psfList = connectionTypes.Input(
675 doc=
"PSF models used by BestSeeingWcsSelectImages subtask to futher select on seeing",
678 dimensions=(
"instrument",
"visit",
"detector"),
682 def __init__(self, *, config=None):
683 super().__init__(config=config)
684 if config.bgSubtracted:
685 self.inputs.remove(
"backgroundList")
686 if not config.doApplySkyCorr:
687 self.inputs.remove(
"skyCorrList")
688 if config.doApplyExternalSkyWcs:
689 if config.useGlobalExternalSkyWcs:
690 self.inputs.remove(
"externalSkyWcsTractCatalog")
692 self.inputs.remove(
"externalSkyWcsGlobalCatalog")
694 self.inputs.remove(
"externalSkyWcsTractCatalog")
695 self.inputs.remove(
"externalSkyWcsGlobalCatalog")
696 if config.doApplyExternalPhotoCalib:
697 if config.useGlobalExternalPhotoCalib:
698 self.inputs.remove(
"externalPhotoCalibTractCatalog")
700 self.inputs.remove(
"externalPhotoCalibGlobalCatalog")
702 self.inputs.remove(
"externalPhotoCalibTractCatalog")
703 self.inputs.remove(
"externalPhotoCalibGlobalCatalog")
704 if not config.makeDirect:
705 self.outputs.remove(
"direct")
706 if not config.makePsfMatched:
707 self.outputs.remove(
"psfMatched")
710 if config.select.target != lsst.pipe.tasks.selectImages.PsfWcsSelectImagesTask:
711 self.inputs.remove(
"srcList")
712 if config.select.target != lsst.pipe.tasks.selectImages.BestSeeingWcsSelectImagesTask:
713 self.inputs.remove(
"psfList")
717 pipelineConnections=MakeWarpConnections):
724 """Warp and optionally PSF-Match calexps onto an a common projection
726 ConfigClass = MakeWarpConfig
727 _DefaultName =
"makeWarp"
729 @utils.inheritDoc(pipeBase.PipelineTask)
730 def runQuantum(self, butlerQC, inputRefs, outputRefs):
734 Construct warps for requested warp type for single epoch
736 PipelineTask (Gen3) entry point to warp and optionally PSF-match
737 calexps. This method is analogous to `runDataRef`.
740 inputs = butlerQC.get(inputRefs)
744 skyMap = inputs.pop(
"skyMap")
745 quantumDataId = butlerQC.quantum.dataId
746 skyInfo =
makeSkyInfo(skyMap, tractId=quantumDataId[
'tract'], patchId=quantumDataId[
'patch'])
749 dataIdList = [ref.datasetRef.dataId
for ref
in inputRefs.calExpList]
751 ccdIdList = [dataId.pack(
"visit_detector")
for dataId
in dataIdList]
756 coordList = [skyInfo.wcs.pixelToSky(pos)
for pos
in cornerPosList]
757 goodIndices = self.select.
run(**inputs, coordList=coordList, dataIds=dataIdList)
758 inputs = self.filterInputs(indices=goodIndices, inputs=inputs)
761 inputs[
'calExpList'] = [ref.get()
for ref
in inputs[
'calExpList']]
764 visits = [dataId[
'visit']
for dataId
in dataIdList]
767 if self.config.doApplyExternalSkyWcs:
768 if self.config.useGlobalExternalSkyWcs:
769 externalSkyWcsCatalog = inputs.pop(
"externalSkyWcsGlobalCatalog")
771 externalSkyWcsCatalog = inputs.pop(
"externalSkyWcsTractCatalog")
773 externalSkyWcsCatalog =
None
775 if self.config.doApplyExternalPhotoCalib:
776 if self.config.useGlobalExternalPhotoCalib:
777 externalPhotoCalibCatalog = inputs.pop(
"externalPhotoCalibGlobalCatalog")
779 externalPhotoCalibCatalog = inputs.pop(
"externalPhotoCalibTractCatalog")
781 externalPhotoCalibCatalog =
None
783 self.prepareCalibratedExposures(**inputs, externalSkyWcsCatalog=externalSkyWcsCatalog,
784 externalPhotoCalibCatalog=externalPhotoCalibCatalog)
786 results = self.run(**inputs, visitId=visitId,
787 ccdIdList=[ccdIdList[i]
for i
in goodIndices],
788 dataIdList=[dataIdList[i]
for i
in goodIndices],
790 if self.config.makeDirect:
791 butlerQC.put(results.exposures[
"direct"], outputRefs.direct)
792 if self.config.makePsfMatched:
793 butlerQC.put(results.exposures[
"psfMatched"], outputRefs.psfMatched)
795 def filterInputs(self, indices, inputs):
796 """Return task inputs with their lists filtered by indices
800 indices : `list` of integers
801 inputs : `dict` of `list` of input connections to be passed to run
803 for key
in inputs.keys():
805 if isinstance(inputs[key], list):
806 inputs[key] = [inputs[key][ind]
for ind
in indices]
809 def prepareCalibratedExposures(self, calExpList, backgroundList=None, skyCorrList=None,
810 externalSkyWcsCatalog=None, externalPhotoCalibCatalog=None,
812 """Calibrate and add backgrounds to input calExpList in place
816 calExpList : `list` of `lsst.afw.image.Exposure`
817 Sequence of calexps to be modified in place
818 backgroundList : `list` of `lsst.afw.math.backgroundList`, optional
819 Sequence of backgrounds to be added back in if bgSubtracted=False
820 skyCorrList : `list` of `lsst.afw.math.backgroundList`, optional
821 Sequence of background corrections to be subtracted if doApplySkyCorr=True
822 externalSkyWcsCatalog : `lsst.afw.table.ExposureCatalog`, optional
823 Exposure catalog with external skyWcs to be applied
824 if config.doApplyExternalSkyWcs=True. Catalog uses the detector id
825 for the catalog id, sorted on id for fast lookup.
826 externalPhotoCalibCatalog : `lsst.afw.table.ExposureCatalog`, optional
827 Exposure catalog with external photoCalib to be applied
828 if config.doApplyExternalPhotoCalib=True. Catalog uses the detector
829 id for the catalog id, sorted on id for fast lookup.
831 backgroundList = len(calExpList)*[
None]
if backgroundList
is None else backgroundList
832 skyCorrList = len(calExpList)*[
None]
if skyCorrList
is None else skyCorrList
834 includeCalibVar = self.config.includeCalibVar
836 for calexp, background, skyCorr
in zip(calExpList, backgroundList, skyCorrList):
837 mi = calexp.maskedImage
838 if not self.config.bgSubtracted:
839 mi += background.getImage()
841 if externalSkyWcsCatalog
is not None or externalPhotoCalibCatalog
is not None:
842 detectorId = calexp.getInfo().getDetector().getId()
845 if externalPhotoCalibCatalog
is not None:
846 row = externalPhotoCalibCatalog.find(detectorId)
848 raise RuntimeError(f
"Detector id {detectorId} not found in "
849 f
"externalPhotoCalibCatalog.")
850 photoCalib = row.getPhotoCalib()
851 if photoCalib
is None:
852 raise RuntimeError(f
"Detector id {detectorId} has None for photoCalib "
853 f
"in externalPhotoCalibCatalog.")
855 photoCalib = calexp.getPhotoCalib()
858 if externalSkyWcsCatalog
is not None:
859 row = externalSkyWcsCatalog.find(detectorId)
861 raise RuntimeError(f
"Detector id {detectorId} not found in externalSkyWcsCatalog.")
862 skyWcs = row.getWcs()
864 raise RuntimeError(f
"Detector id {detectorId} has None for WCS "
865 f
" in externalSkyWcsCatalog.")
866 calexp.setWcs(skyWcs)
869 calexp.maskedImage = photoCalib.calibrateImage(calexp.maskedImage,
870 includeScaleUncertainty=includeCalibVar)
871 calexp.maskedImage /= photoCalib.getCalibrationMean()
876 if self.config.doApplySkyCorr:
877 mi -= skyCorr.getImage()
Base class for coaddition.
def getTempExpDatasetName(self, warpType="direct")
def selectExposures(self, patchRef, skyInfo=None, selectDataList=[])
Select exposures to coadd.
def getCoaddDatasetName(self, warpType="direct")
def getSkyInfo(self, patchRef)
Use getSkyinfo to return the skyMap, tract and patch information, wcs and the outer bbox of the patch...
def getBadPixelMask(self)
Convenience method to provide the bitmask from the mask plane names.
Warp and optionally PSF-Match calexps onto an a common projection.
def getCalibratedExposure(self, dataRef, bgSubtracted)
def run(self, calExpList, ccdIdList, skyInfo, visitId=0, dataIdList=None, **kwargs)
def __init__(self, reuse=False, **kwargs)
def _prepareEmptyExposure(skyInfo)
def runDataRef(self, patchRef, selectDataList=[])
Produce <coaddName>Coadd_<warpType>Warp images by warping and optionally PSF-matching.
def getWarpTypeList(self)
def applySkyCorr(self, dataRef, calexp)
def run(self, skyInfo, tempExpRefList, imageScalerList, weightList, altMaskList=None, mask=None, supplementaryData=None)
def makeSkyInfo(skyMap, tractId, patchId)
def getGroupDataRef(butler, datasetType, groupTuple, keys)
def groupPatchExposures(patchDataRef, calexpDataRefList, coaddDatasetType="deepCoadd", tempExpDatasetType="deepCoadd_directWarp")