Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
FlagPolicy.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_RFIM_FLAGPOLICY_H
25 #define SKA_CHEETAH_RFIM_FLAGPOLICY_H
26 
27 #include "cheetah/data/RfimFlaggedData.h"
28 #include "cheetah/data/TimeFrequency.h"
29 #include <type_traits>
30 
31 namespace ska {
32 namespace cheetah {
33 namespace rfim {
34 
39 template<typename TimeFrequencyType>
41 {
42  typedef typename TimeFrequencyType::DataType NumericalRep;
44  typedef typename TimeFrequencyType::Channel Channel;
45 
46  public:
47  typedef std::shared_ptr<FlaggedDataType> ReturnType;
48 
49  FlagPolicyAdapter(TimeFrequencyType&);
51  ReturnType data();
52 
53  template<typename SliceT>
54  typename std::enable_if<pss::astrotypes::is_slice<SliceT>::value, void>::type
55  mark_good(SliceT const&);
56  void mark_good(NumericalRep const&, data::DimensionIndex<data::Frequency> channel_number);
57 
58  template<typename SliceT>
59  typename std::enable_if<pss::astrotypes::is_slice<SliceT>::value, void>::type
60  mark_bad(SliceT const& slice);
61 
62  void mark_bad(NumericalRep const&, data::DimensionIndex<data::Frequency>);
63 
64  private:
65  ReturnType _data;
67 };
68 
69 template<typename TimeFrequencyType>
71 {
72  public:
74  typedef typename Adapter::ReturnType ReturnType;
75 
76  public:
77  FlagPolicy();
78  ~FlagPolicy();
79  Adapter adapter(TimeFrequencyType& data) const;
80 };
81 
82 } // namespace rfim
83 } // namespace cheetah
84 } // namespace ska:w
85 
86 #include "detail/FlagPolicy.cpp"
87 
88 #endif // SKA_CHEETAH_RFIM_FLAGPOLICY_H
TimeFrequency data with flags representing rfim detection.
Some limits and constants for FLDO.
Definition: Brdz.h:35
Does not change the data, but prduces a set of boolena flags to indicate suspected interference...
Definition: FlagPolicy.h:40