|
def | runDataRef (self, exposure, sensorRef, templateIdList=None) |
|
def | runQuantum (self, exposure, butlerQC, skyMapRef, coaddExposureRefs) |
|
def | getOverlapPatchList (self, exposure, skyMap) |
|
def | run (self, tractInfo, patchList, skyCorners, availableCoaddRefs, sensorRef=None, visitInfo=None) |
|
def | getCoaddDatasetName (self) |
|
Subtask to retrieve coadd for use as an image difference template.
This is the default getTemplate Task to be run as a subtask by
``pipe.tasks.ImageDifferenceTask``. The main methods are ``run()`` and
``runGen3()``.
Notes
-----
From the given skymap, the closest tract is selected; multiple tracts are
not supported. The assembled template inherits the WCS of the selected
skymap tract and the resolution of the template exposures. Overlapping box
regions of the input template patches are pixel by pixel copied into the
assembled template image. There is no warping or pixel resampling.
Pixels with no overlap of any available input patches are set to ``nan`` value
and ``NO_DATA`` flagged.
Definition at line 62 of file getTemplate.py.
def lsst.ip.diffim.getTemplate.GetCoaddAsTemplateTask.run |
( |
|
self, |
|
|
|
tractInfo, |
|
|
|
patchList, |
|
|
|
skyCorners, |
|
|
|
availableCoaddRefs, |
|
|
|
sensorRef = None , |
|
|
|
visitInfo = None |
|
) |
| |
Gen2 and gen3 shared code: determination of exposure dimensions and
copying of pixels from overlapping patch regions.
Parameters
----------
skyMap : `lsst.skymap.BaseSkyMap`
SkyMap object that corresponds to the template coadd.
tractInfo : `lsst.skymap.TractInfo`
The selected tract.
patchList : iterable of `lsst.skymap.patchInfo.PatchInfo`
Patches to consider for making the template exposure.
skyCorners : list of `lsst.geom.SpherePoint`
Sky corner coordinates to be covered by the template exposure.
availableCoaddRefs : `dict` [`int`]
Dictionary of spatially relevant retrieved coadd patches,
indexed by their sequential patch number. In Gen3 mode, values are
`lsst.daf.butler.DeferredDatasetHandle` and ``.get()`` is called,
in Gen2 mode, ``sensorRef.get(**coaddef)`` is called to retrieve the coadd.
sensorRef : `lsst.daf.persistence.ButlerDataRef`, Gen2 only
Butler data reference to get coadd data.
Must be `None` for Gen3.
visitInfo : `lsst.afw.image.VisitInfo`, Gen2 only
VisitInfo to make dcr model.
Returns
-------
templateExposure: `lsst.afw.image.ExposureF`
The created template exposure.
Definition at line 242 of file getTemplate.py.
def lsst.ip.diffim.getTemplate.GetCoaddAsTemplateTask.runDataRef |
( |
|
self, |
|
|
|
exposure, |
|
|
|
sensorRef, |
|
|
|
templateIdList = None |
|
) |
| |
Gen2 task entry point. Retrieve and mosaic a template coadd exposure
that overlaps the science exposure.
Parameters
----------
exposure: `lsst.afw.image.Exposure`
an exposure for which to generate an overlapping template
sensorRef : TYPE
a Butler data reference that can be used to obtain coadd data
templateIdList : TYPE, optional
list of data ids, unused here, in the case of coadd template
Returns
-------
result : `lsst.pipe.base.Struct`
- ``exposure`` : `lsst.afw.image.ExposureF`
a template coadd exposure assembled out of patches
- ``sources`` : None for this subtask
Definition at line 84 of file getTemplate.py.