Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
DispersedPulse.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_DISPERSEDPULSE_H
25 #define SKA_CHEETAH_GENERATORS_DISPERSEDPULSE_H
26 
27 
28 #include "TimeFrequencyGenerator.h"
29 #include "DispersedPulseConfig.h"
30 #include "pss/astrotypes/units/DispersionMeasure.h"
31 
32 namespace ska {
33 namespace cheetah {
34 namespace generators {
35 
41 template<typename NumericalRep>
42 class DispersedPulse : public TimeFrequencyGenerator<NumericalRep>
43 {
45  typedef typename BaseT::DataType DataType;
46  typedef typename DataType::TimeType TimeType;
47 
48  public:
51  ~DispersedPulse();
52 
53  void next(DataType& data) override;
54 
55  private:
56  typedef double DispersionConstant; // TODO make boost::units::quantity in s_mhz_squared_cm_cubed_per_pc
57  DispersionConstant _dm_constant;
58  pss::astrotypes::units::DispersionMeasure<double> const _dm_measure;
59  TimeType _pulse_width;
60  NumericalRep _delta; // amount to increase signal by for pulse
61 };
62 
63 
64 } // namespace generators
65 } // namespace cheetah
66 } // namespace ska
67 #include "detail/DispersedPulse.cpp"
68 
69 #endif // SKA_CHEETAH_GENERATORS_DISPERSEDPULSE_H
Some limits and constants for FLDO.
Definition: Brdz.h:35
Configuration parameters for the DispersedPulse generator.
Inject a single pulse at a specified dispersion measure.