Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
PulsarProfile.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_GENERATORS_PULSARPROFILE_H
25 #define SKA_CHEETAH_GENERATORS_PULSARPROFILE_H
26 
27 #include <vector>
28 #include <utility>
29 
30 namespace ska {
31 namespace cheetah {
32 namespace generators {
33 
44 {
45  public:
46  typedef double ProfileDataPoint;
47 
48  private:
49  typedef std::vector<ProfileDataPoint> ProfileContainer;
50 
51  public:
52  typedef typename ProfileContainer::iterator Iterator;
53  typedef typename ProfileContainer::const_iterator ConstIterator;
54 
55  public:
56  PulsarProfile();
57  PulsarProfile(std::initializer_list<double>);
58  ~PulsarProfile();
59 
63  Iterator begin();
64  ConstIterator cbegin() const;
65 
69  Iterator end();
70  ConstIterator cend() const;
71 
76  void add(double);
77 
81  double sum() const;
82 
86  std::size_t size() const;
87 
88  private:
89  ProfileContainer _profile;
90 };
91 
92 PulsarProfile& operator<<(PulsarProfile& p, double value);
93 
94 } // namespace generators
95 } // namespace cheetah
96 } // namespace ska
97 
98 #endif // SKA_CHEETAH_GENERATORS_PULSARPROFILE_H
std::size_t size() const
return the number of data points in the profile
Iterator begin()
the start of the profile spectrum
A simple intensity profile representing a pulse shape.
Definition: PulsarProfile.h:43
Some limits and constants for FLDO.
Definition: Brdz.h:35
Iterator end()
the end of the profile spectrum
void add(double)
add a value to the profile
double sum() const
return the sum of all frequencies