Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Dedispersion.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_DEDISPERSION_H
25 #define SKA_CHEETAH_PIPELINE_DEDISPERSION_H
26 
27 #include "cheetah/pipeline/PipelineHandler.h"
28 #include "cheetah/sps/Sps.h"
29 #include <memory>
30 
31 namespace ska {
32 namespace cheetah {
33 namespace pipeline {
34 
35 template<typename NumericalT>
36 class CheetahConfig;
37 
38 template<typename NumericalT>
39 class BeamConfig;
40 
45 template<typename NumericalT>
46 class Dedispersion : public PipelineHandler<NumericalT>
47 {
50 
51  public:
53  typedef typename Sps::DmHandler DmHandler;
54  typedef typename std::shared_ptr<typename Sps::DmTrialType> DmTrialType;
55  typedef NumericalT NumericalRep;
56 
57  public:
58  Dedispersion(CheetahConfig<NumericalT> const& config, BeamConfig<NumericalT> const& beam_config, DmHandler const& dm_handler = [](DmTrialType const&){});
59  ~Dedispersion() = 0;
60 
61  void operator()(TimeFrequencyType&) override = 0;
62 
63  protected:
64  DmHandler _dm_handler;
65 };
66 
67 
68 } // namespace pipeline
69 } // namespace cheetah
70 } // namespace ska
71 #include "detail/Dedispersion.cpp"
72 
73 #endif // SKA_CHEETAH_PIPELINE_DEDISPERSION_H
void operator()(TimeFrequencyType &) override=0
called each time data becomes available
Single Pulse Search top level interface.
Definition: Sps.h:61
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
Base class for dedispersion pipeline handlers.
Definition: Dedispersion.h:46