Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Rfim.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_RFIM_H
25 #define SKA_CHEETAH_RFIM_RFIM_H
26 
27 #include "cheetah/rfim/Config.h"
28 #include "cheetah/rfim/PolicyInfo.h"
29 #include "cheetah/rfim/DefaultRfimTraits.h"
30 #include "panda/ConfigurableTask.h"
31 #include <memory>
32 #include <functional>
33 
34 namespace ska {
35 namespace cheetah {
36 namespace rfim {
37 
43 template<typename TimeFrequencyType, typename RfimTraits=DefaultRfimTraits<TimeFrequencyType>
44  , typename ConfigType=panda::PoolSelector<typename Config::PoolManagerType, Config>>
45 class Rfim
46 {
47  typedef typename TimeFrequencyType::DataType NumericRep;
48  typedef typename RfimTraits::Policy PolicyType;
49  typedef typename PolicyInfo<PolicyType>::DataArgumentType ArgumentType;
50 
51  public:
52  typedef typename PolicyInfo<PolicyType>::ReturnType ReturnType;
53 
54  public:
55  Rfim(ConfigType const&, typename RfimTraits::RfimHandler&, typename RfimTraits::BandPassHandler&);
56  Rfim(Rfim const&) = delete;
57  ~Rfim();
58 
62  void run(ArgumentType data);
63 
64  private: // typedef
65  typedef panda::ConfigurableTask<typename Config::PoolType, typename RfimTraits::RfimHandler&, std::shared_ptr<TimeFrequencyType>> Task;
66  template<typename Algo> using Select = typename Task::template Select<Algo>;
67 
68  private: // members
69  Task _task;
70 };
71 
72 
73 } // namespace rfim
74 } // namespace cheetah
75 } // namespace ska
76 #include "cheetah/rfim/detail/Rfim.cpp"
77 
78 #endif // SKA_CHEETAH_RFIM_RFIM_H
std::conditional< std::is_same< void, AdapterDataReturnType >::value, DataArgumentType, AdapterDataReturnType >::type ReturnType
the data type the policy will return
Definition: PolicyInfo.h:67
Main API for RFIM functionality.
Definition: Rfim.h:45
Some limits and constants for FLDO.
Definition: Brdz.h:35
void run(ArgumentType data)
detect and remove rfi from the dataset
Definition: Rfim.cpp:171
std::conditional< std::is_member_function_pointer< AdapterFuncType >::value, typename boost::mpl::at_c< boost::function_types::parameter_types< AdapterFuncType >, 1 >::type, typename boost::mpl::at_c< boost::function_types::parameter_types< AdapterFuncType >, 0 >::type >::type DataArgumentType
The argument type that is to be expected to represent the TimeFrequencyData.
Definition: PolicyInfo.h:62