|
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``.
Definition at line 59 of file getTemplate.py.
◆ getCoaddDatasetName()
def lsst.ip.diffim.getTemplate.GetCoaddAsTemplateTask.getCoaddDatasetName |
( |
|
self | ) |
|
Return coadd name for given task config
Returns
-------
CoaddDatasetName : `string`
TODO: This nearly duplicates a method in CoaddBaseTask (DM-11985)
Definition at line 321 of file getTemplate.py.
◆ getOverlapPatchList()
def lsst.ip.diffim.getTemplate.GetCoaddAsTemplateTask.getOverlapPatchList |
( |
|
self, |
|
|
|
exposure, |
|
|
|
skyMap |
|
) |
| |
Select the relevant tract and its patches that overlap with the
science exposure.
Parameters
----------
exposure : `lsst.afw.image.Exposure`
The science exposure to define the sky region of the template
coadd.
skyMap : `lsst.skymap.BaseSkyMap`
SkyMap object that corresponds to the template coadd.
Returns
-------
result : `tuple` of
- ``tractInfo`` : `lsst.skymap.TractInfo`
The selected tract.
- ``patchList`` : `list` [`lsst.skymap.PatchInfo`]
List of all overlap patches of the selected tract.
- ``skyCorners`` : `list` [`lsst.geom.SpherePoint`]
Corners of the exposure in the sky in the order given by
`lsst.geom.Box2D.getCorners`.
Definition at line 159 of file getTemplate.py.
◆ run()
def lsst.ip.diffim.getTemplate.GetCoaddAsTemplateTask.run |
( |
|
self, |
|
|
|
tractInfo, |
|
|
|
patchList, |
|
|
|
skyCorners, |
|
|
|
availableCoaddRefs, |
|
|
|
sensorRef = None , |
|
|
|
visitInfo = None |
|
) |
| |
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` [`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. Values are
`lsst.daf.butler.DeferredDatasetHandle` and ``.get()`` is called.
sensorRef : `None`
Must always be `None`. Gen2 parameters are no longer used.
visitInfo : `lsst.afw.image.VisitInfo`
VisitInfo to make dcr model.
Returns
-------
templateExposure : `lsst.afw.image.ExposureF`
The created template exposure.
Definition at line 200 of file getTemplate.py.
◆ runQuantum()
def lsst.ip.diffim.getTemplate.GetCoaddAsTemplateTask.runQuantum |
( |
|
self, |
|
|
|
exposure, |
|
|
|
butlerQC, |
|
|
|
skyMapRef, |
|
|
|
coaddExposureRefs |
|
) |
| |
Gen3 task entry point. Retrieve and mosaic a template coadd exposure
that overlaps the science exposure.
Parameters
----------
exposure : `lsst.afw.image.Exposure`
The science exposure to define the sky region of the template
coadd.
butlerQC : `lsst.pipe.base.ButlerQuantumContext`
Butler like object that supports getting data by DatasetRef.
skyMapRef : `lsst.daf.butler.DatasetRef`
Reference to SkyMap object that corresponds to the template coadd.
coaddExposureRefs : iterable of `lsst.daf.butler.DeferredDatasetRef`
Iterable of references to the available template coadd patches.
Returns
-------
result : `lsst.pipe.base.Struct`
A struct with attibutes:
``exposure``
Template coadd exposure assembled out of patches
(`lsst.afw.image.ExposureF`).
``sources``
Always `None` for this subtask.
Definition at line 70 of file getTemplate.py.
◆ ConfigClass
The documentation for this class was generated from the following file: