Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
SigProcHeader.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 CHEETAH_SIGPROC_SIGPROCHEADER_H
25 #define CHEETAH_SIGPROC_SIGPROCHEADER_H
26 
27 
28 #include "pss/astrotypes/sigproc/Header.h"
29 #include "cheetah/data/Units.h"
30 #include "cheetah/utils/chrono.h"
31 #include <boost/units/quantity.hpp>
32 #include <vector>
33 
34 namespace ska {
35 namespace cheetah {
36 namespace sigproc {
37 
43 class SigProcHeader : public pss::astrotypes::sigproc::Header
44 {
45  typedef pss::astrotypes::sigproc::Header BaseT;
46 
47  public:
48  typedef boost::units::quantity<boost::units::si::time, double> TimeType;
49  typedef data::FrequencyType FrequencyType;
50 
51  public:
52  SigProcHeader();
53  ~SigProcHeader();
54 
58  void start_time(typename utils::ModifiedJulianClock::time_point const&);
59  typename utils::ModifiedJulianClock::time_point start_time() const;
60 
64  std::vector<FrequencyType> const& frequency_channels() const;
65 
69  void frequency_channels(std::vector<FrequencyType> const&);
70 
71 };
72 
74 std::ostream& operator<<(std::ostream& os, SigProcHeader const&);
75 
76 } // namespace sigproc
77 } // namespace cheetah
78 } // namespace ska
79 
80 #endif // CHEETAH_SIGPROC_SIGPROCHEADER_H
std::vector< FrequencyType > const & frequency_channels() const
returns the frequencies each channel represents
Some limits and constants for FLDO.
Definition: Brdz.h:35
void start_time(typename utils::ModifiedJulianClock::time_point const &)
set the start_time (corresponding to the time of the first sample
struct for the header information of a SigProc file
Definition: SigProcHeader.h:43