Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Tdao.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_TDAO_H
25 #define SKA_CHEETAH_TDAO_H
26 
27 #include "cheetah/tdao/Config.h"
28 #include "cheetah/tdao/cuda/Tdao.h"
29 #include "cheetah/data/PowerSeries.h"
30 #include "cheetah/data/DedispersionMeasure.h"
31 #include "cheetah/data/Ccl.h"
32 
33 #include "panda/AlgorithmTuple.h"
34 
35 namespace ska {
36 namespace cheetah {
37 namespace tdao {
38 
53 class Tdao
54 {
55  private:
56  typedef panda::AlgorithmTuple<cuda::Tdao> Implementations;
57 
58  public:
59 
65  Tdao(Config const& config);
66  Tdao(Tdao const&) = delete;
67  Tdao(Tdao&&) = default;
68  ~Tdao();
69 
89  template <typename Arch, typename T, typename Alloc, typename... Args>
90  void process(panda::PoolResource<Arch>& resource,
92  data::Ccl& output,
93  data::DedispersionMeasureType<float>const& dm,
94  data::AccelerationType const& acc,
95  std::size_t nharmonics,
96  Args&&... args);
97 
98  private:
99  Config const& _config;
100  Implementations _implementations;
101 };
102 
103 } // namespace tdao
104 } // namespace cheetah
105 } // namespace ska
106 
107 #include "cheetah/tdao/detail/Tdao.cpp"
108 
109 #endif // SKA_CHEETAH_TDAO_H
void process(panda::PoolResource< Arch > &resource, data::PowerSeries< Arch, T, Alloc > const &input, data::Ccl &output, data::DedispersionMeasureType< float >const &dm, data::AccelerationType const &acc, std::size_t nharmonics, Args &&... args)
Find significant peaks in a power series.
Definition: Tdao.cpp:34
Some limits and constants for FLDO.
Definition: Brdz.h:35
Class for power series (detected FrequencySeries).
Definition: PowerSeries.h:58
Candidate list.
Definition: Ccl.h:45
Time Domain Spectral Peak Detection and Candidate List Output.
Definition: Tdao.h:53
Tdao(Config const &config)
Construct a new Tdao object.
Definition: Tdao.cpp:31