lsst.pipe.tasks  13.0-66-gfbf2f2ce+5
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.coaddBase.CoaddBaseTask Class Reference

Base class for coaddition. More...

Inheritance diagram for lsst.pipe.tasks.coaddBase.CoaddBaseTask:
lsst.pipe.tasks.assembleCoadd.AssembleCoaddTask lsst.pipe.tasks.makeCoaddTempExp.MakeCoaddTempExpTask lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddTask lsst.pipe.tasks.assembleCoadd.SafeClipAssembleCoaddTask

Public Member Functions

def __init__ (self, args, kwargs)
 
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 getCalExp (self, dataRef, bgSubtracted)
 Return one "calexp" calibrated exposure. 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 Attributes

 ConfigClass = CoaddBaseConfig
 
 RunnerClass = CoaddTaskRunner
 

Detailed Description

Base class for coaddition.

Subclasses must specify _DefaultName

Definition at line 90 of file coaddBase.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.coaddBase.CoaddBaseTask.__init__ (   self,
  args,
  kwargs 
)

Definition at line 98 of file coaddBase.py.

Member Function Documentation

◆ getBadPixelMask()

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

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

Definition at line 217 of file coaddBase.py.

◆ getCalExp()

def lsst.pipe.tasks.coaddBase.CoaddBaseTask.getCalExp (   self,
  dataRef,
  bgSubtracted 
)

Return one "calexp" calibrated exposure.

Parameters
[in]dataRefa sensor-level data reference
[in]bgSubtractedreturn calexp with background subtracted? If False get the calexp's background background model and add it to the calexp.
Returns
calibrated exposure

If config.doApplyUberCal, meas_mosaic calibrations will be applied to the returned exposure using applyMosaicResults.

Definition at line 139 of file coaddBase.py.

◆ getCoaddDatasetName()

def lsst.pipe.tasks.coaddBase.CoaddBaseTask.getCoaddDatasetName (   self,
  warpType = "direct" 
)
Return coadd name for given warpType and task config

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

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

Definition at line 167 of file coaddBase.py.

◆ getSkyInfo()

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

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

Parameters
[in]patchRefdata 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 afwGeom Box2I

Definition at line 123 of file coaddBase.py.

◆ getTempExpDatasetName()

def lsst.pipe.tasks.coaddBase.CoaddBaseTask.getTempExpDatasetName (   self,
  warpType = "direct" 
)
Return warp name for given warpType and task config

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

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

Definition at line 182 of file coaddBase.py.

◆ selectExposures()

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

Select exposures to coadd.

Get the corners of the bbox supplied in skyInfo using afwGeom.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]patchRefdata reference for sky map patch. Must include keys "tract", "patch", plus the camera-specific filter key (e.g. "filter" or "band")
[in]skyInfogeometry for the patch; output from getSkyInfo
Returns
a list of science exposures to coadd, as butler data references

Definition at line 103 of file coaddBase.py.

Member Data Documentation

◆ ConfigClass

lsst.pipe.tasks.coaddBase.CoaddBaseTask.ConfigClass = CoaddBaseConfig
static

Definition at line 95 of file coaddBase.py.

◆ RunnerClass

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

Definition at line 96 of file coaddBase.py.


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