Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Hrms.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_HRMS_HARMONICSUMMING_H
25 #define SKA_CHEETAH_HRMS_HARMONICSUMMING_H
26 
27 #include "cheetah/hrms/Config.h"
28 #include "cheetah/hrms/cuda/Hrms.h"
29 #include "cheetah/data/PowerSeries.h"
30 #include "cheetah/data/Units.h"
31 #include "cheetah/utils/Architectures.h"
32 
33 #include "panda/AlgorithmTuple.h"
34 
35 #include <vector>
36 
37 
38 namespace ska {
39 namespace cheetah {
40 namespace hrms {
41 
45 class Hrms
46 {
47  private:
48  typedef panda::AlgorithmTuple<cuda::Hrms> Implementations;
49 
50  public:
56  Hrms(Config const& config);
57  Hrms(Hrms const&) = delete;
58  Hrms(Hrms&&) = default;
59  ~Hrms();
60 
81  template <typename Arch, typename T, typename Alloc, typename... Args>
82  void process(panda::PoolResource<Arch>& resource,
84  std::vector<data::PowerSeries<Arch,T,Alloc>>& output,
85  Args&&... args);
86 
87  private:
88  Config const& _config;
89  Implementations _implementations;
90 
91 };
92 
93 } // namespace hrms
94 } // namespace cheetah
95 } // namespace ska
96 
97 #include "cheetah/hrms/detail/Hrms.cpp"
98 
99 #endif // SKA_CHEETAH_HRMS_HARMONICSUMMING_H
Some limits and constants for FLDO.
Definition: Brdz.h:35
A class for performing harmonic summing.
Definition: Hrms.h:45
Class for power series (detected FrequencySeries).
Definition: PowerSeries.h:58
Hrms(Config const &config)
Construct a new Hrms object.
Definition: Hrms.cpp:30
void process(panda::PoolResource< Arch > &resource, data::PowerSeries< Arch, T, Alloc > const &input, std::vector< data::PowerSeries< Arch, T, Alloc >> &output, Args &&... args)
Perform harmonic summing on a frequency series.
Definition: Hrms.cpp:33
Algorithm configuration object for Hrms.
Definition: Config.h:40