lsst.afw.table._match Namespace Reference

Functions
def	__repr__ (self)
def	__str__ (self)
def	__getitem__ (self, i)
def	__setitem__ (self, i, val)
def	__len__ (self)
def	clone (self)
def	packMatches (matches)

Variables
	clone
	first
	second
	distance

Function Documentation

__getitem__()

def lsst.afw.table._match.__getitem__	(		self,
			i
	)

Treat a Match as a tuple of length 3: (first, second, distance)

Definition at line 53 of file _match.py.

def __getitem__(self, i):  # noqa: N807
    """Treat a Match as a tuple of length 3: (first, second, distance)"""
    if i > 2 or i < -3:
        raise IndexError(i)
    if i < 0:
        i += 3
    if i == 0:
        return self.first
    elif i == 1:
        return self.second
    else:
        return self.distance
 
 

__len__()

def lsst.afw.table._match.__len__

(

self

)

Definition at line 81 of file _match.py.

def __len__(self):  # noqa: N807
    return 3
 
 

__repr__()

def lsst.afw.table._match.__repr__

(

self

)

Definition at line 31 of file _match.py.

def __repr__(self):  # noqa: N807
    return "Match(%s,\n            %s,\n            %g)" % \
        (repr(self.first), repr(self.second), self.distance)
 
 

__setitem__()

def lsst.afw.table._match.__setitem__	(		self,
			i,
			val
	)

Treat a Match as a tuple of length 3: (first, second, distance)

Definition at line 67 of file _match.py.

def __setitem__(self, i, val):  # noqa: N807
    """Treat a Match as a tuple of length 3: (first, second, distance)"""
    if i > 2 or i < -3:
        raise IndexError(i)
    if i < 0:
        i += 3
    if i == 0:
        self.first = val
    elif i == 1:
        self.second = val
    else:
        self.distance = val
 
 

__str__()

def lsst.afw.table._match.__str__

(

self

)

Definition at line 36 of file _match.py.

def __str__(self):  # noqa: N807
    def sourceRaDec(s):
        if hasattr(s, "getRa") and hasattr(s, "getDec"):
            return " RA,Dec=(%g,%g) deg" % (s.getRa().asDegrees(), s.getDec().asDegrees())
        return ""
 
    def sourceXy(s):
        if hasattr(s, "getX") and hasattr(s, "getY"):
            return " x,y=(%g,%g)" % (s.getX(), s.getY())
        return ""
 
    def sourceStr(s):
        return s.__class__.__name__ + ("(id %d" % s.getId()) + sourceRaDec(s) + sourceXy(s) + ")"
 
    return "Match(%s, %s, dist %g)" % (sourceStr(self.first), sourceStr(self.second), self.distance,)
 
 

clone()

def lsst.afw.table._match.clone

(

self

)

Definition at line 85 of file _match.py.

def clone(self):
    return self.__class__(self.first, self.second, self.distance)
 
 
# Pickling support disabled for this type (see testSourceMatch comment for reasoning)
# def __getstate__(self):
#    return self.first, self.second, self.distance
#
#
# def __setstate__(self, state):
#    self.__init__(*state)
 
 

packMatches()

def lsst.afw.table._match.packMatches

(

matches

)

Make a catalog of matches from a sequence of matches.

The catalog contains three fields:
- first: the ID of the first source record in each match
- second: the ID of the second source record in each match
- distance: the distance of each match

Parameters
----------
matches :
    Sequence of matches, typically of type SimpleMatch,
    ReferenceMatch or SourceMatch.  Each element must support:
    `.first.getId()`->int, `.second.getId()->int` and
    `.distance->float`.

Returns
-------
result :
    The catalog of matches.

Notes
-----
This pure python implementation exists as a historical artifact
related to SWIG limitations. It might be practical to wrap the
overloaded C++ functions with pybind11, but there didn't seem much
point.

Definition at line 109 of file _match.py.

def packMatches(matches):
    """Make a catalog of matches from a sequence of matches.
 
    The catalog contains three fields:
    - first: the ID of the first source record in each match
    - second: the ID of the second source record in each match
    - distance: the distance of each match
 
    Parameters
    ----------
    matches :
        Sequence of matches, typically of type SimpleMatch,
        ReferenceMatch or SourceMatch.  Each element must support:
        `.first.getId()`->int, `.second.getId()->int` and
        `.distance->float`.
 
    Returns
    -------
    result :
        The catalog of matches.
 
    Notes
    -----
    This pure python implementation exists as a historical artifact
    related to SWIG limitations. It might be practical to wrap the
    overloaded C++ functions with pybind11, but there didn't seem much
    point.
    """
    schema = Schema()
    outKey1 = schema.addField("first", type=np.int64,
                              doc="ID for first source record in match.")
    outKey2 = schema.addField("second", type=np.int64,
                              doc="ID for second source record in match.")
    keyD = schema.addField("distance", type=np.float64,
                           doc="Distance between matches sources.")
    result = BaseCatalog(schema)
    result.table.preallocate(len(matches))
    for match in matches:
        record = result.addNew()
        record.set(outKey1, match.first.getId())
        record.set(outKey2, match.second.getId())
        record.set(keyD, match.distance)
    return result

Variable Documentation

clone

lsst.afw.table._match.clone

Definition at line 104 of file _match.py.

distance

lsst.afw.table._match.distance

Definition at line 78 of file _match.py.

first

lsst.afw.table._match.first

Definition at line 74 of file _match.py.

second

lsst.afw.table._match.second

Definition at line 76 of file _match.py.