GGti.hpp
9.87 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
/***************************************************************************
* GGti.hpp - Good time interval class *
* ----------------------------------------------------------------------- *
* copyright (C) 2008-2019 by Juergen Knoedlseder *
* ----------------------------------------------------------------------- *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
* *
***************************************************************************/
/**
* @file GGti.hpp
* @brief Good time interval class interface definition
* @author Juergen Knoedlseder
*/
#ifndef GGTI_HPP
#define GGTI_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GContainer.hpp"
#include "GTime.hpp"
#include "GTimeReference.hpp"
#include "GFilename.hpp"
/* __ Forward declarations _______________________________________________ */
class GXmlElement;
class GFits;
class GFitsTable;
/* __ Constants __________________________________________________________ */
namespace gammalib {
const std::string extname_gti = "GTI";
}
/***********************************************************************//**
* @class GGti
*
* @brief Good Time Interval class
*
* This class holds a list of Good Time Intervals, i.e. time intervals that
* are valid for science analysis. Times are stored using the GTime class.
* The class also holds information about the time reference, which will
* be retained when reading and used when writing, so that Good Time
* Intervals are always written in the specified time reference.
*
* The class has no method for sorting of the Good Time Intervals; it is
* expected that the Good Time Intervals are correctly set by the client.
***************************************************************************/
class GGti : public GContainer {
public:
// Constructors and destructors
GGti(void);
explicit GGti(const GFilename& filename);
GGti(const GGti& gti);
GGti(const GTime& tstart, const GTime& tstop);
explicit GGti(const GXmlElement& xml);
explicit GGti(const GTimeReference& ref);
virtual ~GGti(void);
// Operators
GGti& operator=(const GGti& gti);
// Methods
void clear(void);
GGti* clone(void) const;
std::string classname(void) const;
int size(void) const;
bool is_empty(void) const;
void append(const GTime& tstart, const GTime& tstop);
void insert(const GTime& tstart, const GTime& tstop);
void merge(void);
void merge(const GTime& tstart, const GTime& tstop);
void reduce(const GTime& tstart, const GTime& tstop);
void remove(const int& index);
void reserve(const int& num);
void extend(const GGti& gti);
void load(const GFilename& filename);
void save(const GFilename& filename,
const bool& clobber = false) const;
void read(const GFitsTable& table);
void write(GFits& fits,
const std::string& extname = gammalib::extname_gti) const;
void read(const GXmlElement& xml);
void write(GXmlElement& xml) const;
const GTime& tstart(void) const;
const GTime& tstop(void) const;
const GTime& tstart(const int& index) const;
const GTime& tstop(const int& index) const;
const double& telapse(void) const;
const double& ontime(void) const;
double overlap(const GTime& tstart, const GTime& tstop) const;
void reference(const GTimeReference& ref);
const GTimeReference& reference(void) const;
bool contains(const GTime& time) const;
std::string print(const GChatter& chatter = NORMAL) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GGti& gti);
void free_members(void);
void set_attributes(void);
void insert_gti(const int& index, const GTime& tstart, const GTime& tstop);
// Protected data area
int m_num; //!< Number of Good Time Intervals
GTime m_tstart; //!< Start time of Good Time Intervals
GTime m_tstop; //!< Stop time of Good Time Intervals
double m_ontime; //!< Sum of GTIs durations (in seconds)
double m_telapse; //!< Time between start of first GTI and stop of last GTI (in seconds)
GTime *m_start; //!< Array of start times
GTime *m_stop; //!< Array of stop times
GTimeReference m_reference; //!< Time reference
GFilename m_xml_filename; //!< XML filename
// Computation cache
mutable int m_last_index; //!< Last index for containment test
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GGti").
***************************************************************************/
inline
std::string GGti::classname(void) const
{
return ("GGti");
}
/***********************************************************************//**
* @brief Return number of Good Time Intervals
*
* @return Number of Good Time Intervals.
***************************************************************************/
inline
int GGti::size(void) const
{
return m_num;
}
/***********************************************************************//**
* @brief Signal if there are no Good Time Intervals
*
* @return True if there are no Good Time Intervals.
***************************************************************************/
inline
bool GGti::is_empty(void) const
{
return (m_num == 0);
}
/***********************************************************************//**
* @brief Reserve space for Good Time Intervals
*
* @param[in] num Number of elements.
*
* This method does nothing (it is needed to satisfy the GContainer
* interface).
***************************************************************************/
inline
void GGti::reserve(const int& num)
{
// Return
return;
}
/***********************************************************************//**
* @brief Returns earliest start time in Good Time Intervals
*
* @return Earliest start time in Good Time Intervals.
***************************************************************************/
inline
const GTime& GGti::tstart(void) const
{
// Return
return m_tstart;
}
/***********************************************************************//**
* @brief Returns latest stop time in Good Time Intervals
*
* @return Latest stop time in Good Time Intervals.
***************************************************************************/
inline
const GTime& GGti::tstop(void) const
{
// Return
return m_tstop;
}
/***********************************************************************//**
* @brief Returns elapsed time
*
* @return Elapsed time (seconds).
*
* Returns the elapsed time in seconds. The elapsed time is defined as the
* time difference between the latest stop time and the earliest start time
* in the Good Time Intervals.
***************************************************************************/
inline
const double& GGti::telapse(void) const
{
// Return
return m_telapse;
}
/***********************************************************************//**
* @brief Returns ontime
*
* @return Ontime (seconds).
*
* Returns the ontime in seconds. The ontime is defined as the sum of all
* Good Time Intervals.
***************************************************************************/
inline
const double& GGti::ontime(void) const
{
// Return
return m_ontime;
}
/***********************************************************************//**
* @brief Set time reference for Good Time Intervals
*
* @param[in] ref Time reference.
*
* Sets the time reference of the Good Time Intervals. This defines the
* reference time which will be writted into the FITS file upon saving of
* the Good Time Intervals.
***************************************************************************/
inline
void GGti::reference(const GTimeReference& ref)
{
// Set time reference
m_reference = ref;
// Return
return;
}
/***********************************************************************//**
* @brief Return time reference for Good Time Intervals
*
* @return Time reference.
*
* Returns the time reference of the Good Time Intervals.
***************************************************************************/
inline
const GTimeReference& GGti::reference(void) const
{
// Return time reference
return m_reference;
}
#endif /* GGTI_HPP */