Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
AccListGenConfig.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_TDRT_ACCELERATIONLISTGENCONFIG_H
25 #define SKA_CHEETAH_TDRT_ACCELERATIONLISTGENCONFIG_H
26 
27 #include "cheetah/utils/Config.h"
28 #include "cheetah/data/Units.h"
29 #include "cheetah/data/DedispersionMeasure.h"
30 #include <cmath>
31 
32 namespace ska {
33 namespace cheetah {
34 namespace tdas {
35 
42 {
43  public:
46 
50  double acc_lo() const;
51  void acc_lo(double);
52 
56  double acc_hi() const;
57  void acc_hi(double);
58 
62  double tolerance() const;
63  void tolerance(double);
64 
68  double pulse_width() const;
69  void pulse_width(double);
70 
74  double cfreq() const;
75  void cfreq(double);
76 
80  double bw() const;
81  void bw(double);
82 
86  data::AccelerationType magnitude() const;
87 
97  std::vector<data::AccelerationType> acceleration_list(data::DedispersionMeasureType<float> dm,
98  std::size_t number_of_samples,
99  double sampling_interval) const;
100 
101  protected:
102  void add_options(OptionsDescriptionEasyInit& add_options) override;
103 
104  private:
105  double _acc_lo;
106  double _acc_hi;
107  double _tol;
108  double _pulse_width;
109  double _cfreq;
110  double _bw;
111 };
112 
113 } // namespace tdas
114 } // namespace cheetah
115 } // namespace ska
116 
117 #endif // SKA_CHEETAH_TDRT_ACCELERATIONLISTGENCONFIG_H
double acc_lo() const
return/set the acceleration start m/s/s
Base class for module configuration.
Definition: Config.h:42
double cfreq() const
return/set the centre frequency of the data block (in MHz)
AccelerationListGen configuration parameters.
Some limits and constants for FLDO.
Definition: Brdz.h:35
std::vector< data::AccelerationType > acceleration_list(data::DedispersionMeasureType< float > dm, std::size_t number_of_samples, double sampling_interval) const
Generate a list of accelerations.
double pulse_width() const
return/set the minimum pulse width for which acc_tol is valid (in us)
double tolerance() const
return/set the acceleration smearing tolerance (1.11=10%)
double acc_hi() const
return/set the acceleration end m/s/s/ m/s/s
double bw() const
return the channel bandwidth (in MHz)
data::AccelerationType magnitude() const
return the maximum absolute acceleration magnitude