Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Config.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_TDAS_CONFIG_H
25 #define SKA_CHEETAH_TDAS_CONFIG_H
26 
27 #include "cheetah/utils/Config.h"
28 #include "cheetah/tdas/cuda/Config.h"
29 #include "cheetah/tdas/AccListGenConfig.h"
30 #include "cheetah/data/Units.h"
31 #include "cheetah/data/DedispersionMeasure.h"
32 #include "panda/PoolSelector.h"
33 
34 #include <vector>
35 
36 namespace ska {
37 namespace cheetah {
38 namespace tdas {
39 
48 {
49  public:
50  Config();
51  ~Config();
52 
56  cuda::Config const& cuda_config() const;
58 
64 
68  std::size_t dm_trials_per_task() const;
69  void dm_trials_per_task(std::size_t ntrials);
70 
74  std::size_t minimum_size() const;
75  void minimum_size(std::size_t minimum_size);
76 
84  std::size_t size() const;
85  void size(std::size_t size);
86 
90  void number_of_harmonic_sums(std::size_t nharmonics);
91  std::size_t number_of_harmonic_sums() const;
92 
96  bool active() const;
97 
98  protected:
99  void add_options(OptionsDescriptionEasyInit& add_options) override;
100 
101  private:
102  bool _active;
103  cuda::Config _cuda_config;
104  AccListGenConfig _acc_gen_config;
105  std::size_t _dm_trials_per_task;
106  std::size_t _size;
107  std::size_t _minimum_size;
108  std::size_t _nharmonics;
109 };
110 
111 typedef panda::PoolSelector<typename Config::PoolManagerType, Config> ConfigType;
112 
113 } // namespace tdas
114 } // namespace cheetah
115 } // namespace ska
116 
117 #endif // SKA_CHEETAH_TDAS_CONFIG_H
bool active() const
: check if the module is active
Definition: Config.cpp:132
AccListGenConfig const & acceleration_list_generator() const
Return acceleration list generator configuration.
Definition: Config.cpp:82
Base class for module configuration.
Definition: Config.h:42
AccelerationListGen configuration parameters.
std::size_t size() const
The size for transform to use for the search.
Definition: Config.cpp:112
cuda::Config const & cuda_config() const
Configuration details for the cuda based RFIM algorithm.
Definition: Config.cpp:72
std::size_t dm_trials_per_task() const
The number or DM trials to process in each Tdas async task.
Definition: Config.cpp:92
Some limits and constants for FLDO.
Definition: Brdz.h:35
std::size_t minimum_size() const
The minimum timeseries length that will be searched.
Definition: Config.cpp:102
void number_of_harmonic_sums(std::size_t nharmonics)
Number of harmonic sums to perform in the search.
Definition: Config.cpp:122