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_SPS_CLUSTERING_CONFIG_H
25 #define SKA_CHEETAH_SPS_CLUSTERING_CONFIG_H
26 
27 #include "cheetah/utils/Config.h"
28 #include "cheetah/data/Units.h"
29 #include "pss/astrotypes/units/DispersionMeasure.h"
30 
31 namespace ska {
32 namespace cheetah {
33 namespace sps_clustering {
34 
40 class Config : public utils::Config
41 {
42  public:
43  typedef boost::units::quantity<data::MilliSeconds, double> MsecTimeType;
44  typedef pss::astrotypes::units::DispersionMeasure<float> Dm;
45 
46  public:
47  Config();
48  ~Config();
52  MsecTimeType time_tolerance() const;
53  void time_tolerance(MsecTimeType const& time_tolerance);
54 
58  MsecTimeType pulse_width_tolerance() const;
59  void pulse_width_tolerance(MsecTimeType const& width_tolerance);
60 
64  Dm dm_tolerance() const;
65  void dm_tolerance(Dm const& dm_tolerance);
66 
70  float linking_length() const;
71  void linking_length(float const& l);
72 
73  bool active() const;
74 
75  void num_threads(std::size_t const nt);
76  std::size_t num_threads() const;
77 
78  protected:
79  void add_options(OptionsDescriptionEasyInit& add_options) override;
80 
81  private:
82  MsecTimeType _pulse_width_tolerance;
83  MsecTimeType _time_tolerance;
84  Dm _dm_tolerance;
85  float _linking_length;
86  bool _active;
87  std::size_t _num_threads;
88 };
89 
90 
91 } // namespace sps_clustering
92 } // namespace cheetah
93 } // namespace ska
94 
95 #endif // SKA_CHEETAH_SPS_CLUSTERING_CONFIG_H
MsecTimeType pulse_width_tolerance() const
: Threshold for pulse widths between two candidates to be clustered in a single group ...
Definition: Config.cpp:87
Base class for module configuration.
Definition: Config.h:42
Some limits and constants for FLDO.
Definition: Brdz.h:35
Dm dm_tolerance() const
: Threshold for DM of two candidates to be clustered in a single group
Definition: Config.cpp:77
float linking_length() const
: The euclidean distance threshold in the DM, time, width parameter space between two candidates to b...
Definition: Config.cpp:107
MsecTimeType time_tolerance() const
: Threshold for time between two candidates to be clustered in a single group
Definition: Config.cpp:97