Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Fldo.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_FLDO_FLDO_H
25 #define SKA_CHEETAH_FLDO_FLDO_H
26 
27 #include "cheetah/fldo/Config.h"
28 #include "cheetah/fldo/Types.h"
29 #include "cheetah/fldo/cuda/Fldo.h"
30 #include "cheetah/fldo/cpu/Fldo.h"
31 #include "cheetah/fldo/detail/FldoModule.h"
32 
33 namespace ska {
34 namespace cheetah {
35 namespace fldo {
36 
37 template<class FldoTraitsT>
38 using FldoAlgos = FldoModule<FldoTraitsT
39  , cpu::Fldo<FldoTraitsT>
40 #ifdef ENABLE_CUDA
41  , cuda::Fldo<FldoTraitsT>
42 #endif // ENABLE_CUDA
43  >;
44 
53 template<typename Handler, typename NumericalT, class ConfigType=fldo::ConfigType>
54 class Fldo : protected FldoAlgos<FldoTraits<ConfigType, Handler, NumericalT>>
55 {
57 
58  typedef typename BaseT::TimeFrequencyType TimeFrequencyType;
59 
60  public:
64  Fldo(ConfigType const&, Handler&);
65 
70  std::shared_ptr<panda::ResourceJob> operator()(std::vector<std::shared_ptr<TimeFrequencyType>>& tf_data
71  , data::Scl const& scl_data);
72 
73 };
74 
75 
76 } // namespace fldo
77 } // namespace cheetah
78 } // namespace ska
79 
80 #include "cheetah/fldo/detail/Fldo.cpp"
81 
82 #endif // SKA_CHEETAH_FLDO_FLDO_H
Setup template paramterised Fldo algorithms for use as a module.
Definition: FldoModule.h:45
The FLDO primary API.
Definition: Fldo.h:54
std::shared_ptr< panda::ResourceJob > operator()(std::vector< std::shared_ptr< TimeFrequencyType >> &tf_data, data::Scl const &scl_data)
generic call for an async fldo task - the handler will be called on completion utilising any device i...
Definition: Fldo.cpp:41
Fldo(ConfigType const &, Handler &)
initiate the Fldo aglorithm passing it the handler to be called on completion of the task ...
Definition: Fldo.cpp:34
Some limits and constants for FLDO.
Definition: Brdz.h:35
Sifted Candidate List.
Definition: Scl.h:45