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_GENERATORS_CONFIG_H
25 #define SKA_CHEETAH_GENERATORS_CONFIG_H
26 
27 
28 #include "cheetah/utils/Config.h"
29 #include "cheetah/generators/GaussianNoiseConfig.h"
30 #include "cheetah/generators/BasebandGaussianNoiseConfig.h"
31 #include "cheetah/generators/DispersedPulseConfig.h"
32 #include "cheetah/generators/PulsarInjectionConfig.h"
33 
34 namespace ska {
35 namespace cheetah {
36 namespace generators {
37 
47 {
48  public:
49  typedef panda::ConfigModuleIteratorWrapper<PulsarInjectionConfig> PulsarInjectionIterartorType;
50 
51  public:
52  Config();
53  ~Config();
54 
55  GaussianNoiseConfig const& gaussian_noise() const;
56  BasebandGaussianNoiseConfig const& baseband_gaussian_noise() const;
58  PulsarInjectionIterartorType pulsar_injection_begin() const;
59  PulsarInjectionIterartorType pulsar_injection_end() const;
60 
61  DispersedPulseConfig const& dispersed_pulse() const;
62 
63  protected:
64  void add_options(OptionsDescriptionEasyInit& add_options) override;
65 
66  private:
67  GaussianNoiseConfig _gaussian_noise;
68  BasebandGaussianNoiseConfig _baseband_gaussian_noise;
69  DispersedPulseConfig _dispersed_pulse;
70 };
71 
72 
73 } // namespace generators
74 } // namespace cheetah
75 } // namespace ska
76 
77 #endif // SKA_CHEETAH_GENERATORS_CONFIG_H
Base class for module configuration.
Definition: Config.h:42
Generator Configuration file.
Definition: Config.h:46
PulsarInjectionIterartorType pulsar_injection_begin() const
access the pulsar iteration configuration options
Definition: Config.cpp:64
Some limits and constants for FLDO.
Definition: Brdz.h:35
Configuration parameters for the DispersedPulse generator.