LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
LSST Data Management Base Package
Loading...
Searching...
No Matches
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"
36#include "lsst/geom/Angle.h"
37
38namespace lsst {
39namespace afw {
40namespace table {
41
46public:
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
66template <typename Record1, typename Record2>
67struct 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
81using SimpleMatch = Match<SimpleRecord, SimpleRecord>;
82using ReferenceMatch = Match<SimpleRecord, SourceRecord>;
83using 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
123template <typename Cat1, typename Cat2>
125 Cat1 const &cat1,
126 Cat2 const &cat2,
127 lsst::geom::Angle radius,
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 */
139template <typename Cat>
141 Cat const &cat,
142 lsst::geom::Angle radius,
143 MatchControl const &mc =
144 MatchControl()
145);
146
155template <typename Record1, typename Record2>
156BaseCatalog packMatches(std::vector<Match<Record1, Record2> > const &matches);
157
177template <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
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:128
#define LSST_CONTROL_FIELD(NAME, TYPE, DOC)
A preprocessor macro used to define fields in C++ "control object" structs.
Definition config.h:43
std::vector< ReferenceMatch > ReferenceMatchVector
Definition fwd.h:108
std::vector< SimpleMatch > SimpleMatchVector
Definition fwd.h:107
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
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
std::vector< SourceMatch > SourceMatchVector
Definition fwd.h:109
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
Match< SimpleRecord, SourceRecord > ReferenceMatch
Definition fwd.h:104
CatalogT< BaseRecord > BaseCatalog
Definition fwd.h:72
Match< SimpleRecord, SimpleRecord > SimpleMatch
Definition fwd.h:103
SortedCatalogT< SourceRecord > SourceCatalog
Definition fwd.h:85
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
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< SimpleRecord > second
Definition Match.h:69
std::shared_ptr< SimpleRecord > first
Definition Match.h:68