Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Brdz.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_BRDZ_BRDZ_H
25 #define SKA_CHEETAH_BRDZ_BRDZ_H
26 
27 #include "cheetah/brdz/Config.h"
28 #include "cheetah/brdz/cuda/Brdz.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 brdz {
38 
47 class Brdz
48 {
49  private:
50  typedef panda::AlgorithmTuple<cuda::Brdz> Implementations;
51 
52  public:
53 
59  Brdz(Config const& config);
60  Brdz(Brdz const&) = delete;
61  Brdz(Brdz&&) = default;
62  ~Brdz();
63 
79  template <typename Arch, typename T, typename Alloc, typename... Args>
80  void process(panda::PoolResource<Arch>& resource,
82  Args&&... args);
83 
84  private:
85  Config const& _config;
86  Implementations _implementations;
87 };
88 
89 
90 } // namespace brdz
91 } // namespace cheetah
92 } // namespace ska
93 #include "cheetah/brdz/detail/Brdz.cpp"
94 
95 #endif // SKA_CHEETAH_BRDZ_BRDZ_H
void process(panda::PoolResource< Arch > &resource, data::FrequencySeries< Arch, typename data::ComplexTypeTraits< Arch, T >::type, Alloc > &input, Args &&... args)
Excise the power for birdie frequencies in a spectrum.
Definition: Brdz.cpp:32
Brdz(Config const &config)
Create a new Brdz instance.
Definition: Brdz.cpp:30
Configuration for the BRDZ module.
Definition: Config.h:43
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
Class for performing birdie zapping.
Definition: Brdz.h:47