LSST Applications g04e9c324dd+8c5ae1fdc5,g134cb467dc+1b3060144d,g18429d2f64+f642bf4753,g199a45376c+0ba108daf9,g1fd858c14a+2dcf163641,g262e1987ae+7b8c96d2ca,g29ae962dfc+3bd6ecb08a,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53e1a9e7c5,g4595892280+fef73a337f,g47891489e3+2efcf17695,g4d44eb3520+642b70b07e,g53246c7159+8c5ae1fdc5,g67b6fd64d1+2efcf17695,g67fd3c3899+b70e05ef52,g74acd417e5+317eb4c7d4,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+2efcf17695,g8d7436a09f+3be3c13596,g8ea07a8fe4+9f5ccc88ac,g90f42f885a+a4e7b16d9b,g97be763408+ad77d7208f,g9dd6db0277+b70e05ef52,ga681d05dcb+a3f46e7fff,gabf8522325+735880ea63,gac2eed3f23+2efcf17695,gb89ab40317+2efcf17695,gbf99507273+8c5ae1fdc5,gd8ff7fe66e+b70e05ef52,gdab6d2f7ff+317eb4c7d4,gdc713202bf+b70e05ef52,gdfd2d52018+b10e285e0f,ge365c994fd+310e8507c4,ge410e46f29+2efcf17695,geaed405ab2+562b3308c0,gffca2db377+8c5ae1fdc5,w.2025.35
LSST Data Management Base Package
Loading...
Searching...
No Matches
_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
28
29#include "lsst/pex/config/python.h" // for LSST_DECLARE_CONTROL_FIELD
33
34namespace py = pybind11;
35using namespace pybind11::literals;
36
37namespace lsst {
38namespace afw {
39namespace table {
40
41using cpputils::python::WrapperCollection;
42
43namespace {
44
46template <typename Catalog1, typename Catalog2>
47void declareMatch2(WrapperCollection &wrappers, std::string const &prefix) {
48 using Record1 = typename Catalog1::Record;
49 using Record2 = typename Catalog2::Record;
50 using MatchList = std::vector<Match<typename Catalog1::Record, typename Catalog2::Record>>;
51
52 using Class = Match<Record1, Record2>;
53 using PyClass = py::classh<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,
72 "cat1"_a, "cat2"_a, "radius"_a, "mc"_a = MatchControl());
73 });
74};
75
77template <typename Catalog>
78void declareMatch1(WrapperCollection &wrappers) {
79 using MatchList = std::vector<Match<typename Catalog::Record, typename Catalog::Record>>;
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
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
void wrap(WrapperCallback function)
Add a set of wrappers without defining a class.
Definition python.h:369
PyType wrapType(PyType cls, ClassWrapperCallback function, bool setModuleName=true)
Add a type (class or enum) wrapper, deferring method and other attribute definitions until finish() i...
Definition python.h:391
pybind11::module module
The module object passed to the PYBIND11_MODULE block that contains this WrapperCollection.
Definition python.h:448
Pass parameters to algorithms that match list of sources.
Definition Match.h:45
A helper class for subdividing pybind11 module across multiple translation units (i....
Definition python.h:242
void wrap(WrapperCallback function)
Add a set of wrappers without defining a class.
Definition python.h:369
PyType wrapType(PyType cls, ClassWrapperCallback function, bool setModuleName=true)
Add a type (class or enum) wrapper, deferring method and other attribute definitions until finish() i...
Definition python.h:391
pybind11::module module
The module object passed to the PYBIND11_MODULE block that contains this WrapperCollection.
Definition python.h:448
py::classh< PixelAreaBoundedField, BoundedField > PyClass
std::vector< Match< typename Cat1::Record, typename Cat2::Record > > unpackMatches(BaseCatalog const &matches, Cat1 const &cat1, Cat2 const &cat2)
Reconstruct a MatchVector from a BaseCatalog representation of the matches and a pair of catalogs.
Definition Match.cc:455
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
std::vector< Match< typename Cat1::Record, typename Cat2::Record > > matchRaDec(Cat1 const &cat1, Cat2 const &cat2, lsst::geom::Angle 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:158
Lightweight representation of a geometric match between two records.
Definition Match.h:67