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
FastFinder.h
Go to the documentation of this file.
1 // -*- LSST-C++ -*-
2 /*
3  * This file is part of jointcal.
4  *
5  * Developed for the LSST Data Management System.
6  * This product includes software developed by the LSST Project
7  * (https://www.lsst.org).
8  * See the COPYRIGHT file at the top-level directory of this distribution
9  * for details of code ownership.
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program. If not, see <https://www.gnu.org/licenses/>.
23  */
24 
25 #ifndef LSST_JOINTCAL_FAST_FINDER_H
26 #define LSST_JOINTCAL_FAST_FINDER_H
27 
28 #include <vector>
29 #include "lsst/jointcal/BaseStar.h"
30 
31 namespace lsst {
32 namespace jointcal {
33 
54 class FastFinder {
55 public:
56  const BaseStarList baselist; // shallow copy of the initial list of stars (not used, acts as a
57  // conservatory). The need is arguable.
58  unsigned count; // total number of objects (size of input list stars).
59  /* the sorted pointer array: It does not seem very wise to use smart
60  pointers here because reference counts will uselessly jump around
61  during sorting */
62  // Unfortunately we *must* use shared_ptr here because the return value of findClosest is used to pass
63  // ownership
65  unsigned nslice; // number of (X) slices
66  std::vector<unsigned> index; // index in "stars" of first object of each slice.
67  double xmin, xmax, xstep; // x bounds, slice size
68 
69  typedef decltype(stars)::value_type stars_element;
70  typedef decltype(stars)::const_iterator pstar;
71 
73  FastFinder(const BaseStarList &list, const unsigned nXSlice = 100);
74 
76  std::shared_ptr<const BaseStar> findClosest(const Point &where, const double maxDist,
77  bool (*SkipIt)(const BaseStar &) = nullptr) const;
78 
80  std::shared_ptr<const BaseStar> secondClosest(const Point &where, const double maxDist,
82  bool (*SkipIt)(const BaseStar &) = nullptr) const;
83 
85  void print(std::ostream &out) const;
86 
89 
90  class Iterator {
91  public: // could be made private, but what for??
94  double yStart, yEnd; // Y limits ( for all stripes)
95  /* pointers to the first and beyond last stars in the y range for
96  the current stripe : */
98  pstar null_value; // with pointers being iterators, the null value is not NULL
99 
100  void check() const;
101 
102  public:
103  Iterator(const FastFinder &f, const Point &where, double maxDist);
104  void operator++();
105  stars_element operator*() const;
106  };
107 
108  Iterator beginScan(const Point &where, double maxDist) const;
109 
110  void findRangeInSlice(const int iSlice, const double yStart, const double yEnd, pstar &start,
111  pstar &end) const;
112  pstar locateYStart(pstar begin, pstar end, double yVal) const;
113  pstar locateYEnd(pstar begin, pstar end, double yVal) const;
114 };
115 } // namespace jointcal
116 } // namespace lsst
117 #endif // LSST_JOINTCAL_FAST_FINDER_H
int end
The base class for handling stars. Used by all matching routines.
Definition: BaseStar.h:51
Iterator meant to traverse objects within some limiting distance.
Definition: FastFinder.h:90
Iterator(const FastFinder &f, const Point &where, double maxDist)
Definition: FastFinder.cc:180
stars_element operator*() const
Definition: FastFinder.cc:205
This is an auxillary class for matching objects from starlists.
Definition: FastFinder.h:54
pstar locateYStart(pstar begin, pstar end, double yVal) const
Definition: FastFinder.cc:134
std::shared_ptr< const BaseStar > findClosest(const Point &where, const double maxDist, bool(*SkipIt)(const BaseStar &)=nullptr) const
Find the closest with some rejection capability.
Definition: FastFinder.cc:83
void print(std::ostream &out) const
mostly for debugging
Definition: FastFinder.cc:77
void findRangeInSlice(const int iSlice, const double yStart, const double yEnd, pstar &start, pstar &end) const
Definition: FastFinder.cc:168
decltype(stars) typedef ::value_type stars_element
Definition: FastFinder.h:69
const BaseStarList baselist
Definition: FastFinder.h:56
decltype(stars) typedef ::const_iterator pstar
Definition: FastFinder.h:70
Iterator beginScan(const Point &where, double maxDist) const
Definition: FastFinder.cc:174
FastFinder(const BaseStarList &list, const unsigned nXSlice=100)
Constructor.
Definition: FastFinder.cc:38
std::vector< unsigned > index
Definition: FastFinder.h:66
std::vector< std::shared_ptr< const BaseStar > > stars
Definition: FastFinder.h:64
std::shared_ptr< const BaseStar > secondClosest(const Point &where, const double maxDist, std::shared_ptr< const BaseStar > &closest, bool(*SkipIt)(const BaseStar &)=nullptr) const
Definition: FastFinder.cc:101
pstar locateYEnd(pstar begin, pstar end, double yVal) const
Definition: FastFinder.cc:152
A point in a plane.
Definition: Point.h:37
std::lists of Stars.
Definition: StarList.h:58
A base class for image defects.