lsst.afw  22.0.1-33-g415537ac7+f49c5b7a45
Functions | Variables
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.

◆ __len__()

def lsst.afw.table._match.__len__ (   self)

Definition at line 81 of file _match.py.

◆ __repr__()

def lsst.afw.table._match.__repr__ (   self)

Definition at line 31 of file _match.py.

◆ __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.

◆ __str__()

def lsst.afw.table._match.__str__ (   self)

Definition at line 36 of file _match.py.

◆ clone()

def lsst.afw.table._match.clone (   self)

Definition at line 85 of file _match.py.

◆ 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.

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.