lsst.pipe.tasks  20.0.0-40-g22db31cb+8f5fb98ba3
Classes | Functions
lsst.pipe.tasks.coaddBase Namespace Reference

Classes

class  CoaddBaseConfig
 Configuration parameters for CoaddBaseTask. More...
 
class  CoaddBaseTask
 Base class for coaddition. More...
 
class  CoaddTaskRunner
 
class  SelectDataIdContainer
 A dataId container for inputs to be selected. More...
 

Functions

def getSkyInfo (coaddName, patchRef)
 Return the SkyMap, tract and patch information, wcs, and outer bbox of the patch to be coadded. More...
 
def makeSkyInfo (skyMap, tractId, patchId)
 
def scaleVariance (maskedImage, maskPlanes, log=None)
 Scale the variance in a maskedImage. More...
 
def makeCoaddSuffix (warpType="direct")
 

Function Documentation

◆ getSkyInfo()

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

Return the SkyMap, tract and patch information, wcs, and outer bbox of the patch to be coadded.

Parameters
[in]coaddNamecoadd name; typically one of deep or goodSeeing
[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 geom Box2I

Definition at line 261 of file coaddBase.py.

◆ makeCoaddSuffix()

def lsst.pipe.tasks.coaddBase.makeCoaddSuffix (   warpType = "direct")
Return coadd suffix for warpType

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

Returns
-------
CoaddSuffix : `string`

Definition at line 336 of file coaddBase.py.

◆ makeSkyInfo()

def lsst.pipe.tasks.coaddBase.makeSkyInfo (   skyMap,
  tractId,
  patchId 
)
Return SkyInfo Struct

Constructs SkyInfo used by coaddition tasks for multiple
patchId formats.

Parameters
----------
skyMap : `lsst.skyMap.SkyMap`
tractId : int
patchId : str or int or tuple of int
    Either Gen2-style comma delimited string (e.g. '4,5'),
    tuple of integers (e.g (4, 5), Gen3-style integer.

Definition at line 279 of file coaddBase.py.

◆ scaleVariance()

def lsst.pipe.tasks.coaddBase.scaleVariance (   maskedImage,
  maskPlanes,
  log = None 
)

Scale the variance in a maskedImage.

The variance plane in a convolved or warped image (or a coadd derived from warped images) does not accurately reflect the noise properties of the image because variance has been lost to covariance. This function attempts to correct for this by scaling the variance plane to match the observed variance in the image. This is not perfect (because we're not tracking the covariance) but it's simple and is often good enough.

Deprecated:
Use the ScaleVarianceTask instead.
Parameters
maskedImageMaskedImage to operate on; variance will be scaled
maskPlanesList of mask planes for pixels to reject
logLog for reporting the renormalization factor; or None
Returns
renormalisation factor

Definition at line 312 of file coaddBase.py.