Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
TimeFrequencyCommon.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_TIMEFREQUENCYCOMMON_H
25 #define SKA_CHEETAH_DATA_TIMEFREQUENCYCOMMON_H
26 
27 #include "cheetah/data/TimeFrequencyMetadata.h"
28 #include "panda/DataChunk.h"
29 
30 namespace ska {
31 namespace cheetah {
32 namespace data {
33 
38 template <class DerivedType>
39 class TimeFrequencyCommon : public panda::DataChunk<DerivedType>
40 {
41  public:
42  typedef boost::units::quantity<MegaHertz, double> FrequencyType;
43  typedef boost::units::quantity<boost::units::si::time, double> TimeType;
44  typedef cheetah::utils::ModifiedJulianClock::time_point TimePointType;
45 
46  public:
48 
49  template <typename OtherDerivedType>
51 
55  TimePointType const& start_time() const;
56 
60  TimePointType start_time(std::size_t offset) const;
61 
67  void start_time(TimePointType const& start_time);
68 
73  TimePointType end_time() const;
74 
78  TimeType sample_interval() const;
79 
83  inline
84  void sample_interval(TimeType dt);
85 
89  std::vector<FrequencyType> const& channel_frequencies() const;
90 
94  std::pair<FrequencyType, FrequencyType> low_high_frequencies() const;
95 
101  void set_channel_frequencies_const_width(FrequencyType const& start,
102  FrequencyType const& delta);
103 
107  template<class InputIterator>
108  void set_channel_frequencies(InputIterator begin, InputIterator const end);
109 
113  TimeFrequencyMetadata const& metadata() const;
114 
118  void metadata(TimeFrequencyMetadata const& metadata);
119 
120  private:
121  TimeFrequencyMetadata _metadata;
122 };
123 
124 
125 } // namespace data
126 } // namespace cheetah
127 } // namespace ska
128 
129 #include "cheetah/data/detail/TimeFrequencyCommon.cpp"
130 #endif // SKA_CHEETAH_DATA_TIMEFREQUENCYCOMMON_H
void set_channel_frequencies_const_width(FrequencyType const &start, FrequencyType const &delta)
Set the frequency index based on evenly spaced channels.
std::pair< FrequencyType, FrequencyType > low_high_frequencies() const
TimePointType const & start_time() const
Some limits and constants for FLDO.
Definition: Brdz.h:35
void set_channel_frequencies(InputIterator begin, InputIterator const end)
std::vector< FrequencyType > const & channel_frequencies() const
TimeFrequencyMetadata const & metadata() const
Metadata for TimeFrequency and FrequencyTime classes.