LSSTApplications  19.0.0-11-g2ce9f25+4,20.0.0+1,20.0.0+10,20.0.0+11,20.0.0+13,20.0.0+2,20.0.0+3,20.0.0+4,20.0.0+6,20.0.0-1-g10df615+10,20.0.0-1-g253301a+5,20.0.0-1-g596936a+11,20.0.0-1-g8a53f90+1,20.0.0-1-gc96f8cb+12,20.0.0-1-gd1c87d7+1,20.0.0-17-g41c5faf,20.0.0-2-g04cfba9+4,20.0.0-2-gd11eeda,20.0.0-2-gec03fae+3,20.0.0-3-g082faa5+1,20.0.0-3-gbdbfa727+3,20.0.0-3-gc53c7b6,20.0.0-4-gde602ef96+4,20.0.0-4-ge48a6ca+6,20.0.0-4-ge987224+1,20.0.0-8-g7eef53f7+7,20.0.0-9-g8e1b333,w.2020.28
LSSTDataManagementBasePackage
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>
79 };
80 
81 typedef Match<SimpleRecord, SimpleRecord> SimpleMatch;
82 typedef Match<SimpleRecord, SourceRecord> ReferenceMatch;
83 typedef Match<SourceRecord, SourceRecord> SourceMatch;
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 
128 [[deprecated("Use overloads that take `MatchControl` instead. To be removed after 20.0.0.")]] // DM-22814
130  matchXy(SourceCatalog const &cat1, SourceCatalog const &cat2, double radius, bool closest);
131 
144 [[deprecated("Use overloads that take `MatchControl` instead. To be removed after 20.0.0.")]] // DM-22814
146  matchXy(SourceCatalog const &cat, double radius, bool symmetric);
147 
156 template <typename Cat1, typename Cat2>
158  Cat1 const &cat1,
159  Cat2 const &cat2,
161  MatchControl const &mc =
162  MatchControl()
163 );
164 
165 /*
166  * Compute all tuples (s1,s2,d) where s1 != s2, s1 and s2 both belong to `cat`,
167  * and d, the distance between s1 and s2, is at most `radius`. The
168  * match is performed in ra, dec space.
169  *
170  * This is instantiated for Simple and Source catalogs.
171  */
172 template <typename Cat>
174  Cat const &cat,
176  MatchControl const &mc =
177  MatchControl()
178 );
179 
195 template <typename Cat1, typename Cat2>
196 [[deprecated("Use overloads that take `MatchControl` instead. To be removed after 20.0.0.")]] // DM-22814
198  matchRaDec(Cat1 const &cat1, Cat2 const &cat2, lsst::geom::Angle radius, bool closest);
199 
214 template <typename Cat>
215 [[deprecated("Use overloads that take `MatchControl` instead. To be removed after 20.0.0.")]] // DM-22814
217  matchRaDec(Cat const &cat, lsst::geom::Angle radius, bool symmetric);
218 
227 template <typename Record1, typename Record2>
228 BaseCatalog packMatches(std::vector<Match<Record1, Record2> > const &matches);
229 
249 template <typename Cat1, typename Cat2>
251  Cat1 const &cat1,
252  Cat2 const &cat2);
253 } // namespace table
254 } // namespace afw
255 } // namespace lsst
256 
257 #endif // #ifndef LSST_AFW_TABLE_MATCH_H
Simple.h
lsst::afw::table::MatchControl::symmetricMatch
bool symmetricMatch
"Produce symmetric matches (default: true):\n" "i.e. if (s1, s2, d) is reported, then so is (s2,...
Definition: Match.h:53
lsst::afw::table::matchRaDec
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
std::shared_ptr< Record1 >
lsst::afw::table::unpackMatches
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
STL class.
lsst::afw
Definition: imageAlgorithm.dox:1
lsst::afw::table::Match::distance
double distance
Definition: Match.h:70
Angle.h
fwd.h
lsst::afw::table::Match::second
std::shared_ptr< Record2 > second
Definition: Match.h:69
lsst::afw::table::ReferenceMatch
Match< SimpleRecord, SourceRecord > ReferenceMatch
Definition: fwd.h:104
lsst::afw::table::packMatches
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
lsst::afw::table::SimpleMatchVector
std::vector< SimpleMatch > SimpleMatchVector
Definition: fwd.h:107
lsst::afw::table::SourceCatalog
SortedCatalogT< SourceRecord > SourceCatalog
Definition: fwd.h:85
lsst::afw::table::matchXy
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
BaseRecord.h
other
ItemVariant const * other
Definition: Schema.cc:56
lsst::afw::table::MatchControl::MatchControl
MatchControl()
Definition: Match.h:47
lsst::afw::table::MatchControl::findOnlyClosest
bool findOnlyClosest
"Return only the closest match if more than one is found " "(default: true)" ;
Definition: Match.h:50
lsst::afw::table::SimpleMatch
Match< SimpleRecord, SimpleRecord > SimpleMatch
Definition: fwd.h:101
LSST_CONTROL_FIELD
#define LSST_CONTROL_FIELD(NAME, TYPE, DOC)
A preprocessor macro used to define fields in C++ "control object" structs.
Definition: config.h:43
lsst::afw::table::Match
Lightweight representation of a geometric match between two records.
Definition: fwd.h:101
Source.h
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::afw::table::Match::first
std::shared_ptr< Record1 > first
Definition: Match.h:68
lsst::afw::table::Match::Match
Match(std::shared_ptr< Record1 > const &r1, std::shared_ptr< Record2 > const &r2, double dist)
Definition: Match.h:74
lsst::afw::table::BaseCatalog
CatalogT< BaseRecord > BaseCatalog
Definition: fwd.h:71
lsst::afw::table::SourceMatchVector
std::vector< SourceMatch > SourceMatchVector
Definition: fwd.h:109
lsst.pipe.tasks.insertFakes.radius
radius
Definition: insertFakes.py:288
lsst::afw::table::SourceMatch
Match< SourceRecord, SourceRecord > SourceMatch
Definition: fwd.h:105
lsst::afw::table::MatchControl::includeMismatches
bool includeMismatches
"Include failed matches (i.e. one 'match' is NULL) " "(default: false)" ;
Definition: Match.h:56
lsst::geom::Angle
A class representing an angle.
Definition: Angle.h:127
config.h
lsst::afw::table::MatchControl
Pass parameters to algorithms that match list of sources.
Definition: Match.h:45
lsst::afw::table::Match::Match
Match(Match< R1, R2 > const &other)
Definition: Match.h:78
lsst::afw::table::ReferenceMatchVector
std::vector< ReferenceMatch > ReferenceMatchVector
Definition: fwd.h:108
Catalog.h
lsst::afw::table::Match::Match
Match()
Definition: Match.h:72