lsst.meas.algorithms.makeCoaddApCorrMap Namespace Reference

Functions
def	makeCoaddApCorrMap (catalog, coaddBox, coaddWcs, weightFieldName="weight")

Function Documentation

makeCoaddApCorrMap()

def lsst.meas.algorithms.makeCoaddApCorrMap.makeCoaddApCorrMap	(		catalog,
			coaddBox,
			coaddWcs,
			weightFieldName = "weight"
	)

Construct an ApCorrMap for a coadd

Parameters
----------
catalog: `lsst.afw.table.ExposureCatalog`
    A table of coadd inputs
coaddBox : `lsst.geom.Box2I`
    Bounding box for coadd
coaddWcs : `lsst.afw.geom.SkyWcs
    Wcs for coadd
weightFieldName : `str`
    Name of the weight field in the catalog

Returns
-------
apCorrMap : `lsst.afw.image.ApCorrMap`
    Aperture corrections

Definition at line 29 of file makeCoaddApCorrMap.py.

def makeCoaddApCorrMap(catalog, coaddBox, coaddWcs, weightFieldName="weight"):
    """Construct an ApCorrMap for a coadd
 
    Parameters
    ----------
    catalog: `lsst.afw.table.ExposureCatalog`
        A table of coadd inputs
    coaddBox : `lsst.geom.Box2I`
        Bounding box for coadd
    coaddWcs : `lsst.afw.geom.SkyWcs
        Wcs for coadd
    weightFieldName : `str`
        Name of the weight field in the catalog
 
    Returns
    -------
    apCorrMap : `lsst.afw.image.ApCorrMap`
        Aperture corrections
    """
 
    # Assemble the BoundedFields for each type
    everything = {}  # name --> list of CoaddBoundedFieldElement
    weightKey = catalog.schema[weightFieldName].asKey()
    for row in catalog:
        apCorrMap = row.getApCorrMap()
        if not apCorrMap:
            continue
        weight = row.get(weightKey)
        wcs = row.getWcs()
        validPolygon = row.getValidPolygon()
        for name, bf in apCorrMap.items():
            if name not in everything:
                everything[name] = []
            everything[name].append(CoaddBoundedFieldElement(bf, wcs, validPolygon, weight))
 
    # Construct a CoaddBoundedField for each type
    apCorrMap = ApCorrMap()
    for name, elements in everything.items():
        apCorrMap.set(name, CoaddBoundedField(coaddBox, coaddWcs, elements))
 
    return apCorrMap