Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Config.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_RFIM_IQRMCPU_CONFIG_H
25 #define SKA_CHEETAH_RFIM_IQRMCPU_CONFIG_H
26 
27 #include "cheetah/utils/Config.h"
28 
29 namespace ska {
30 namespace cheetah {
31 namespace rfim {
32 namespace iqrmcpu {
33 
38 class Config : public utils::Config
39 {
40  public:
41  Config();
42  ~Config();
43 
47  bool active() const;
48 
49 
53  std::size_t max_lag() const;
54 
58  float nsigma() const;
59 
63  std::size_t edge_channels() const;
64 
65  protected:
66  void add_options(OptionsDescriptionEasyInit& add_options) override;
67 
68  private:
69  bool _active;
70  std::size_t _max_lag;
71  float _nsigma;
72  std::size_t _edge_channels;
73 };
74 
75 
76 } // namespace iqrmcpu
77 } // namespace rfim
78 } // namespace cheetah
79 } // namespace ska
80 
81 #endif // SKA_CHEETAH_RFIM_IQRMCPU_CONFIG_H
Base class for module configuration.
Definition: Config.h:42
std::size_t edge_channels() const
Number of edge channels to flag.
Definition: Config.cpp:69
Some limits and constants for FLDO.
Definition: Brdz.h:35
std::size_t max_lag() const
max lag in number of channels
Definition: Config.cpp:59
float nsigma() const
threshold in units of sigma for flagging
Definition: Config.cpp:64
bool active() const
indicate if the algorithm is to be used
Definition: Config.cpp:54