Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
FldoModule.cpp
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 
25 #include "NullFldo.h"
26 #include "cheetah/utils/TaskConfigurationSetter.h"
27 
28 namespace ska {
29 namespace cheetah {
30 namespace fldo {
31 
32 namespace {
33  template<typename ConfigType>
34  struct FldoFactory {
35  public:
36  FldoFactory(ConfigType const& config)
37  : _config(config)
38  {
39  }
40 
41  template<typename Algo>
42  Algo create()
43  {
44  return Algo(_config);
45  }
46 
47  template<typename Algo>
48  bool active() const {
49  return _config.template config<typename Algo::Config>().active();
50  }
51 
52  private:
53  ConfigType const& _config;
54  };
55 
56 } // namespace
57 
58 template<class FldoTraitsType, typename... FldoAlgos>
59 FldoModule<FldoTraitsType, FldoAlgos...>::FldoModule(Config const& config, Handler& handler)
60  : _task(config.pool(), handler)
61 {
62  FldoFactory<Config> factory(config);
63  // setup the tasks object according to the configuration settings
64  if(!utils::TaskConfigurationSetter<FldoAlgos...>::configure(_task, factory))
65  {
66  PANDA_LOG_WARN << "no FLDO algorithm has been specified";
67  _task.set_algorithms(NullFldo<FldoTraitsType>());
68  }
69 }
70 
71 template<class FldoTraitsType, typename... FldoAlgos>
72 std::shared_ptr<panda::ResourceJob> FldoModule<FldoTraitsType, FldoAlgos...>::operator()(std::vector<std::shared_ptr<TimeFrequencyType>>& tf_data, data::Scl const& scl_data)
73 {
74  return _task.submit(tf_data, scl_data);
75 }
76 
77 } // namespace fldo
78 } // namespace cheetah
79 } // namespace ska
Some limits and constants for FLDO.
Definition: Brdz.h:35
Sifted Candidate List.
Definition: Scl.h:45
std::shared_ptr< panda::ResourceJob > operator()(std::vector< std::shared_ptr< TimeFrequencyType >> &tf_data, data::Scl const &scl_data)
call this operator to submit a job for folding
Definition: FldoModule.cpp:72