lsst.meas.astrom.setMatchDistance Namespace Reference

Functions
def	setMatchDistance

Variables
list	__all__ = ["setMatchDistance"]

Function Documentation

def lsst.meas.astrom.setMatchDistance.setMatchDistance

(

matches

)

Set the distance field of the matches in a match list to the distance in radians on the sky

@warning the coord field of the source in each match must be correct

@param[in,out] matches  a list of matches, an instance of lsst.afw.table.ReferenceMatch
    reads the coord field of the source and reference object of each match
    writes the distance field of each match

Definition at line 28 of file setMatchDistance.py.

def setMatchDistance(matches):
    """Set the distance field of the matches in a match list to the distance in radians on the sky

    @warning the coord field of the source in each match must be correct

    @param[in,out] matches  a list of matches, an instance of lsst.afw.table.ReferenceMatch
        reads the coord field of the source and reference object of each match
        writes the distance field of each match
    """
    if len(matches) < 1:
        return

    sourceCoordKey = afwTable.CoordKey(matches[0].first.schema["coord"])
    refObjCoordKey = afwTable.CoordKey(matches[0].second.schema["coord"])
    for match in matches:
        sourceCoord = match.first.get(sourceCoordKey)
        refObjCoord = match.second.get(refObjCoordKey)
        match.distance = refObjCoord.angularSeparation(sourceCoord).asRadians()

Variable Documentation

list lsst.meas.astrom.setMatchDistance.__all__ = ["setMatchDistance"]

Definition at line 26 of file setMatchDistance.py.