lsst.pipe.tasks.coaddBase Namespace Reference

Classes
class	CoaddBaseConfig
class	CoaddTaskRunner
class	CoaddBaseTask
class	SelectDataIdContainer

Functions
def	getSkyInfo
	Return SkyMap, tract and patch. More...

Variables
	applyMosaicResults = None
list	__all__ = ["CoaddBaseTask", "getSkyInfo"]

Function Documentation

def lsst.pipe.tasks.coaddBase.getSkyInfo	(		coaddName,
			patchRef
	)

Return SkyMap, tract and patch.

Parameters

[in]	coaddName	coadd name; typically one of deep or goodSeeing
[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 afwGeom Box2I

Definition at line 212 of file coaddBase.py.

def getSkyInfo(coaddName, patchRef):
    """!Return SkyMap, tract and patch

    @param[in]  coaddName  coadd name; typically one of deep or goodSeeing
    @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 afwGeom Box2I
    """
    skyMap = patchRef.get(coaddName + "Coadd_skyMap")
    tractId = patchRef.dataId["tract"]
    tractInfo = skyMap[tractId]

    # patch format is "xIndex,yIndex"
    patchIndex = tuple(int(i) for i in patchRef.dataId["patch"].split(","))
    patchInfo = tractInfo.getPatchInfo(patchIndex)

    return pipeBase.Struct(
        skyMap = skyMap,
        tractInfo = tractInfo,
        patchInfo = patchInfo,
        wcs = tractInfo.getWcs(),
        bbox = patchInfo.getOuterBBox(),
    )

Variable Documentation

list lsst.pipe.tasks.coaddBase.__all__ = ["CoaddBaseTask", "getSkyInfo"]

Definition at line 40 of file coaddBase.py.

lsst.pipe.tasks.coaddBase.applyMosaicResults = None

Definition at line 38 of file coaddBase.py.