Base class for coaddition. More...

Inheritance diagram for lsst.pipe.tasks.coaddBase.CoaddBaseTask:

Public Member Functions
def	__init__ (self, **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	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 141 of file coaddBase.py.

Constructor & Destructor Documentation

◆ init()

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

Definition at line 149 of file coaddBase.py.

     def __init__(self, **kwargs):
         super().__init__(**kwargs)
         self.makeSubtask("select")
         self.makeSubtask("inputRecorder")
  

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

     def getBadPixelMask(self):
         """!
         @brief Convenience method to provide the bitmask from the mask plane names
         """
         return afwImage.Mask.getPlaneBitMask(self.config.badMaskPlanes)
  
  

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

     def getCoaddDatasetName(self, warpType="direct"):
         """Return coadd name for given warpType and task config
  
         Parameters
         ----------
         warpType : string
             Either 'direct' or 'psfMatched'
  
         Returns
         -------
         CoaddDatasetName : `string`
         """
         return self.config.coaddName + "Coadd" + makeCoaddSuffix(warpType)
  

◆ 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] patchRef data 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 geom Box2I

Definition at line 174 of file coaddBase.py.

     def getSkyInfo(self, patchRef):
         """!
         @brief Use @ref getSkyinfo to return the skyMap, tract and patch information, wcs and the outer bbox
         of the patch.
  
         @param[in] patchRef  data reference for sky map. Must include keys "tract" and "patch"
  
         @return 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 geom Box2I
         """
         return getSkyInfo(coaddName=self.config.coaddName, patchRef=patchRef)
  

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

     def getTempExpDatasetName(self, warpType="direct"):
         """Return warp name for given warpType and task config
  
         Parameters
         ----------
         warpType : string
             Either 'direct' or 'psfMatched'
  
         Returns
         -------
         WarpDatasetName : `string`
         """
         return self.config.coaddName + "Coadd_" + warpType + "Warp"
  

◆ 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 geom::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]	patchRef	data reference for sky map patch. Must include keys "tract", "patch", plus the camera-specific filter key (e.g. "filter" or "band")
[in]	skyInfo	geometry for the patch; output from getSkyInfo

Returns: a list of science exposures to coadd, as butler data references

Definition at line 154 of file coaddBase.py.

     def selectExposures(self, patchRef, skyInfo=None, selectDataList=[]):
         """!
         @brief Select exposures to coadd
  
         Get the corners of the bbox supplied in skyInfo using @ref geom.Box2D and convert the pixel
         positions of the bbox corners to sky coordinates using @ref skyInfo.wcs.pixelToSky. Use the
         @ref WcsSelectImagesTask_ "WcsSelectImagesTask" to select exposures that lie inside the patch
         indicated by the dataRef.
  
         @param[in] patchRef  data reference for sky map patch. Must include keys "tract", "patch",
                              plus the camera-specific filter key (e.g. "filter" or "band")
         @param[in] skyInfo   geometry for the patch; output from getSkyInfo
         @return    a list of science exposures to coadd, as butler data references
         """
         if skyInfo is None:
             skyInfo = self.getSkyInfo(patchRef)
         cornerPosList = geom.Box2D(skyInfo.bbox).getCorners()
         coordList = [skyInfo.wcs.pixelToSky(pos) for pos in cornerPosList]
         return self.select.runDataRef(patchRef, coordList, selectDataList=selectDataList).dataRefList
  

Member Data Documentation

◆ ConfigClass

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

static

Definition at line 146 of file coaddBase.py.

◆ RunnerClass

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