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_TDAO_CONFIG_H
25 #define SKA_CHEETAH_TDAO_CONFIG_H
26 
27 #include "cheetah/tdao/cuda/Config.h"
28 #include "cheetah/utils/Config.h"
29 #include "cheetah/data/Units.h"
30 
31 namespace ska {
32 namespace cheetah {
33 namespace tdao {
34 
42 {
43  public:
44  Config();
45  ~Config();
46 
50  cuda::Config const& cuda_config() const;
51 
55  float significance_threshold() const;
56  void significance_threshold(float);
57 
61  data::FourierFrequencyType minimum_frequency() const;
62  void minimum_frequency(data::FourierFrequencyType const&);
63 
67  data::FourierFrequencyType maximum_frequency() const;
68  void maximum_frequency(data::FourierFrequencyType const&);
69 
70  protected:
71  void add_options(OptionsDescriptionEasyInit& add_options) override;
72 
73  private:
74  cuda::Config _cuda_config;
75  float _threshold;
76  data::FourierFrequencyType _min_frequency;
77  data::FourierFrequencyType _max_frequency;
78 };
79 
80 } // namespace tdao
81 } // namespace cheetah
82 } // namespace ska
83 
84 #endif // SKA_CHEETAH_TDAO_CONFIG_H
Base class for module configuration.
Definition: Config.h:42
data::FourierFrequencyType maximum_frequency() const
The maximum frequency to search for candidates at.
Definition: Config.cpp:69
float significance_threshold() const
The significance threshold for candidates.
Definition: Config.cpp:49
data::FourierFrequencyType minimum_frequency() const
The minumum frequency to search for candidates at.
Definition: Config.cpp:59
cuda::Config const & cuda_config() const
The cuda implementation configuration for Tdao.
Definition: Config.cpp:44
Some limits and constants for FLDO.
Definition: Brdz.h:35