lsst.pipe.tasks  13.0-60-g3ba4059d+1
 All Classes Namespaces Files Functions Variables Groups Pages
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:

Public Member Functions

def __init__
 
def selectExposures
 Select exposures to coadd. More...
 
def getSkyInfo
 Use getSkyinfo to return the skyMap, tract and patch information, wcs and the outer bbox of the patch. More...
 
def getCalExp
 Return one "calexp" calibrated exposure. More...
 
def getCoaddDatasetName
 
def getTempExpDatasetName
 
def getWarpTypeList
 
def getBadPixelMask
 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 112 of file coaddBase.py.

Constructor & Destructor Documentation

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

Definition at line 120 of file coaddBase.py.

Member Function Documentation

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

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

Definition at line 249 of file coaddBase.py.

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 161 of file coaddBase.py.

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 189 of file coaddBase.py.

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 145 of file coaddBase.py.

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 204 of file coaddBase.py.

def lsst.pipe.tasks.coaddBase.CoaddBaseTask.getWarpTypeList (   self)
Return list of requested warp types per the config.

Definition at line 218 of file coaddBase.py.

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 125 of file coaddBase.py.

Member Data Documentation

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

Definition at line 117 of file coaddBase.py.

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

Definition at line 118 of file coaddBase.py.


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