LSST Applications  21.0.0+3c14b91618,21.0.0+9f51b1e3f7,21.0.0-1-ga51b5d4+6691386486,21.0.0-10-g2408eff+093cbc5a4d,21.0.0-10-g560fb7b+b5197f4bfa,21.0.0-10-gcf60f90+88fef039d6,21.0.0-15-g490e301a+1aca7ce27a,21.0.0-2-g103fe59+a65a629d54,21.0.0-2-g1367e85+7f080822af,21.0.0-2-g45278ab+9f51b1e3f7,21.0.0-2-g5242d73+7f080822af,21.0.0-2-g7f82c8f+20b0e168c7,21.0.0-2-g8f08a60+e6fd6d9ff9,21.0.0-2-ga326454+20b0e168c7,21.0.0-2-gde069b7+66c51b65da,21.0.0-2-gecfae73+1385e31ff3,21.0.0-2-gfc62afb+7f080822af,21.0.0-20-g09baf175d+b753e4a737,21.0.0-3-g357aad2+34cf5c551a,21.0.0-3-g4be5c26+7f080822af,21.0.0-3-g65f322c+013fced60c,21.0.0-3-g7d9da8d+3c14b91618,21.0.0-3-gaa929c8+b5197f4bfa,21.0.0-3-ge02ed75+1caa01c806,21.0.0-4-g3af6bfd+3791265f16,21.0.0-4-g591bb35+1caa01c806,21.0.0-4-g88306b8+fb98652b4f,21.0.0-4-gccdca77+86bf7a300d,21.0.0-4-ge8a399c+b26ce82291,21.0.0-43-g9a3faf29+c9d24e8573,21.0.0-5-g073e055+09d740ccc5,21.0.0-6-g2d4f3f3+9f51b1e3f7,21.0.0-6-g4e60332+1caa01c806,21.0.0-6-g8356267+caf0b8986d,21.0.0-7-g6531d7b+5c053f0a73,21.0.0-7-g98eecf7+3609eddee2,21.0.0-8-ga5967ee+609c2f0a1c,master-gac4afde19b+1caa01c806,w.2021.09
LSST Data Management Base Package
denormalizeMatches.py
Go to the documentation of this file.
1 # This file is part of meas_astrom.
2 #
3 # Developed for the LSST Data Management System.
4 # This product includes software developed by the LSST Project
5 # (https://www.lsst.org).
6 # See the COPYRIGHT file at the top-level directory of this distribution
7 # for details of code ownership.
8 #
9 # This program is free software: you can redistribute it and/or modify
10 # it under the terms of the GNU General Public License as published by
11 # the Free Software Foundation, either version 3 of the License, or
12 # (at your option) any later version.
13 #
14 # This program is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 # GNU General Public License for more details.
18 #
19 # You should have received a copy of the GNU General Public License
20 # along with this program. If not, see <https://www.gnu.org/licenses/>.
21 
22 __all__ = ["denormalizeMatches"]
23 
24 import lsst.afw.table as afwTable
25 
26 
27 def denormalizeMatches(matches, matchMeta=None):
28  """Generate a denormalized Catalog of matches
29 
30  Parameters
31  ----------
32  matches : `list` of `lsst.afw.table.ReferenceMatch`
33  List of matches between reference catalog and source catalog.
34  matchMeta : `lsst.daf.base.PropertyList`
35  Matching metadata to write in catalog.
36 
37  Returns
38  -------
39  catalog : `lsst.afw.table.BaseCatalog`
40  Catalog containing matchlist entries.
41 
42  Notes
43  -----
44  This is intended for writing matches in a convenient way.
45  Normally we write matches in a 'normalized' form: recording only the join
46  table (reference ID, source ID) to minimise space (the reference and source
47  catalogs should both be available separately, so the only extra information
48  we need is how to join them). However, using that can be a pain, since it
49  requires reading each catalog and doing the join.
50 
51  This function generates a Catalog containing all the information in the
52  matches. The reference catalog entries are in columns with 'ref'
53  prepended, while the source catalog entries are in columns with 'src'
54  prepended (including any alias mappings). The distance between the
55  matches is in a column named "distance".
56 
57  See Also
58  --------
59  lsst.afw.table.packMatches
60  """
61  # TODO: DM-16863 Current this link is removed due to the conversion of
62  # afw.table not yet being complete and causing an error on build.
63  # """
64  if len(matches) == 0:
65  raise RuntimeError("No matches provided.")
66 
67  refSchema = matches[0].first.getSchema()
68  srcSchema = matches[0].second.getSchema()
69 
70  refMapper, srcMapper = afwTable.SchemaMapper.join([refSchema, srcSchema], ["ref_", "src_"])
71  schema = refMapper.editOutputSchema()
72 
73  schema = afwTable.catalogMatches.copyAliasMapWithPrefix(srcSchema, schema, prefix="src_")
74  schema = afwTable.catalogMatches.copyAliasMapWithPrefix(refSchema, schema, prefix="ref_")
75 
76  distKey = schema.addField("distance", type=float, doc="Distance between ref and src")
77 
78  catalog = afwTable.BaseCatalog(schema)
79  catalog.reserve(len(matches))
80  for mm in matches:
81  row = catalog.addNew()
82  row.assign(mm.first, refMapper)
83  row.assign(mm.second, srcMapper)
84  row.set(distKey, mm.distance)
85 
86  if matchMeta is not None:
87  catalog.getTable().setMetadata(matchMeta)
88 
89  return catalog
def denormalizeMatches(matches, matchMeta=None)