Inheritance diagram for lsst.coadd.utils.coadd.Coadd:

Public Member Functions
def	__init__ (self, bbox, wcs, badMaskPlanes, logName="coadd.utils.Coadd")

def	fromConfig (cls, bbox, wcs, config, logName="coadd.utils.Coadd")

def	addExposure (self, exposure, weightFactor=1.0)

def	getCoadd (self)

def	getFilters (self)

def	getBadPixelMask (self)

def	getBBox (self)

def	getWcs (self)

def	getWeightMap (self)

Static Public Attributes
	ConfigClass = CoaddConfig

Detailed Description

Coadd by weighted addition

This class may be subclassed to implement other coadd techniques.
Typically this is done by overriding addExposure.

Definition at line 46 of file coadd.py.

Constructor & Destructor Documentation

◆ init()

def lsst.coadd.utils.coadd.Coadd.__init__	(	self,
		bbox,
		wcs,
		badMaskPlanes,
		logName = `"coadd.utils.Coadd"`
	)

Create a coadd

@param[in] bbox: bounding box of coadd Exposure with respect to parent (lsst.afw.geom.Box2I):
    coadd dimensions = bbox.getDimensions(); xy0 = bbox.getMin()
@param[in] wcs: WCS of coadd exposure (lsst.afw.geom.SKyWcs)
@param[in] badMaskPlanes: mask planes to pay attention to when rejecting masked pixels.
    Specify as a collection of names.
    badMaskPlanes should always include "NO_DATA".
@param[in] logName: name by which messages are logged

Definition at line 54 of file coadd.py.

Member Function Documentation

◆ addExposure()

def lsst.coadd.utils.coadd.Coadd.addExposure	(	self,
		exposure,
		weightFactor = `1.0`
	)

Add an Exposure to the coadd

@param[in] exposure: Exposure to add to coadd; this should be:
    - background-subtracted or background-matched to the other images being coadded
    - psf-matched to the desired PSF model (optional)
    - warped to match the coadd
    - photometrically scaled to the desired flux magnitude
@param[in] weightFactor: extra weight factor for this exposure

@return
- overlapBBox: region of overlap between exposure and coadd in parent coordinates (afwGeom.Box2I)
- weight: weight with which exposure was added to coadd; weight = weightFactor / clipped mean variance

Subclasses may override to preprocess the exposure or change the way it is added to the coadd.

Definition at line 95 of file coadd.py.

◆ fromConfig()

def lsst.coadd.utils.coadd.Coadd.fromConfig	(	cls,
		bbox,
		wcs,
		config,
		logName = `"coadd.utils.Coadd"`
	)

Create a coadd

@param[in] bbox: bounding box of coadd Exposure with respect to parent (lsst.afw.geom.Box2I):
    coadd dimensions = bbox.getDimensions(); xy0 = bbox.getMin()
@param[in] wcs: WCS of coadd exposure (lsst.afw.geom.SKyWcs)
@param[in] config: coadd config; an instance of CoaddConfig
@param[in] logName: name by which messages are logged

Definition at line 79 of file coadd.py.

◆ getBadPixelMask()

def lsst.coadd.utils.coadd.Coadd.getBadPixelMask ( self )

Return the bad pixel mask

Definition at line 160 of file coadd.py.

◆ getBBox()

def lsst.coadd.utils.coadd.Coadd.getBBox ( self )

Return the bounding box of the coadd

Definition at line 165 of file coadd.py.

◆ getCoadd()

def lsst.coadd.utils.coadd.Coadd.getCoadd ( self )

Get the coadd exposure for all exposures you have coadded so far

If all exposures in this coadd have the same-named filter then that filter is set in the coadd.
Otherwise the coadd will have the default unknown filter.

@warning: the Calib is not be set.

Definition at line 132 of file coadd.py.

◆ getFilters()

def lsst.coadd.utils.coadd.Coadd.getFilters ( self )

Return a collection of all the filters seen so far in in addExposure

Definition at line 155 of file coadd.py.

◆ getWcs()

def lsst.coadd.utils.coadd.Coadd.getWcs ( self )

Return the wcs of the coadd

Definition at line 170 of file coadd.py.

◆ getWeightMap()

def lsst.coadd.utils.coadd.Coadd.getWeightMap ( self )

Return the weight map for all exposures you have coadded so far

The weight map is a float Image of the same dimensions as the coadd; the value of each pixel
is the sum of the weights of all exposures that contributed to that pixel.

Definition at line 175 of file coadd.py.

Member Data Documentation

◆ ConfigClass

lsst.coadd.utils.coadd.Coadd.ConfigClass = CoaddConfig

static

Definition at line 52 of file coadd.py.

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

python/lsst/coadd/utils/coadd.py

Public Member Functions

Static Public Attributes