Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Sift.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_SIFT_SIMPLESIFT_SIFT_H
25 #define SKA_CHEETAH_SIFT_SIMPLESIFT_SIFT_H
26 
27 #include "cheetah/sift/simple_sift/Config.h"
28 #include "cheetah/sift/Config.h"
29 #include "cheetah/data/Candidate.h"
30 #include "cheetah/data/Units.h"
31 #include "cheetah/data/Ccl.h"
32 #include "cheetah/data/Scl.h"
33 #include "cheetah/utils/Architectures.h"
34 
35 namespace ska {
36 namespace cheetah {
37 namespace sift {
38 namespace simple_sift {
39 
43 class Sift
44 {
45  public:
46  typedef cheetah::Cpu Architecture;
47  typedef cheetah::Cpu ArchitectureCapability;
49 
50  typedef panda::PoolResource<Architecture> ResourceType;
51 
52  public:
53 
60  Sift(sift::Config const& config);
61  Sift(Sift const&) = delete;
62  Sift(Sift&&) = default;
63 
72  std::shared_ptr<data::Scl> operator()(ResourceType& cpu, data::Ccl& ccl) const;
73  std::shared_ptr<data::Scl> operator()(ResourceType& cpu, std::shared_ptr<data::Ccl> const& ccl) const;
74 
75  private:
76  Config const& _config;
77 
78 };
79 
80 } //simple_sift
81 } //sift
82 } //cheetah
83 } //ska
84 
85 #include "cheetah/sift/simple_sift/detail/Sift.cpp"
86 
87 #endif //SKA_CHEETAH_SIFT_SIMPLESIFT_SIFT_H
Sift(sift::Config const &config)
Construct a new Sift instance.
Definition: Sift.cpp:33
Configuration for the simple_sift module.
Definition: Config.h:38
std::shared_ptr< data::Scl > operator()(ResourceType &cpu, data::Ccl &ccl) const
Sift a candidate list to aggregate like signals.
Definition: Sift.cpp:48
Some limits and constants for FLDO.
Definition: Brdz.h:35
Configuration for the sift module.
Definition: Config.h:39
Candidate list.
Definition: Ccl.h:45
simple_sift algorithm for the Sift module
Definition: Sift.h:43