Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
SinglePulse.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_PIPELINE_SINGLEPULSE_H
25 #define SKA_CHEETAH_PIPELINE_SINGLEPULSE_H
26 
27 #include "cheetah/pipeline/Dedispersion.h"
28 #include <memory>
29 
30 namespace ska {
31 namespace cheetah {
32 namespace pipeline {
33 
34 template<typename NumericalT>
35 class CheetahConfig;
36 
37 template<typename NumericalT>
38 class BeamConfig;
39 
45 template<typename NumericalT>
46 class SinglePulse : public Dedispersion<NumericalT>
47 {
50  typedef typename BaseT::DmHandler DmHandler;
51  typedef typename BaseT::DmTrialType DmTrialType;
52 
53  public:
54  SinglePulse(CheetahConfig<NumericalT> const& config, BeamConfig<NumericalT> const& beam_config, DmHandler const& dm_handler = [](DmTrialType){});
56  ~SinglePulse();
57 
58  void operator()(TimeFrequencyType&) override;
59 
60  private:
61  std::unique_ptr<Dedispersion<NumericalT>> _spimpl;
62 };
63 
64 
65 } // namespace pipeline
66 } // namespace cheetah
67 } // namespace ska
68 #include "detail/SinglePulse.cpp"
69 
70 #endif // SKA_CHEETAH_PIPELINE_SINGLEPULSE_H
void operator()(TimeFrequencyType &) override
called each time data becomes available
Definition: SinglePulse.cpp:51
Some limits and constants for FLDO.
Definition: Brdz.h:35
Parse configuration parameters for a single beam in the pipeline instance of cheetah.
Definition: BeamConfig.h:48
Base class for Cheetah Pipeline Handlers.
Definition: Pipeline.h:37
A Single Pulse Search Pipeline.
Definition: SinglePulse.h:46
Base class for dedispersion pipeline handlers.
Definition: Dedispersion.h:46