Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
PacketGeneratorConfig.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_RCPT_LOW_PACKETGENERATORCONFIG_H
25 #define SKA_CHEETAH_RCPT_LOW_PACKETGENERATORCONFIG_H
26 
27 
28 #include "cheetah/utils/Config.h"
29 #include "cheetah/data/Units.h"
30 
31 namespace ska {
32 namespace cheetah {
33 namespace rcpt_low {
34 
40 {
41  public:
42  typedef boost::units::quantity<ska::cheetah::data::MegaHertz, double> FrequencyType;
43  public:
45 
47 
51  const data::DimensionSize<data::Frequency>& number_of_channels() const;
52  void number_of_channels(const data::DimensionSize<data::Frequency>& value);
53 
57  const data::DimensionSize<data::Time>& number_of_spectra() const;
58  void number_of_spectra(const data::DimensionSize<data::Time>& value);
59 
63  const std::chrono::microseconds& interval() const;
64  void interval(std::chrono::microseconds value);
65 
69  const FrequencyType& bandwidth() const;
70 
74  const FrequencyType& fch1() const;
75 
79  const std::size_t& number_of_channels_per_packet() const;
80 
81  protected:
82  void add_options(OptionsDescriptionEasyInit& add_options) override;
83 
84  private:
85  data::DimensionSize<data::Frequency> _number_of_channels;
86  data::DimensionSize<data::Time> _number_of_spectra;
87  FrequencyType _bandwidth;
88  FrequencyType _fch1;
89  std::size_t _number_of_channels_per_packet;
90  std::chrono::microseconds _interval;
91 };
92 
93 } // namespace rcpt_low
94 } // namespace cheetah
95 } // namespace ska
96 
97 #endif // SKA_CHEETAH_RCPT_LOW_PACKETGENERATORCONFIG_H
const FrequencyType & fch1() const
returns frequency of the highest channel.
Base class for module configuration.
Definition: Config.h:42
const std::chrono::microseconds & interval() const
time sepearation between consequetive packets in micro seconds
const FrequencyType & bandwidth() const
returns the bandwidth in Megahertz
Some limits and constants for FLDO.
Definition: Brdz.h:35
const data::DimensionSize< data::Frequency > & number_of_channels() const
number of channels per chunk
const std::size_t & number_of_channels_per_packet() const
return the number of channels per packet
const data::DimensionSize< data::Time > & number_of_spectra() const
number of spectra per packet
Configuration for the packet generator to the time seperation of the packets.