Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Spectrum.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_RFIM_AMPP_SPECTRUM_H
25 #define SKA_CHEETAH_RFIM_AMPP_SPECTRUM_H
26 
27 
28 #include "cheetah/data/Spectrum.h"
29 #include "pss/astrotypes/multiarray/MultiArray.h"
30 
31 namespace ska {
32 namespace cheetah {
33 namespace rfim {
34 namespace ampp {
35 
41 template<typename NumericalRep, typename Alloc=std::allocator<NumericalRep>>
42 class Spectrum : public data::SpectrumBase<Spectrum<NumericalRep, Alloc>, NumericalRep, Alloc>
43 {
44  typedef data::SpectrumBase<Spectrum<NumericalRep, Alloc>, NumericalRep, Alloc> BaseT;
45 
46  public:
47  typedef typename BaseT::Channel Channel;
48  typedef typename BaseT::ConstChannel ConstChannel;
49 
50  public:
51  Spectrum(pss::astrotypes::DimensionSize<data::Frequency> size = pss::astrotypes::DimensionSize<data::Frequency>(0));
52  ~Spectrum();
53 
57  void adjust_mean(NumericalRep);
58 
62  float mean() const;
63  float calculate_mean();
64 
65  private:
66  float _mean;
67 
68 };
69 
70 
71 } // namespace ampp
72 } // namespace rfim
73 } // namespace cheetah
74 } // namespace ska
75 
76 namespace pss {
77 namespace astrotypes {
78 
79 template<typename T, typename Alloc>
80 struct has_exact_dimensions<ska::cheetah::rfim::ampp::Spectrum<T, Alloc>, units::Frequency> : public std::true_type
81 {
82 };
83 
84 } // namespace pss
85 } // namespace astrotypes
86 
87 #include "detail/Spectrum.cpp"
88 
89 #endif // SKA_CHEETAH_RFIM_AMPP_SPECTRUM_H
A single dimension representation of a Spectrum.
Definition: Spectrum.h:58
Some limits and constants for FLDO.
Definition: Brdz.h:35
A single dimension representation of the bandPass.
Definition: Spectrum.h:42
void adjust_mean(NumericalRep)
adjust each channel by the provided amount
Definition: Spectrum.cpp:47
float mean() const
return the calculated mean
Definition: Spectrum.cpp:60