Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
RfiExcisionFactory.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_SPS_RFIEXCISIONFACTORY_H
25 #define SKA_CHEETAH_SPS_RFIEXCISIONFACTORY_H
26 
27 #include "cheetah/data/TimeFrequency.h"
28 #include "cheetah/data/RfimFlaggedData.h"
29 #include "cheetah/sps/detail/RfiExcision.h"
30 #include "cheetah/sps/RfiExcisionConfig.h"
31 #include "panda/AggregationBufferFiller.h"
32 
33 namespace ska {
34 namespace cheetah {
35 namespace sps {
36 
41 template<typename TimeFrequencyType>
42 class RfiExcisionFactory: public ska::panda::BeginEndFactory<TimeFrequencyType>
43 {
44  typedef ska::panda::BeginEndFactory<TimeFrequencyType> BaseT;
45 
46  public:
50 
51  public:
52  RfiExcisionFactory( RfiExcisionConfig const& config);
54 
55  using BaseT::begin;
56  using BaseT::end;
57 
58  inline Iterator begin(RfiFlagDataType& data);
59  inline ConstIterator begin(RfiFlagDataType const& data);
60  inline Iterator end(RfiFlagDataType& data);
61  inline ConstIterator end(RfiFlagDataType const& data);
62 
63  private:
64  RfiExcisionConfig const& _config;
65 };
66 
67 } // namespace sps
68 } // namespace cheetah
69 } // namespace ska
70 #include "cheetah/sps/detail/RfiExcisionFactory.cpp"
71 #endif // SKA_CHEETAH_SPS_RFIEXCISIONFACTORY_H
Configuration for the paramters for flagging RFI during copy to the Aggregate buffer two main paramet...
TimeFrequency data with flags representing rfim detection.
Some limits and constants for FLDO.
Definition: Brdz.h:35