Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
TimeFrequencyStats.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_TIMEFREQUENCYSTATS_H
25 #define SKA_CHEETAH_DATA_TIMEFREQUENCYSTATS_H
26 
27 #include "cheetah/data/ExtendedTimeFrequency.h"
28 
29 
30 namespace ska {
31 namespace cheetah {
32 namespace data {
33 
38 template<typename TimeFrequencyType>
39 class TimeFrequencyStats : public ExtendedTimeFrequency<TimeFrequencyType>
40 {
42 
43  public:
44  typedef typename BaseT::NumericalRep NumericalRep;
45 
46  class Statistics {
47  public:
48  Statistics();
49 
50  public:
51  double mean;
52  double variance;
53  };
54 
55  public:
60  TimeFrequencyStats(std::shared_ptr<TimeFrequencyType> const&);
62 
66  void calculate_stats() const;
67 
71  std::vector<Statistics> const& channel_stats() const;
72 
76  std::vector<Statistics> const& spectrum_stats() const;
77 
78  private:
79  mutable std::vector<Statistics> _channel_stats;
80  mutable std::vector<Statistics> _spectrum_stats;
81 };
82 
83 } // namespace data
84 } // namespace cheetah
85 } // namespace ska
86 
87 #include "cheetah/data/detail/TimeFrequencyStats.cpp"
88 #endif // SKA_CHEETAH_DATA_TIMEFREQUENCYSTATS_H
Wrapper around a TimeFrequency type object (or shared_ptr to such) mainiting the TimeFrequency interf...
std::vector< Statistics > const & channel_stats() const
: return the Statistics for each channel in the block
Some limits and constants for FLDO.
Definition: Brdz.h:35
A class to compute timefrequency stats (mean and variance.
TimeFrequencyStats(std::shared_ptr< TimeFrequencyType > const &)
: construct an object with median and variance statistics for each channel and each spectrum...
void calculate_stats() const
: recompute the statistics
std::vector< Statistics > const & spectrum_stats() const
: return the Statistics (mean and variance) for each spectrum