Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
CandidateWindow.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_CANDIDATEWINDOW_H
25 #define SKA_CHEETAH_DATA_CANDIDATEWINDOW_H
26 
27 #include "cheetah/data/Units.h"
28 #include <cstddef>
29 
30 namespace ska {
31 namespace cheetah {
32 namespace data {
33 
39 {
40  private:
41  typedef boost::units::quantity<MilliSeconds,double> MsecTimeType;
42 
43  public:
45  CandidateWindow(MsecTimeType ms_before, MsecTimeType ms_after);
46  ~CandidateWindow();
47 
51  MsecTimeType ms_before() const;
52  void ms_before(MsecTimeType);
53 
57  MsecTimeType ms_after() const;
58  void ms_after(MsecTimeType);
59 
60  private:
61  MsecTimeType _pre;
62  MsecTimeType _post;
63 };
64 
65 
66 } // namespace data
67 } // namespace cheetah
68 } // namespace ska
69 
70 #endif // SKA_CHEETAH_DATA_CANDIDATEWINDOW_H
MsecTimeType ms_before() const
the milliseconds required before the cnadidate start time
Some limits and constants for FLDO.
Definition: Brdz.h:35
MsecTimeType ms_after() const
the milliseconds required after the candidate end time
define a window of data surrounding a single pulse candidate