LSSTApplications  17.0+11,17.0+34,17.0+56,17.0+57,17.0+59,17.0+7,17.0-1-g377950a+33,17.0.1-1-g114240f+2,17.0.1-1-g4d4fbc4+28,17.0.1-1-g55520dc+49,17.0.1-1-g5f4ed7e+52,17.0.1-1-g6dd7d69+17,17.0.1-1-g8de6c91+11,17.0.1-1-gb9095d2+7,17.0.1-1-ge9fec5e+5,17.0.1-1-gf4e0155+55,17.0.1-1-gfc65f5f+50,17.0.1-1-gfc6fb1f+20,17.0.1-10-g87f9f3f+1,17.0.1-11-ge9de802+16,17.0.1-16-ga14f7d5c+4,17.0.1-17-gc79d625+1,17.0.1-17-gdae4c4a+8,17.0.1-2-g26618f5+29,17.0.1-2-g54f2ebc+9,17.0.1-2-gf403422+1,17.0.1-20-g2ca2f74+6,17.0.1-23-gf3eadeb7+1,17.0.1-3-g7e86b59+39,17.0.1-3-gb5ca14a,17.0.1-3-gd08d533+40,17.0.1-30-g596af8797,17.0.1-4-g59d126d+4,17.0.1-4-gc69c472+5,17.0.1-6-g5afd9b9+4,17.0.1-7-g35889ee+1,17.0.1-7-gc7c8782+18,17.0.1-9-gc4bbfb2+3,w.2019.22
LSSTDataManagementBasePackage
matchContinued.py
Go to the documentation of this file.
1 #
2 # LSST Data Management System
3 # Copyright 2017 LSST/AURA.
4 #
5 # This product includes software developed by the
6 # LSST Project (http://www.lsst.org/).
7 #
8 # This program is free software: you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation, either version 3 of the License, or
11 # (at your option) any later version.
12 #
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
17 #
18 # You should have received a copy of the LSST License Statement and
19 # the GNU General Public License along with this program. If not,
20 # see <http://www.lsstcorp.org/LegalNotices/>.
21 #
22 
23 import numpy as np
24 
25 from ..base import BaseCatalog
26 from ..schema import Schema
27 from .match import SimpleMatch, ReferenceMatch, SourceMatch
28 
29 
30 def __repr__(self): # noqa: N807
31  return "Match(%s,\n %s,\n %g)" % \
32  (repr(self.first), repr(self.second), self.distance)
33 
34 
35 def __str__(self): # noqa: N807
36  def sourceRaDec(s):
37  if hasattr(s, "getRa") and hasattr(s, "getDec"):
38  return " RA,Dec=(%g,%g) deg" % (s.getRa().asDegrees(), s.getDec().asDegrees())
39  return ""
40 
41  def sourceXy(s):
42  if hasattr(s, "getX") and hasattr(s, "getY"):
43  return " x,y=(%g,%g)" % (s.getX(), s.getY())
44  return ""
45 
46  def sourceStr(s):
47  return s.__class__.__name__ + ("(id %d" % s.getId()) + sourceRaDec(s) + sourceXy(s) + ")"
48 
49  return "Match(%s, %s, dist %g)" % (sourceStr(self.first), sourceStr(self.second), self.distance,)
50 
51 
52 def __getitem__(self, i): # noqa: N807
53  """Treat a Match as a tuple of length 3: (first, second, distance)"""
54  if i > 2 or i < -3:
55  raise IndexError(i)
56  if i < 0:
57  i += 3
58  if i == 0:
59  return self.first
60  elif i == 1:
61  return self.second
62  else:
63  return self.distance
64 
65 
66 def __setitem__(self, i, val): # noqa: N807
67  """Treat a Match as a tuple of length 3: (first, second, distance)"""
68  if i > 2 or i < -3:
69  raise IndexError(i)
70  if i < 0:
71  i += 3
72  if i == 0:
73  self.first = val
74  elif i == 1:
75  self.second = val
76  else:
77  self.distance = val
78 
79 
80 def __len__(self): # noqa: N807
81  return 3
82 
83 
84 def clone(self):
85  return self.__class__(self.first, self.second, self.distance)
86 
87 
88 # Pickling support disabled for this type (see testSourceMatch comment for reasoning)
89 # def __getstate__(self):
90 # return self.first, self.second, self.distance
91 #
92 #
93 # def __setstate__(self, state):
94 # self.__init__(*state)
95 
96 
97 for matchCls in (SimpleMatch, ReferenceMatch, SourceMatch):
98  matchCls.__repr__ = __repr__
99  matchCls.__str__ = __str__
100  matchCls.__getitem__ = __getitem__
101  matchCls.__setitem__ = __setitem__
102  matchCls.__len__ = __len__
103  matchCls.clone = clone
104 # matchCls.__getstate__ = __getstate__
105 # matchCls.__setstate__ = __setstate__
106 
107 
108 def packMatches(matches):
109  """Make a catalog of matches from a sequence of matches.
110 
111  The catalog contains three fields:
112  - first: the ID of the first source record in each match
113  - second: the ID of the second source record in each match
114  - distance: the distance of each match
115 
116  @param[in] matches Sequence of matches, typically of type SimpleMatch, ReferenceMatch or SourceMatch.
117  Each element must support: `.first.getId()`->int, `.second.getId()->int` and `.distance->float`.
118  @return a catalog of matches.
119 
120  @note this pure python implementation exists because SWIG could not easily be used to wrap
121  the overloaded C++ functions, so this was written and tested. It might be practical
122  to wrap the overloaded C++ functions with pybind11, but there didn't seem much point.
123  """
124  schema = Schema()
125  outKey1 = schema.addField("first", type=np.int64,
126  doc="ID for first source record in match.")
127  outKey2 = schema.addField("second", type=np.int64,
128  doc="ID for second source record in match.")
129  keyD = schema.addField("distance", type=np.float64,
130  doc="Distance between matches sources.")
131  result = BaseCatalog(schema)
132  result.table.preallocate(len(matches))
133  for match in matches:
134  record = result.addNew()
135  record.set(outKey1, match.first.getId())
136  record.set(outKey2, match.second.getId())
137  record.set(keyD, match.distance)
138  return result
CatalogT< BaseRecord > BaseCatalog
Definition: fwd.h:71