Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Dred.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_DRED_DRED_H
25 #define SKA_CHEETAH_DRED_DRED_H
26 
27 #include "cheetah/dred/Config.h"
28 #include "cheetah/dred/cuda/Dred.h"
29 #include "cheetah/data/FrequencySeries.h"
30 #include "cheetah/data/ComplexTypeTraits.h"
31 #include "cheetah/utils/Architectures.h"
32 
33 #include "panda/AlgorithmTuple.h"
34 
35 namespace ska {
36 namespace cheetah {
37 namespace dred {
38 
39 
45 template <typename T>
46 class Dred
47 {
48  public:
49  typedef panda::AlgorithmTuple<cuda::Dred<T>> Implementations;
50 
51  public:
57  Dred(Config const& config);
58  Dred(Dred const&) = delete;
59  Dred(Dred&&) = default;
60  ~Dred();
61 
80  template <typename Arch, typename Alloc, typename... Args>
81  void process(panda::PoolResource<Arch>& resource,
82  data::FrequencySeries<Arch, typename data::ComplexTypeTraits<Arch,T>::type, Alloc>const& input,
83  data::FrequencySeries<Arch, typename data::ComplexTypeTraits<Arch,T>::type, Alloc>& output,
84  data::AccelerationType maximum_acceleration,
85  Args&&... args);
86 
87  private:
88  Config const& _config;
89  Implementations _implementations;
90 };
91 
92 } // namespace dred
93 } // namespace cheetah
94 } // namespace ska
95 
96 #include "cheetah/dred/detail/Dred.cpp"
97 
98 #endif // SKA_CHEETAH_DRED_DRED_H
void process(panda::PoolResource< Arch > &resource, data::FrequencySeries< Arch, typename data::ComplexTypeTraits< Arch, T >::type, Alloc >const &input, data::FrequencySeries< Arch, typename data::ComplexTypeTraits< Arch, T >::type, Alloc > &output, data::AccelerationType maximum_acceleration, Args &&... args)
Deredden a complex frequency series.
Definition: Dred.cpp:45
Class for implementing spectral dereddening.
Definition: Dred.h:46
A helper class to determine the type of complex data for different architectures. ...
A container of Fourier series data.
Some limits and constants for FLDO.
Definition: Brdz.h:35
Algorithm configuration for the Dred module.
Definition: Config.h:47
Dred(Config const &config)
Construct a new Dred instance.
Definition: Dred.cpp:32