Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
RcptTimerStats.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_RCPTTIMERSTATS_H
25 #define SKA_CHEETAH_RCPT_RCPTTIMERSTATS_H
26 #include "cheetah/rcpt/BeamFormerDataTraits.h"
27 #include "panda/DataRate.h"
28 #pragma GCC diagnostic push
29 #pragma GCC diagnostic ignored "-Wpragmas"
30 #pragma GCC diagnostic ignored "-Wunused-parameter"
31 #include <boost/accumulators/accumulators.hpp>
32 #include <boost/accumulators/statistics/stats.hpp>
33 #include <boost/accumulators/statistics/rolling_mean.hpp>
34 #pragma GCC diagnostic pop
35 
36 namespace ska {
37 namespace cheetah {
38 namespace rcpt {
39 
47 template<typename ClockType>
49 {
50  private:
51  typedef typename ClockType::time_point TimePointType;
52  typedef typename ClockType::duration TimeDurationType;
53  typedef boost::accumulators::accumulator_set<double, boost::accumulators::stats<boost::accumulators::tag::rolling_mean> > RateAccumulatorType;
54 
55  public:
56 
57  RcptTimerStats(std::size_t window_size = 200);
58  ~RcptTimerStats();
59 
64  void operator()(typename BeamFormerDataTraits::DataType const&, TimePointType);
65 
69  panda::DataRate<double> data_rate() const;
70 
74  void reset();
75 
76  private:
77  TimePointType _last;
78  RateAccumulatorType _data_rates;
79  const std::size_t _window_size;
80 };
81 
85 template<typename StreamType, typename ClockType>
86 StreamType& operator<<(StreamType& os, RcptTimerStats<ClockType> const&);
87 
88 } // namespace rcpt
89 } // namespace cheetah
90 } // namespace ska
91 
92 #include "cheetah/rcpt/detail/RcptTimerStats.cpp"
93 
94 #endif // SKA_CHEETAH_RCPT_RCPTTIMERSTATS_H
void operator()(typename BeamFormerDataTraits::DataType const &, TimePointType)
add a new datapoint n.b. this is not thread safe.
panda::DataRate< double > data_rate() const
return the average data rate
Some limits and constants for FLDO.
Definition: Brdz.h:35
void reset()
reset all counters and set the first timestamp to now
Calculate rcpt specific performance information.