Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
SpSift.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_SPSIFT_SPSIFT_H
25 #define SKA_CHEETAH_SPSIFT_SPSIFT_H
26 
27 #include "cheetah/spsift/Config.h"
28 #include "cheetah/data/SpCcl.h"
29 
30 namespace ska {
31 namespace cheetah {
32 namespace spsift {
33 
39 class SpSift
40 {
41  public:
42  SpSift(Config const& config);
43  ~SpSift();
44 
48  Config const& config() const;
49 
53  template<typename NumRep>
54  void operator()(data::SpCcl<NumRep>& candidate_list) const;
55 
56  private:
57  Config const& _config;
58 };
59 
60 } // namespace spsift
61 } // namespace cheetah
62 } // namespace ska
63 #include "cheetah/spsift/detail/SpSift.cpp"
64 #endif // SKA_CHEETAH_SPSIFT_SPSIFT_H
Some limits and constants for FLDO.
Definition: Brdz.h:35
SpCandidate list.
Definition: SpCcl.h:52
A module to sift through Single Pulse candidates based on some threshold in width, DM and S/N.
Definition: SpSift.h:39
void operator()(data::SpCcl< NumRep > &candidate_list) const
remove candidates that do not fir the configured criteria
Definition: SpSift.cpp:33
Config const & config() const
return the Configuration object
Definition: SpSift.cpp:41