lsst.ip.diffim g67c5bb01cf+6b5d97bbe6
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
lsst.ip.diffim.getTemplate.GetCoaddAsTemplateTask Class Reference
Inheritance diagram for lsst.ip.diffim.getTemplate.GetCoaddAsTemplateTask:

Public Member Functions

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)
 

Static Public Attributes

 ConfigClass = GetCoaddAsTemplateConfig
 

Detailed Description

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``.

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 61 of file getTemplate.py.

Member Function Documentation

◆ 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 317 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` of `lsst.skymap.PatchInfo`
     List of all overlap patches of the selected tract.
 - ``skyCorners`` : `list` of `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 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. 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 197 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`
    - ``exposure`` : `lsst.afw.image.ExposureF`
        a template coadd exposure assembled out of patches
    - ``sources`` :  `None` for this subtask

Definition at line 82 of file getTemplate.py.

Member Data Documentation

◆ ConfigClass

lsst.ip.diffim.getTemplate.GetCoaddAsTemplateTask.ConfigClass = GetCoaddAsTemplateConfig
static

Definition at line 79 of file getTemplate.py.


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