Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
DispersedPulseConfig.cpp
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 #include "cheetah/generators/DispersedPulseConfig.h"
25 #include "panda/BoostQuantityOption.h"
26 
27 namespace ska {
28 namespace cheetah {
29 namespace generators {
30 
31 
32 DispersedPulseConfig::DispersedPulseConfig(std::string const& tag_name)
33  : BaseT(tag_name)
34  , _dispersion_measure(500.0 * pss::astrotypes::units::parsecs_per_cube_cm)
35  , _delta(1.0)
36  , _pulse_width(3.0 * boost::units::si::milli * boost::units::si::seconds)
37 {
38 }
39 
40 DispersedPulseConfig::~DispersedPulseConfig()
41 {
42 }
43 
44 pss::astrotypes::units::DispersionMeasure<double> DispersedPulseConfig::dispersion_measure() const
45 {
46  return _dispersion_measure;
47 }
48 
50 {
51  return _delta;
52 }
53 
54 DispersedPulseConfig::TimeType DispersedPulseConfig::pulse_width() const
55 {
56  return _pulse_width;
57 }
58 
59 void DispersedPulseConfig::add_options(OptionsDescriptionEasyInit& add_options)
60 {
61  add_options
62  ("dm", boost::program_options::value<decltype(_dispersion_measure)>(&_dispersion_measure)->default_value(_dispersion_measure)
63  , "dispersion measure of the pulse")
64  ("pulse_width", boost::program_options::value<TimeType>(&_pulse_width)->default_value(_pulse_width)
65  , "the width of the pulse (in seconds)")
66  ("signal_delta", boost::program_options::value<double>(&_delta)->default_value(_delta)
67  , "signal strength above the background");
68 }
69 
70 } // namespace generators
71 } // namespace cheetah
72 } // namespace ska
Definition: Units.h:112
pss::astrotypes::units::DispersionMeasure< double > dispersion_measure() const
the Dispersin Measure of the pulse
Some limits and constants for FLDO.
Definition: Brdz.h:35
TimeType pulse_width() const
The pulse width (ms)
double delta() const
the brightness of the pulse (signal increase from background)