Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Sift.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_SIFT_SIFT_H
25 #define SKA_CHEETAH_SIFT_SIFT_H
26 
27 #include "cheetah/sift/Config.h"
28 #include "cheetah/sift/SiftModule.h"
29 #include "cheetah/sift/simple_sift/Sift.h"
30 #include "cheetah/utils/Architectures.h"
31 
32 namespace ska {
33 namespace cheetah {
34 namespace sift {
35 
39 template<class SiftTraitsT>
40 using SiftAlgos = SiftModule<SiftTraitsT
41  , simple_sift::Sift
42  >;
54 template<typename Handler, class ConfigT = sift::ConfigType>
55 class Sift : public SiftAlgos<SiftTraits<ConfigT, Handler>>
56 {
57  public:
59 
60  private:
61  typedef SiftAlgos<Traits> BaseT;
62  typedef typename Traits::ConfigType Config;
63 
64  public:
65 
71  Sift(Config const& config, Handler&);
72  Sift(Sift const&) = delete;
73  Sift(Sift&&) = default;
74 
83  void operator()(std::shared_ptr<data::Ccl> const& input);
84  void operator()(data::Ccl& input);
85 
86  using BaseT::operator();
87 
88 };
89 
90 } // namespace sift
91 } // namespace cheetah
92 } // namespace ska
93 
94 #include "cheetah/sift/detail/Sift.cpp"
95 
96 #endif // SKA_CHEETAH_SIFT_SIFT_H
Module for configuration and launnch of Sift algorithms.
Definition: SiftModule.h:62
Some limits and constants for FLDO.
Definition: Brdz.h:35
Candidate list.
Definition: Ccl.h:45
void operator()(std::shared_ptr< data::Ccl > const &input)
Sift candidates in a Ccl based on their periods and DMs. Async call, the handler passed in the const...
Definition: Sift.cpp:36
Top level sync + async mixed interface for Sift module.
Definition: Sift.h:55
Sift(Config const &config, Handler &)
Construct a new Sift instance.
Definition: Sift.cpp:30