Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
DispersedPulseConfig.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_DISPERSEDPULSECONFIG_H
25 #define SKA_CHEETAH_GENERATORS_DISPERSEDPULSECONFIG_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 generators {
35 
41 {
43  typedef boost::units::quantity<boost::units::si::time, double> TimeType;
44 
45  public:
46  DispersedPulseConfig(std::string const& tag_name="dispersed_pulse");
48 
52  pss::astrotypes::units::DispersionMeasure<double> dispersion_measure() const;
53 
57  TimeType pulse_width() const;
58 
60  double delta() const;
61 
62  protected:
63  void add_options(OptionsDescriptionEasyInit&) override;
64 
65  private:
66  pss::astrotypes::units::DispersionMeasure<double> _dispersion_measure;
67  double _delta; // amount to increase signal by for pulse
68  TimeType _pulse_width;
69 };
70 
71 
72 } // namespace generators
73 } // namespace cheetah
74 } // namespace ska
75 
76 #endif // SKA_CHEETAH_GENERATORS_DISPERSEDPULSECONFIG_H
pss::astrotypes::units::DispersionMeasure< double > dispersion_measure() const
the Dispersin Measure of the pulse
Base class for module configuration.
Definition: Config.h:42
Some limits and constants for FLDO.
Definition: Brdz.h:35
Configuration parameters for the DispersedPulse generator.
TimeType pulse_width() const
The pulse width (ms)
double delta() const
the brightness of the pulse (signal increase from background)