Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Buffering.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_DDTR_BUFFERING_H
25 #define SKA_CHEETAH_DDTR_BUFFERING_H
26 
27 #include "CommonDedispersionPlan.h"
28 
29 namespace ska {
30 namespace cheetah {
31 namespace ddtr {
32 
37 template<typename DdtrTraits, typename PlanType>
38 class Buffering
39 {
40  typedef typename DdtrTraits::BufferFillerType BufferFillerType;
41  typedef typename DdtrTraits::TimeFrequencyType TimeFrequencyType;
42  typedef typename BufferFillerType::FullBufferHandlerT BufferFullCallBack;
43 
44  public:
45  Buffering(BufferFullCallBack const& callback, PlanType const& plan, std::size_t max_buffer_size);
46  Buffering(Buffering const&) = delete;
47  Buffering(Buffering&&) = delete;
48  ~Buffering();
49 
50  template<typename DataT>
51  void operator()(DataT const& data);
52 
53  private:
54  void agg_buffer_init(TimeFrequencyType const&);
55 
56  template<typename DataT>
57  void agg_buffer_fill(DataT&);
58 
59  private:
60  data::DimensionSize<data::Time> _max_spectra;
61  std::size_t _current_number_of_channels;
62  BufferFillerType _agg_buf_filler;
63  PlanType _plan;
64 };
65 
66 
67 } // namespace ddtr
68 } // namespace cheetah
69 } // namespace ska
70 #include "Buffering.cpp"
71 
72 #endif // SKA_CHEETAH_DDTR_BUFFERING_H
Some limits and constants for FLDO.
Definition: Brdz.h:35
Buffering layer to collect sufficient data for the ddtr algorithm to run.
Definition: Buffering.h:38