GCOMEventBin.cpp
11.7 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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
/***************************************************************************
* GCOMEventBin.cpp - COMPTEL event bin class *
* ----------------------------------------------------------------------- *
* copyright (C) 2012-2016 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 GCOMEventBin.cpp
* @brief COMPTEL event bin class implementation.
* @author Juergen Knoedlseder
*/
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <string>
#include <cmath>
#include "GCOMEventBin.hpp"
#include "GTools.hpp"
/* __ Method name definitions ____________________________________________ */
/* __ Macros _____________________________________________________________ */
/* __ Coding definitions _________________________________________________ */
/* __ Debug definitions __________________________________________________ */
/*==========================================================================
= =
= Constructors/destructors =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Void constructor
***************************************************************************/
GCOMEventBin::GCOMEventBin(void) : GEventBin()
{
// Initialise class members for clean destruction
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Copy constructor
*
* @param[in] bin Event bin.
***************************************************************************/
GCOMEventBin::GCOMEventBin(const GCOMEventBin& bin) : GEventBin(bin)
{
// Initialise class members for clean destruction
init_members();
// Copy members
copy_members(bin);
// Return
return;
}
/***********************************************************************//**
* @brief Destructor
***************************************************************************/
GCOMEventBin::~GCOMEventBin(void)
{
// Free members
free_members();
// Return
return;
}
/*==========================================================================
= =
= Operators =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Assignment operator
*
* @param[in] bin Event bin.
* @return Event bin.
***************************************************************************/
GCOMEventBin& GCOMEventBin::operator= (const GCOMEventBin& bin)
{
// Execute only if object is not identical
if (this != &bin) {
// Copy base class members
this->GEventBin::operator=(bin);
// Free members
free_members();
// Initialise private members for clean destruction
init_members();
// Copy members
copy_members(bin);
} // endif: object was not identical
// Return this object
return *this;
}
/*==========================================================================
= =
= Public methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Clear instance
*
* This method properly resets the instance to an initial state.
***************************************************************************/
void GCOMEventBin::clear(void)
{
// Free class members (base and derived classes, derived class first)
free_members();
this->GEventBin::free_members();
this->GEvent::free_members();
// Initialise members
this->GEvent::init_members();
this->GEventBin::init_members();
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Clone instance
*
* @return Pointer to deep copy of event bin.
***************************************************************************/
GCOMEventBin* GCOMEventBin::clone(void) const
{
return new GCOMEventBin(*this);
}
/***********************************************************************//**
* @brief Return size of event bin
*
* @return Size of event bin (sr MeV s)
*
* The size of the event bin (units: sr MeV s) is given by
* \f[size = \Omega \times \Delta E \times \Delta T\f]
* where
* \f$\Omega\f$ is the size of the spatial bin in sr,
* \f$\Delta E\f$ is the size of the energy bin in MeV, and
* \f$\Delta T\f$ is the ontime of the observation in seconds.
***************************************************************************/
double GCOMEventBin::size(void) const
{
// Compute bin size
double size = solidangle() * ewidth().MeV() * ontime();
// Return bin size
return size;
}
/***********************************************************************//**
* @brief Return error in number of counts
*
* @return Error in number of counts in event bin.
*
* Returns \f$\sqrt(counts+delta)\f$ as the uncertainty in the number of
* counts in the bin. Adding delta avoids uncertainties of 0 which will
* lead in the optimisation step to the exlusion of the corresponding bin.
* In the actual implementation delta=1e-50.
*
* @todo The choice of delta has been made somewhat arbitrary, mainly
* because the optimizer routines filter error^2 below 1e-100.
***************************************************************************/
double GCOMEventBin::error(void) const
{
// Compute uncertainty
double error = std::sqrt(counts()+1.0e-50);
// Return error
return error;
}
/***********************************************************************//**
* @brief Print event information
*
* @param[in] chatter Chattiness (defaults to NORMAL).
* @return String containing event information.
***************************************************************************/
std::string GCOMEventBin::print(const GChatter& chatter) const
{
// Initialise result string
std::string result;
// Continue only if chatter is not silent
if (chatter != SILENT) {
// Append number of counts
result.append(gammalib::str(counts()));
} // endif: chatter was not silent
// Return result
return result;
}
/*==========================================================================
= =
= Private methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Initialise class members
*
* This method allocates memory for all event bin attributes and intialises
* the attributes to well defined initial values.
*
* The method assumes that on entry no memory is hold by the member pointers.
***************************************************************************/
void GCOMEventBin::init_members(void)
{
// Allocate members
m_alloc = true;
m_index = -1; // Signals that event bin does not correspond to cube
m_dir = new GCOMInstDir;
m_time = new GTime;
m_energy = new GEnergy;
m_ewidth = new GEnergy;
m_counts = new double;
m_solidangle = new double;
m_ontime = new double;
// Initialise members
m_dir->clear();
m_time->clear();
m_energy->clear();
m_ewidth->clear();
*m_counts = 0.0;
*m_solidangle = 0.0;
*m_ontime = 0.0;
// Return
return;
}
/***********************************************************************//**
* @brief Copy class members
*
* @param[in] bin Event bin.
***************************************************************************/
void GCOMEventBin::copy_members(const GCOMEventBin& bin)
{
// First de-allocate existing memory if needed
free_members();
// Copy members by cloning
m_dir = new GCOMInstDir(*bin.m_dir);
m_time = new GTime(*bin.m_time);
m_energy = new GEnergy(*bin.m_energy);
m_ewidth = new GEnergy(*bin.m_ewidth);
m_counts = new double(*bin.m_counts);
m_solidangle = new double(*bin.m_solidangle);
m_ontime = new double(*bin.m_ontime);
// Copy non-pointer members
m_index = bin.m_index;
// Signal memory allocation
m_alloc = true;
// Return
return;
}
/***********************************************************************//**
* @brief Delete class members
*
* This method frees all memory of the class attributes and sets the member
* pointers to NULL. This method should only be called if new memory is
* allocated immediately afterwards (for example by cloning another event
* bin), or upon destruction of the object.
*
* Note that some logic has been implemented that frees only memory that also
* has indeed been allocated by the class. Thus if the class only serves as
* container to hold memory pointer allocated by someone else (for example
* the GCOMEventCube class), no memory is freed.
***************************************************************************/
void GCOMEventBin::free_members(void)
{
// If memory was allocated then free members now
if (m_alloc) {
if (m_dir != NULL) delete m_dir;
if (m_time != NULL) delete m_time;
if (m_energy != NULL) delete m_energy;
if (m_ewidth != NULL) delete m_ewidth;
if (m_counts != NULL) delete m_counts;
if (m_solidangle != NULL) delete m_solidangle;
if (m_ontime != NULL) delete m_ontime;
}
// Signal member pointers as free
m_dir = NULL;
m_time = NULL;
m_energy = NULL;
m_ewidth = NULL;
m_counts = NULL;
m_solidangle = NULL;
m_ontime = NULL;
// Signal memory de-allocation
m_alloc = false;
// Return
return;
}