Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Pwft-TDT-Reference-Interface.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 PWFT_TDT_REFERENCE_INTERFACE_H_
25 #define PWFT_TDT_REFERENCE_INTERFACE_H_
26 
27 #include "cheetah/tdrt/TimeSeries.h"
28 #include "cheetah/tdrt/FrequencySeries.h"
29 
30 namespace ska {
31 namespace cheetah {
32 namespace pwft {
33 namespace test {
34 
35 class PwftTDTReference; // forward declaration to implementation
36 
50 {
51  typedef class PwftTDTReference Implementation;
52 
53  public:
54  PwftTDTReferenceInterface(size_t length);
55 
56  void process(tdrt::TimeSeries<float>& h_input,
57  tdrt::FrequencySeries<float>& h_output);
58 
59  // Test data generator
60 
61  void sine_signal(float period,
62  tdrt::TimeSeries<float>& h_output);
63 
64  // Checker function for the Pwft. It calculates the cross correlation
65  // of the two output vectors normalized by the auto correlation of Vector A.
66  // If the vectors are identical, it returns 1.0. If they're completely
67  // different it returns 0.0. This test is highly sensitive to differences
68  // in bin but given that FFTs are library functions, I think a stringent
69  // test is good.
70 
71  float pwft_correlation(tdrt::FrequencySeries<float>& h_fsA, tdrt::FrequencySeries<float>& h_fsB);
72 
73  private:
74  std::shared_ptr<Implementation> _pimpl;
75 };
76 
77 } // namespace test
78 } // namespace pwft
79 } // namespace cheetah
80 } // namespace ska
81 
82 #endif /* PWFT_TDT_REFERENCE_INTERFACE_H_ */
Power Spectrum Fourier Transform Reference Model.
Power Spectrum Fourier Transform Reference Model I N T E R F A C E (using pimpl idiom) ...
Some limits and constants for FLDO.
Definition: Brdz.h:35