Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
RfiGenerator.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_GENERATORS_RFIGENERATOR_H
25 #define SKA_CHEETAH_GENERATORS_RFIGENERATOR_H
26 
27 
28 #include "TimeFrequencyGenerator.h"
29 #include "cheetah/data/RfimFlaggedData.h"
30 
31 namespace ska {
32 namespace cheetah {
33 namespace generators {
34 
40 template<typename T>
42 {
43  protected:
46 
47 
48  public:
49  RfiGenerator();
50  ~RfiGenerator();
51 
52  void next(DataType& data) override;
53  virtual void next(FlaggedDataType& data) = 0;
54 
55  void rfi_gaussian_block(FlaggedDataType& data
56  , std::size_t min_channel
57  , std::size_t max_channel
58  , std::size_t min_sample_number
59  , std::size_t max_sample_number
60  , float sigma);
61 
62  void rfi_ramp_block(FlaggedDataType& data
63  , std::size_t min_channel
64  , std::size_t max_channel
65  , std::size_t min_sample_number
66  , std::size_t max_sample_number);
67 
68  void rfi_broadband_block(FlaggedDataType& data
69  , std::size_t min_sample_number
70  , std::size_t max_sample_number
71  , float sigma);
72 
73 };
74 
75 
76 } // namespace generators
77 } // namespace cheetah
78 } // namespace ska
79 #include "detail/RfiGenerator.cpp"
80 
81 #endif // SKA_CHEETAH_GENERATORS_RFIGENERATOR_H
TimeFrequency data with flags representing rfim detection.
Some limits and constants for FLDO.
Definition: Brdz.h:35