Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Ddtr.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_DDTR_CPU_DDTR_H
25 #define SKA_CHEETAH_DDTR_CPU_DDTR_H
26 
27 #include "cheetah/ddtr/cpu/Config.h"
28 #include "cheetah/ddtr/cpu/DedispersionPlan.h"
29 #include "cheetah/ddtr/cpu/detail/Worker.h"
30 #include "cheetah/ddtr/Config.h"
31 #include "cheetah/data/TimeFrequency.h"
32 #include "cheetah/utils/Architectures.h"
33 
34 namespace ska {
35 namespace cheetah {
36 namespace ddtr {
37 namespace cpu {
38 
39 template<typename DdtrTraits>
40 class Ddtr
41 {
42  private:
43  typedef typename DdtrTraits::DmTrialsType DmTrialsType;
44  typedef typename DdtrTraits::TimeFrequencyType TimeFrequencyType;
45  typedef typename DdtrTraits::BufferType BufferType;
46 
47  public:
49  typedef cpu::Config Config;
50  typedef Cpu Architecture;
51 
52  public:
53  Ddtr(ddtr::Config const& algo_config);
54  Ddtr(Ddtr const&) = delete;
55  Ddtr(Ddtr&&);
56  ~Ddtr();
57 
64  std::shared_ptr<DmTrialsType> operator()(panda::PoolResource<cheetah::Cpu>& cpu
65  , BufferType const& data);
66 
67 
71  void plan(DedispersionPlan const& plan);
72 
73  private:
74  static_assert(std::is_empty<Worker<DdtrTraits>>::value, "If you are adding state to Worker then you will need to use DeviceLocal for thread safety");
75  Worker<DdtrTraits> _worker;
76  std::shared_ptr<DedispersionPlan> _plan;
77 };
78 
79 
80 } // namespace cpu
81 } // namespace ddtr
82 } // namespace cheetah
83 } // namespace ska
84 
85 #include "cheetah/ddtr/cpu/detail/Ddtr.cpp"
86 
87 #endif // SKA_CHEETAH_DDTR_CPU_DDTR_H
std::shared_ptr< DmTrialsType > operator()(panda::PoolResource< cheetah::Cpu > &cpu, BufferType const &data)
dedispersion of time frequency data on CPU DmTialsHandler called when buffer is full.
Definition: Ddtr.cpp:52
configuration parameters for the ddtr cpu module
Definition: Config.h:40
Some limits and constants for FLDO.
Definition: Brdz.h:35
void plan(DedispersionPlan const &plan)
set a new dedispersion plan
Definition: Ddtr.cpp:59
detail class that matches the workload of a single thread
Definition: Worker.h:40