Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
SpsClustering.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_SPSCLUSTERING_H
25 #define SKA_CHEETAH_SPS_CLUSTERING_SPSCLUSTERING_H
26 
27 #include "cheetah/sps_clustering/Config.h"
28 #include "cheetah/sps_clustering/Fof.h"
29 #include "cheetah/data/SpCcl.h"
30 
31 namespace ska {
32 namespace cheetah {
33 namespace sps_clustering {
34 
40 {
41  typedef Fof ClusteringAlgo;
42 
43  public:
47  SpsClustering(Config const& config);
48  ~SpsClustering();
49 
57  template<typename NumRepType>
58  std::shared_ptr<data::SpCcl<NumRepType>> operator()(std::shared_ptr<data::SpCcl<NumRepType>> const& cands);
59 
60  private:
61  Config const& _config;
62  ClusteringAlgo _clustered_candidates;
63 
64 };
65 
66 
67 } // namespace sps_clustering
68 } // namespace cheetah
69 } // namespace ska
70 #include "cheetah/sps_clustering/detail/SpsClustering.cpp"
71 #endif // SKA_CHEETAH_SPS_CLUSTERING_SPSCLUSTERING_H
SpsClustering(Config const &config)
consructor
A class that will merge candidates that have been labeled in the same group.
Definition: SpsClustering.h:39
std::shared_ptr< data::SpCcl< NumRepType > > operator()(std::shared_ptr< data::SpCcl< NumRepType >> const &cands)
remove duplicate candidates
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