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.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 
3 /*
4  * LSST Data Management System
5  * Copyright 2008, 2009, 2010 LSST Corporation.
6  *
7  * This product includes software developed by the
8  * LSST Project (http://www.lsst.org/).
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 LSST License Statement and
21  * the GNU General Public License along with this program. If not,
22  * see <http://www.lsstcorp.org/LegalNotices/>.
23  */
24 
25 #ifndef LSST_AFW_TABLE_MATCH_H
26 #define LSST_AFW_TABLE_MATCH_H
27 
28 #include <vector>
29 
30 #include "lsst/pex/config.h"
31 #include "lsst/afw/table/fwd.h"
33 #include "lsst/afw/table/Simple.h"
34 #include "lsst/afw/table/Source.h"
35 #include "lsst/afw/table/Catalog.h"
36 #include "lsst/geom/Angle.h"
37 
38 namespace lsst {
39 namespace afw {
40 namespace table {
41 
45 class MatchControl {
46 public:
49  "Return only the closest match if more than one is found "
50  "(default: true)");
52  "Produce symmetric matches (default: true):\n"
53  "i.e. if (s1, s2, d) is reported, then so is (s2, s1, d)");
55  "Include failed matches (i.e. one 'match' is NULL) "
56  "(default: false)");
57 };
58 
66 template <typename Record1, typename Record2>
67 struct Match final {
70  double distance; // may be pixels or radians
71 
72  Match() : first(), second(), distance(0.0) {}
73 
74  Match(std::shared_ptr<Record1> const &r1, std::shared_ptr<Record2> const &r2, double dist)
75  : first(r1), second(r2), distance(dist) {}
76 
77  template <typename R1, typename R2>
78  Match(Match<R1, R2> const &other) : first(other.first), second(other.second), distance(other.distance) {}
79 };
80 
81 using SimpleMatch = Match<SimpleRecord, SimpleRecord>;
82 using ReferenceMatch = Match<SimpleRecord, SourceRecord>;
83 using SourceMatch = Match<SourceRecord, SourceRecord>;
84 
88 
96  SourceCatalog const &cat1,
97  SourceCatalog const &cat2,
98  double radius,
99  MatchControl const &mc =
100  MatchControl()
101 );
102 
109  SourceCatalog const &cat,
110  double radius,
111  MatchControl const &mc =
112  MatchControl()
113 );
114 
123 template <typename Cat1, typename Cat2>
125  Cat1 const &cat1,
126  Cat2 const &cat2,
128  MatchControl const &mc =
129  MatchControl()
130 );
131 
132 /*
133  * Compute all tuples (s1,s2,d) where s1 != s2, s1 and s2 both belong to `cat`,
134  * and d, the distance between s1 and s2, is at most `radius`. The
135  * match is performed in ra, dec space.
136  *
137  * This is instantiated for Simple and Source catalogs.
138  */
139 template <typename Cat>
141  Cat const &cat,
143  MatchControl const &mc =
144  MatchControl()
145 );
146 
155 template <typename Record1, typename Record2>
156 BaseCatalog packMatches(std::vector<Match<Record1, Record2> > const &matches);
157 
177 template <typename Cat1, typename Cat2>
179  Cat1 const &cat1,
180  Cat2 const &cat2);
181 } // namespace table
182 } // namespace afw
183 } // namespace lsst
184 
185 #endif // #ifndef LSST_AFW_TABLE_MATCH_H
Pass parameters to algorithms that match list of sources.
Definition: Match.h:45
bool findOnlyClosest
"Return only the closest match if more than one is found " "(default: true)" ;
Definition: Match.h:50
bool symmetricMatch
"Produce symmetric matches (default: true):\n" "i.e. if (s1, s2, d) is reported, then so is (s2,...
Definition: Match.h:53
bool includeMismatches
"Include failed matches (i.e. one 'match' is NULL) " "(default: false)" ;
Definition: Match.h:56
A class representing an angle.
Definition: Angle.h:127
#define LSST_CONTROL_FIELD(NAME, TYPE, DOC)
A preprocessor macro used to define fields in C++ "control object" structs.
Definition: config.h:43
class[[deprecated("Removed with no replacement (but see lsst::afw::image::TransmissionCurve). Will be " "removed after v22.")]] FilterProperty final
Describe the properties of a Filter (e.g.
Definition: Filter.h:53
std::vector< SimpleMatch > SimpleMatchVector
Definition: fwd.h:107
std::vector< SourceMatch > SourceMatchVector
Definition: fwd.h:109
Match< SimpleRecord, SourceRecord > ReferenceMatch
Definition: fwd.h:104
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
Match< SimpleRecord, SimpleRecord > SimpleMatch
Definition: fwd.h:103
BaseCatalog packMatches(std::vector< Match< Record1, Record2 > > const &matches)
Return a table representation of a MatchVector that can be used to persist it.
Definition: Match.cc:432
Match< SourceRecord, SourceRecord > SourceMatch
Definition: fwd.h:105
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
SortedCatalogT< SourceRecord > SourceCatalog
Definition: fwd.h:85
std::vector< ReferenceMatch > ReferenceMatchVector
Definition: fwd.h:108
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
CatalogT< BaseRecord > BaseCatalog
Definition: fwd.h:72
A base class for image defects.
Lightweight representation of a geometric match between two records.
Definition: Match.h:67
Match(Match< R1, R2 > const &other)
Definition: Match.h:78
Match(std::shared_ptr< Record1 > const &r1, std::shared_ptr< Record2 > const &r2, double dist)
Definition: Match.h:74
std::shared_ptr< Record2 > second
Definition: Match.h:69
std::shared_ptr< Record1 > first
Definition: Match.h:68