109def packMatches(matches):
110 """Make a catalog of matches from a sequence of matches.
111
112 The catalog contains three fields:
113 - first: the ID of the first source record in each match
114 - second: the ID of the second source record in each match
115 - distance: the distance of each match
116
117 Parameters
118 ----------
119 matches :
120 Sequence of matches, typically of type SimpleMatch,
121 ReferenceMatch or SourceMatch. Each element must support:
122 `.first.getId()`->int, `.second.getId()->int` and
123 `.distance->float`.
124
125 Returns
126 -------
127 result :
128 The catalog of matches.
129
130 Notes
131 -----
132 This pure python implementation exists as a historical artifact
133 related to SWIG limitations. It might be practical to wrap the
134 overloaded C++ functions with pybind11, but there didn't seem much
135 point.
136 """
137 schema = Schema()
138 outKey1 = schema.addField("first", type=np.int64,
139 doc="ID for first source record in match.")
140 outKey2 = schema.addField("second", type=np.int64,
141 doc="ID for second source record in match.")
142 keyD = schema.addField("distance", type=np.float64,
143 doc="Distance between matches sources.")
144 result = BaseCatalog(schema)
145 result.table.preallocate(len(matches))
146 for match in matches:
147 record = result.addNew()
148 record.set(outKey1, match.first.getId())
149 record.set(outKey2, match.second.getId())
150 record.set(keyD, match.distance)
151 return result
