Coadd

class lsst.coadd.chisquared.Coadd(bbox, wcs, badMaskPlanes, logName='coadd.chisquared.Coadd')

Bases: lsst.coadd.utils.coadd.Coadd

Create a chi-squared coadd.

Parameters:
bbox : lsst.afw.geom.Box2I

Bounding box of coadd Exposure with respect to parent: coadd dimensions = bbox.getDimensions(); xy0 = bbox.getMin()

wcs : lsst.afw.geom.SkyWcs

WCS of coadd exposure

badMaskPlanes : list of str

Mask planes to pay attention to when rejecting masked pixels. Specify as a collection of names. badMaskPlanes should always include “EDGE”.

logName : str, optional

Name by which messages are logged.

Methods Summary

addExposure(exposure[, weightFactor]) Add a an exposure to the coadd; it is assumed to have the same WCS as the coadd
fromConfig(bbox, wcs, config[, logName]) Create a coadd
getBBox() Return the bounding box of the coadd
getBadPixelMask() Return the bad pixel mask
getCoadd() Get the coadd exposure for all exposures you have coadded so far
getFilters() Return a collection of all the filters seen so far in in addExposure
getWcs() Return the wcs of the coadd
getWeightMap() Return the weight map for all exposures you have coadded so far

Methods Documentation

addExposure(exposure, weightFactor=1.0)

Add a an exposure to the coadd; it is assumed to have the same WCS as the coadd

Parameters:
exposure : lsst.afw.image.Exposure

Exposure to add to coadd; this must 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
weightFactor : float

weight with which to add exposure to coadd

Returns:
overlapBBox : lsst.afw.geom.Box2I

Region of overlap between exposure and coadd in parent coordinates.

weight : float

Weight with which exposure was added to coadd; weight = weightFactor for this kind of coadd.

classmethod fromConfig(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

getBBox()

Return the bounding box of the coadd

getBadPixelMask()

Return the bad pixel mask

getCoadd()

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.

getFilters()

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

getWcs()

Return the wcs of the coadd

getWeightMap()

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.