Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
FldoModule.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_FLDO_FLDOMODULE_H
25 #define SKA_CHEETAH_FLDO_FLDOMODULE_H
26 
27 #include "panda/ConfigurableTask.h"
28 
29 namespace ska {
30 namespace cheetah {
31 namespace fldo {
32 
33 template<typename ConfigT, typename HandlerT, typename NumericalRep>
34 class FldoTraits {
35  public:
36  typedef ConfigT ConfigType;
37  typedef HandlerT Handler;
39 };
40 
44 template<class FldoTraitsType, typename... FldoAlgos>
46 {
47  typedef typename FldoTraitsType::ConfigType Config;
48  typedef typename FldoTraitsType::Handler Handler;
49 
50  protected:
51  typedef typename FldoTraitsType::TimeFrequencyType TimeFrequencyType;
52 
53  public:
54  FldoModule(Config const&, Handler&);
55 
61  std::shared_ptr<panda::ResourceJob> operator()(std::vector<std::shared_ptr<TimeFrequencyType>>& tf_data
62  , data::Scl const& scl_data);
63 
64  private: // typedefs
65  typedef panda::ConfigurableTask<typename Config::PoolType, Handler&
66  , std::vector<std::shared_ptr<TimeFrequencyType>>
67  , data::Scl const&> TaskType;
68 
69  private: // members
70  TaskType _task;
71 
72 };
73 
74 
75 } // namespace fldo
76 } // namespace cheetah
77 } // namespace ska
78 
79 #include "cheetah/fldo/detail/FldoModule.cpp"
80 
81 #endif // SKA_CHEETAH_FLDO_FLDOMODULE_H
Setup template paramterised Fldo algorithms for use as a module.
Definition: FldoModule.h:45
Some limits and constants for FLDO.
Definition: Brdz.h:35
Sifted Candidate List.
Definition: Scl.h:45