LSSTApplications  17.0+124,17.0+14,17.0+73,18.0.0+37,18.0.0+80,18.0.0-4-g68ffd23+4,18.1.0-1-g0001055+12,18.1.0-1-g03d53ef+5,18.1.0-1-g1349e88+55,18.1.0-1-g2505f39+44,18.1.0-1-g5315e5e+4,18.1.0-1-g5e4b7ea+14,18.1.0-1-g7e8fceb+4,18.1.0-1-g85f8cd4+48,18.1.0-1-g8ff0b9f+4,18.1.0-1-ga2c679d+1,18.1.0-1-gd55f500+35,18.1.0-10-gb58edde+2,18.1.0-11-g0997b02+4,18.1.0-13-gfe4edf0b+12,18.1.0-14-g259bd21+21,18.1.0-19-gdb69f3f+2,18.1.0-2-g5f9922c+24,18.1.0-2-gd3b74e5+11,18.1.0-2-gfbf3545+32,18.1.0-26-g728bddb4+5,18.1.0-27-g6ff7ca9+2,18.1.0-3-g52aa583+25,18.1.0-3-g8ea57af+9,18.1.0-3-gb69f684+42,18.1.0-3-gfcaddf3+6,18.1.0-32-gd8786685a,18.1.0-4-gf3f9b77+6,18.1.0-5-g1dd662b+2,18.1.0-5-g6dbcb01+41,18.1.0-6-gae77429+3,18.1.0-7-g9d75d83+9,18.1.0-7-gae09a6d+30,18.1.0-9-gc381ef5+4,w.2019.45
LSSTDataManagementBasePackage
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.

53 def __getitem__(self, i): # noqa: N807
54  """Treat a Match as a tuple of length 3: (first, second, distance)"""
55  if i > 2 or i < -3:
56  raise IndexError(i)
57  if i < 0:
58  i += 3
59  if i == 0:
60  return self.first
61  elif i == 1:
62  return self.second
63  else:
64  return self.distance
65 
66 
lsst::afw::table._match.__getitem__
def __getitem__(self, i)
Definition: _match.py:53

◆ __len__()

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

Definition at line 81 of file _match.py.

81 def __len__(self): # noqa: N807
82  return 3
83 
84 
lsst::afw::table._match.__len__
def __len__(self)
Definition: _match.py:81

◆ __repr__()

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

Definition at line 31 of file _match.py.

31 def __repr__(self): # noqa: N807
32  return "Match(%s,\n %s,\n %g)" % \
33  (repr(self.first), repr(self.second), self.distance)
34 
35 
lsst::afw::table._match.__repr__
def __repr__(self)
Definition: _match.py:31

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

67 def __setitem__(self, i, val): # noqa: N807
68  """Treat a Match as a tuple of length 3: (first, second, distance)"""
69  if i > 2 or i < -3:
70  raise IndexError(i)
71  if i < 0:
72  i += 3
73  if i == 0:
74  self.first = val
75  elif i == 1:
76  self.second = val
77  else:
78  self.distance = val
79 
80 
lsst::afw::table._match.__setitem__
def __setitem__(self, i, val)
Definition: _match.py:67

◆ __str__()

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

Definition at line 36 of file _match.py.

36 def __str__(self): # noqa: N807
37  def sourceRaDec(s):
38  if hasattr(s, "getRa") and hasattr(s, "getDec"):
39  return " RA,Dec=(%g,%g) deg" % (s.getRa().asDegrees(), s.getDec().asDegrees())
40  return ""
41 
42  def sourceXy(s):
43  if hasattr(s, "getX") and hasattr(s, "getY"):
44  return " x,y=(%g,%g)" % (s.getX(), s.getY())
45  return ""
46 
47  def sourceStr(s):
48  return s.__class__.__name__ + ("(id %d" % s.getId()) + sourceRaDec(s) + sourceXy(s) + ")"
49 
50  return "Match(%s, %s, dist %g)" % (sourceStr(self.first), sourceStr(self.second), self.distance,)
51 
52 
lsst::afw::table._match.__str__
def __str__(self)
Definition: _match.py:36

◆ clone()

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

Definition at line 85 of file _match.py.

85 def clone(self):
86  return self.__class__(self.first, self.second, self.distance)
87 
88 
89 # Pickling support disabled for this type (see testSourceMatch comment for reasoning)
90 # def __getstate__(self):
91 # return self.first, self.second, self.distance
92 #
93 #
94 # def __setstate__(self, state):
95 # self.__init__(*state)
96 
97 
lsst::afw::table._match.clone
def clone(self)
Definition: _match.py:85

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

109 def 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
152 
lsst::afw::table::BaseCatalog
CatalogT< BaseRecord > BaseCatalog
Definition: fwd.h:71
lsst::afw::table._match.packMatches
def packMatches(matches)
Definition: _match.py:109

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.

Generated on Sat Nov 16 2019 09:15:30 for LSSTApplications by   doxygen 1.8.13