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_SIGPROC_CONFIG_H
25 #define SKA_CHEETAH_SIGPROC_CONFIG_H
26 
27 
28 #include "cheetah/utils/Config.h"
29 
30 namespace ska {
31 namespace cheetah {
32 namespace sigproc {
33 
40 {
41  public:
42  Config();
43  ~Config();
44 
48  std::vector<std::string> const& sigproc_files() const;
49 
53  void set_sigproc_files(std::vector<std::string> const& sigproc_files);
54  void set_sigproc_files(std::string sigproc_file);
55 
59  int nbits() const;
60 
64  unsigned chunk_samples() const;
65 
69  void set_chunk_samples(unsigned samples);
70 
71  protected:
72  void add_options(OptionsDescriptionEasyInit& add_options) override;
73 
74  private:
75  std::vector<std::string> _sigproc_files;
76  int _nbits;
77  unsigned _chunk_samples;
78 };
79 
80 } // namespace sigproc
81 } // namespace cheetah
82 } // namespace ska
83 
84 #endif // SKA_CHEETAH_SIGPROC_CONFIG_H
unsigned chunk_samples() const
return the number of time samples in a chunk
Definition: Config.cpp:74
Base class for module configuration.
Definition: Config.h:42
SigProc configuration parameters.
Definition: Config.h:39
void set_chunk_samples(unsigned samples)
setthe number of time samples in a chunk
Definition: Config.cpp:79
int nbits() const
return the default nbits to be used when not specified in sigproc file headers
Definition: Config.cpp:69
Some limits and constants for FLDO.
Definition: Brdz.h:35
void set_sigproc_files(std::vector< std::string > const &sigproc_files)
return the sigproc files to be processed as input data
Definition: Config.cpp:59
std::vector< std::string > const & sigproc_files() const
return the sigproc files to be processed as input data
Definition: Config.cpp:54