Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Birdie.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_DATA_BIRDIE_H
25 #define SKA_CHEETAH_DATA_BIRDIE_H
26 
27 #include "cheetah/data/Units.h"
28 
29 namespace ska {
30 namespace cheetah {
31 namespace data {
32 
33 
41 class Birdie
42 {
43 public:
44 
48  Birdie();
49 
56  Birdie(data::FourierFrequencyType const& frequency, data::FourierFrequencyType const& width);
57  Birdie(Birdie const&) = default;
58  Birdie(Birdie&&) = default;
59  ~Birdie();
60 
64  Birdie& operator=(Birdie const&) = default;
65 
71  void frequency(data::FourierFrequencyType const& frequency);
72 
78  data::FourierFrequencyType const& frequency() const;
79 
85  void width(data::FourierFrequencyType const& width);
86 
92  data::FourierFrequencyType const& width() const;
93 
94 private:
95  data::FourierFrequencyType _frequency;
96  data::FourierFrequencyType _width;
97 };
98 
99 
100 } // namespace data
101 } // namespace cheetah
102 } // namespace ska
103 
104 #endif // SKA_CHEETAH_DATA_BIRDIE_H
Birdie & operator=(Birdie const &)=default
Copy assignment.
Some limits and constants for FLDO.
Definition: Brdz.h:35
data::FourierFrequencyType const & frequency() const
Get the frequency of the birdie.
Definition: Birdie.cpp:49
Class for storing birdies (known RFI periodicities/frequencies)
Definition: Birdie.h:41
Birdie()
Create an empty Birdie instance.
Definition: Birdie.cpp:30
data::FourierFrequencyType const & width() const
Get the width of the birdie.
Definition: Birdie.cpp:59