Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Fof.h
1 /*
2  * The MIT License (MIT)
3  *
4  * Copyright (c) 2016 The SKA organisation
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef SKA_CHEETAH_SPS_CLUSTERING_FOF_H
25 #define SKA_CHEETAH_SPS_CLUSTERING_FOF_H
26 
27 #include "cheetah/sps_clustering/Config.h"
28 #include "cheetah/data/SpCcl.h"
29 #include <boost/geometry/geometry.hpp>
30 #include <vector>
31 
32 namespace ska {
33 namespace cheetah {
34 namespace sps_clustering {
35 
42 class Fof
43 {
44  static constexpr std::size_t ClusteringParams = 3;
45  typedef boost::geometry::model::point<double, ClusteringParams, boost::geometry::cs::cartesian> PointType;
46 
47  public:
48  Fof(Config const& config);
49  ~Fof();
50 
51  void linking_length(double const& l);
52 
53  double linking_length() const;
54 
61  template<typename NumRepType>
62  std::vector<std::vector<size_t>> operator()(data::SpCcl<NumRepType> const& cands);
63 
64  private:
65  Config const& _config;
66  double _linking_length;
67  double _linking_length_2;
68 };
69 
70 
71 } // namespace sps_clustering
72 } // namespace cheetah
73 } // namespace ska
74 #include "cheetah/sps_clustering/detail/Fof.cpp"
75 #endif // SKA_CHEETAH_SPS_CLUSTERING_FOF_H
Some limits and constants for FLDO.
Definition: Brdz.h:35
SpCandidate list.
Definition: SpCcl.h:52
Friend Of Friends Clustering Algorithm for SpCandidates.
Definition: Fof.h:42
std::vector< std::vector< size_t > > operator()(data::SpCcl< NumRepType > const &cands)
Group the candidates using the fof algorithm.
Definition: Fof.cpp:100