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_SPSIFT_CONFIG_H
25 #define SKA_CHEETAH_SPSIFT_CONFIG_H
26 
27 
28 #include "cheetah/utils/Config.h"
29 #include "cheetah/data/Units.h"
30 #include "pss/astrotypes/units/DispersionMeasure.h"
31 
32 namespace ska {
33 namespace cheetah {
34 namespace spsift {
35 
41 class Config : public utils::Config
42 {
43  public:
44  typedef boost::units::quantity<data::MilliSeconds, double> MsecTimeType;
45  typedef pss::astrotypes::units::DispersionMeasure<float> Dm;
46 
47  public:
48  Config();
49  ~Config();
50 
51  MsecTimeType pulse_width_threshold() const;
52  void pulse_width_threshold(MsecTimeType const& width_threshold);
53 
54  float sigma_threshold() const;
55  void sigma_threshold(float const& sigma_threshold);
56 
57  Dm dm_threshold() const;
58  void dm_threshold(Dm const& _dm_threshold);
59 
60  std::size_t maximum_candidates() const;
61  void maximum_candidates(std::size_t const& numcands_threshold);
62 
63  bool active() const;
64 
65  protected:
66  void add_options(OptionsDescriptionEasyInit& add_options) override;
67 
68  private:
69  MsecTimeType _pulse_width_threshold;
70  float _sigma_threshold;
71  Dm _dm_threshold;
72  std::size_t _maximum_candidates;
73  bool _active;
74 };
75 
76 
77 } // namespace spsift
78 } // namespace cheetah
79 } // namespace ska
80 
81 #endif // SKA_CHEETAH_SPSIFT_CONFIG_H
Base class for module configuration.
Definition: Config.h:42
Some limits and constants for FLDO.
Definition: Brdz.h:35