LSST Applications  21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
LSST Data Management Base Package
_match.cc
Go to the documentation of this file.
1 /*
2  * This file is part of afw.
3  *
4  * Developed for the LSST Data Management System.
5  * This product includes software developed by the LSST Project
6  * (https://www.lsst.org).
7  * See the COPYRIGHT file at the top-level directory of this distribution
8  * for details of code ownership.
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program. If not, see <https://www.gnu.org/licenses/>.
22  */
23 
24 #include "pybind11/pybind11.h"
25 #include "pybind11/stl.h"
26 
27 #include "lsst/utils/python.h"
28 
29 #include "lsst/pex/config/python.h" // for LSST_DECLARE_CONTROL_FIELD
30 #include "lsst/afw/table/Simple.h"
31 #include "lsst/afw/table/Source.h"
32 #include "lsst/afw/table/Match.h"
33 
34 namespace py = pybind11;
35 using namespace pybind11::literals;
36 
37 namespace lsst {
38 namespace afw {
39 namespace table {
40 
41 using utils::python::WrapperCollection;
42 
43 namespace {
44 
46 template <typename Catalog1, typename Catalog2>
47 void declareMatch2(WrapperCollection &wrappers, std::string const &prefix) {
48  using Record1 = typename Catalog1::Record;
49  using Record2 = typename Catalog2::Record;
51 
52  using Class = Match<Record1, Record2>;
53  using PyClass = py::class_<Class, std::shared_ptr<Class>>;
54  wrappers.wrapType(PyClass(wrappers.module, (prefix + "Match").c_str()), [](auto &mod, auto &cls) {
55  cls.def(py::init<>());
56  cls.def(py::init<std::shared_ptr<Record1> const &, std::shared_ptr<Record2> const &, double>(),
57  "first"_a, "second"_a, "distance"_a);
58 
59  // struct fields
60  cls.def_readwrite("first", &Match<Record1, Record2>::first);
61  cls.def_readwrite("second", &Match<Record1, Record2>::second);
62  cls.def_readwrite("distance", &Match<Record1, Record2>::distance);
63  });
64 
65  // Free Functions
66  wrappers.wrap([](auto &mod) {
67  mod.def("unpackMatches", &unpackMatches<Catalog1, Catalog2>, "matches"_a, "cat1"_a, "cat2"_a);
68 
69  mod.def("matchRaDec",
70  (MatchList(*)(Catalog1 const &, Catalog2 const &, lsst::geom::Angle,
71  MatchControl const &))matchRaDec<Catalog1, Catalog2>,
72  "cat1"_a, "cat2"_a, "radius"_a, "mc"_a = MatchControl());
73  });
74 };
75 
77 template <typename Catalog>
78 void declareMatch1(WrapperCollection &wrappers) {
80  wrappers.wrap([](auto &mod) {
81  mod.def("matchRaDec",
82  (MatchList(*)(Catalog const &, lsst::geom::Angle, MatchControl const &))matchRaDec<Catalog>,
83  "cat"_a, "radius"_a, "mc"_a = MatchControl());
84  });
85 }
86 
87 } // namespace
88 
89 void wrapMatch(WrapperCollection &wrappers) {
90  wrappers.wrapType(py::class_<MatchControl>(wrappers.module, "MatchControl"), [](auto &mod, auto &cls) {
91  cls.def(py::init<>());
92  LSST_DECLARE_CONTROL_FIELD(cls, MatchControl, findOnlyClosest);
93  LSST_DECLARE_CONTROL_FIELD(cls, MatchControl, symmetricMatch);
94  LSST_DECLARE_CONTROL_FIELD(cls, MatchControl, includeMismatches);
95  });
96 
97  declareMatch2<SimpleCatalog, SimpleCatalog>(wrappers, "Simple");
98  declareMatch2<SimpleCatalog, SourceCatalog>(wrappers, "Reference");
99  declareMatch2<SourceCatalog, SourceCatalog>(wrappers, "Source");
100  declareMatch1<SimpleCatalog>(wrappers);
101  declareMatch1<SourceCatalog>(wrappers);
102 
103  wrappers.wrap([](auto &mod) {
104  mod.def("matchXy",
105  (SourceMatchVector(*)(SourceCatalog const &, SourceCatalog const &, double,
106  MatchControl const &))matchXy,
107  "cat1"_a, "cat2"_a, "radius"_a, "mc"_a = MatchControl());
108  mod.def("matchXy", (SourceMatchVector(*)(SourceCatalog const &, double, MatchControl const &))matchXy,
109  "cat"_a, "radius"_a, "mc"_a = MatchControl());
110  });
111 }
112 
113 } // namespace table
114 } // namespace afw
115 } // namespace lsst
std::string prefix
Definition: SchemaMapper.cc:72
Pass parameters to algorithms that match list of sources.
Definition: Match.h:45
A class representing an angle.
Definition: Angle.h:127
py::class_< PixelAreaBoundedField, std::shared_ptr< PixelAreaBoundedField >, BoundedField > PyClass
std::vector< SourceMatch > SourceMatchVector
Definition: fwd.h:109
void wrapMatch(WrapperCollection &wrappers)
Definition: _match.cc:89
SourceMatchVector matchXy(SourceCatalog const &cat1, SourceCatalog const &cat2, double radius, MatchControl const &mc=MatchControl())
Compute all tuples (s1,s2,d) where s1 belings to cat1, s2 belongs to cat2 and d, the distance between...
Definition: Match.cc:305
A base class for image defects.