Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
DedispersionConfig.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_DDTR_DEDISPERSIONCONFIG_H
25 #define SKA_CHEETAH_DDTR_DEDISPERSIONCONFIG_H
26 
27 
28 #include "cheetah/utils/Config.h"
29 #include "cheetah/data/Units.h"
30 #include "cheetah/data/DedispersionMeasure.h"
31 
32 namespace ska {
33 namespace cheetah {
34 namespace ddtr {
35 
43 {
44  public:
45  typedef data::DedispersionMeasureType<float> Dm;
46 
47  public:
49  DedispersionConfig(Dm start, Dm stop, Dm step);
51 
55  Dm dm_start() const;
56  void dm_start(Dm);
57 
61  Dm dm_end() const;
62  void dm_end(Dm);
63 
67  Dm dm_step() const;
68  void dm_step(Dm);
69 
70  protected:
71  void add_options(OptionsDescriptionEasyInit& add_options) override;
72 
73  private:
74  Dm _dm_start;
75  Dm _dm_end;
76  Dm _dm_step;
77 };
78 
79 
80 } // namespace ddtr
81 } // namespace cheetah
82 } // namespace ska
83 
84 #endif // SKA_CHEETAH_DDTR_DEDISPERSIONCONFIG_H
Base class for module configuration.
Definition: Config.h:42
Dm dm_start() const
the first dm condidate to try
describes dedispersion configuration
Some limits and constants for FLDO.
Definition: Brdz.h:35
Dm dm_end() const
the last dm condidate to try
Dm dm_step() const
the step size to take in generating dm trials between start and end