GResponseCache.cpp
17.2 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
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
/***************************************************************************
* GResponseCache.cpp - Response cache class *
* ----------------------------------------------------------------------- *
* copyright (C) 2020 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 GResponseCache.cpp
* @brief Response cache class implementation
* @author Juergen Knoedlseder
*/
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <cstring> // memcpy
#include "GTools.hpp"
#include "GResponseCache.hpp"
#include "GInstDir.hpp"
/* __ Method name definitions ____________________________________________ */
/* __ Macros _____________________________________________________________ */
/* __ Coding definitions _________________________________________________ */
/* __ Debug definitions __________________________________________________ */
/*==========================================================================
= =
= Constructors/destructors =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Void constructor
***************************************************************************/
GResponseCache::GResponseCache(void)
{
// Initialise class members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Copy constructor
*
* @param[in] cache Response cache.
***************************************************************************/
GResponseCache::GResponseCache(const GResponseCache& cache)
{
// Initialise class members
init_members();
// Copy members
copy_members(cache);
// Return
return;
}
/***********************************************************************//**
* @brief Destructor
***************************************************************************/
GResponseCache::~GResponseCache(void)
{
// Free members
free_members();
// Return
return;
}
/*==========================================================================
= =
= Operators =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Assignment operator
*
* @param[in] cache Response cache.
* @return Response cache.
***************************************************************************/
GResponseCache& GResponseCache::operator=(const GResponseCache& cache)
{
// Execute only if object is not identical
if (this != &cache) {
// Free members
free_members();
// Initialise private members
init_members();
// Copy members
copy_members(cache);
} // endif: object was not identical
// Return this object
return *this;
}
/*==========================================================================
= =
= Public methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Clear response cache
***************************************************************************/
void GResponseCache::clear(void)
{
// Free members
free_members();
// Initialise private members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Return number of elements in cache
*
* @return Number of elements in cache
*
* Returns the number of elements in the response cache.
***************************************************************************/
int GResponseCache::size(void) const
{
// Initialize size
int size = 0;
// Compute size
for (GResponseCacheName::const_iterator it_name = m_cache.begin();
it_name != m_cache.end(); ++it_name) {
for (GResponseCacheEnergy::const_iterator it_energy =
it_name->second.begin();
it_energy != it_name->second.end(); ++it_energy) {
size += it_energy->second.size();
}
}
// Return size
return size;
}
/***********************************************************************//**
* @brief Return number of energies in cache
*
* @return Number of energies in cache
*
* Returns the number of energies in the response cache.
***************************************************************************/
int GResponseCache::nenergies(void) const
{
// Initialize number of energies
int nenergies = 0;
// Compute number of elements
for (GResponseCacheName::const_iterator it_name = m_cache.begin();
it_name != m_cache.end(); ++it_name) {
for (GResponseCacheEnergy::const_iterator it_energy =
it_name->second.begin();
it_energy != it_name->second.end(); ++it_energy) {
nenergies += it_energy->second.size();
}
}
// Return number of energies
return nenergies;
}
/***********************************************************************//**
* @brief Set cache value
*
* @param[in] name Cache name.
* @param[in] ereco Reconstructed energy.
* @param[in] etrue True energy.
* @param[in] value Cache value.
*
* Set cache value for a given @p name, reconstructed energy @p ereco, and
* true energy @p etrue.
***************************************************************************/
void GResponseCache::set(const std::string& name,
const GEnergy& ereco,
const GEnergy& etrue,
const double& value)
{
// Get energy identifier
u_int64_t energy = hash(ereco, etrue);
// Set cache value
m_cache[name][energy][0] = value;
// Return
return;
}
/***********************************************************************//**
* @brief Set cache value
*
* @param[in] name Cache name.
* @param[in] dir Instrument direction.
* @param[in] ereco Reconstructed energy.
* @param[in] etrue True energy.
* @param[in] value Cache value.
*
* Set cache value for a given @p name, instrument direction @p dir,
* reconstructed energy @p ereco, and true energy @p etrue.
***************************************************************************/
void GResponseCache::set(const std::string& name,
const GInstDir& dir,
const GEnergy& ereco,
const GEnergy& etrue,
const double& value)
{
// Get energy and direction identifier
u_int64_t energy = hash(ereco, etrue);
u_int64_t instdir = dir.hash();
// Set cache value
m_cache[name][energy][instdir] = value;
// Return
return;
}
/***********************************************************************//**
* @brief Check if cache contains a value for specific parameters
*
* @param[in] name Cache name.
* @param[in] ereco Reconstructed energy.
* @param[in] etrue True energy.
* @param[out] value Pointer to cached value (only if found).
* @return True if cached value was found, otherwise false.
*
* Check if the cache contains a value for a given @p name, reconstructed
* energy @p ereco, and true energy @p etrue.
*
* If the @p value pointer argument is not NULL, the method will return the
* cached value through this argument in case that the value exists.
***************************************************************************/
bool GResponseCache::contains(const std::string& name,
const GEnergy& ereco,
const GEnergy& etrue,
double* value) const
{
// Initialise containment flag
bool contains = false;
// Get energy identifier
u_int64_t energy = hash(ereco, etrue);
u_int64_t instdir = 0;
// Search for name in cache
GResponseCacheName::const_iterator it_name = m_cache.find(name);
if (it_name != m_cache.end()) {
// Search for energy in cache
GResponseCacheEnergy::const_iterator it_energy =
it_name->second.find(energy);
if (it_energy != it_name->second.end()) {
// Search for direction in cache
GResponseCacheDir::const_iterator it_dir =
it_energy->second.find(instdir);
if (it_dir != it_energy->second.end()) {
contains = true;
if (value != NULL) {
*value = it_dir->second;
}
} // endif: direction found
} // endif: energy found
} // endif: name found
// Return containment flag
return contains;
}
/***********************************************************************//**
* @brief Check if cache contains a value for specific parameters
*
* @param[in] name Cache name.
* @param[in] dir Instrument direction.
* @param[in] ereco Reconstructed energy.
* @param[in] etrue True energy.
* @param[out] value Pointer to cached value (only if found).
* @return True if cached value was found, otherwise false.
*
* Check if the cache contains a value for a given @p name, instrument
* direction @p dir, reconstructed energy @p ereco, and true energy @p etrue.
*
* If the @p value pointer argument is not NULL, the method will return the
* cached value through this argument in case that the value exists.
***************************************************************************/
bool GResponseCache::contains(const std::string& name,
const GInstDir& dir,
const GEnergy& ereco,
const GEnergy& etrue,
double* value) const
{
// Initialise containment flag
bool contains = false;
// Get energy identifier
u_int64_t energy = hash(ereco, etrue);
u_int64_t instdir = dir.hash();
// Search for name in cache
GResponseCacheName::const_iterator it_name = m_cache.find(name);
if (it_name != m_cache.end()) {
// Search for energy in cache
GResponseCacheEnergy::const_iterator it_energy =
it_name->second.find(energy);
if (it_energy != it_name->second.end()) {
// Search for direction in cache
GResponseCacheDir::const_iterator it_dir =
it_energy->second.find(instdir);
if (it_dir != it_energy->second.end()) {
contains = true;
if (value != NULL) {
*value = it_dir->second;
}
} // endif: direction found
} // endif: energy found
} // endif: name found
// Return containment flag
return contains;
}
/***********************************************************************//**
* @brief Clone response cache
*
* @return Pointer to deep copy of response cache.
***************************************************************************/
GResponseCache* GResponseCache::clone(void) const
{
return new GResponseCache(*this);
}
/***********************************************************************//**
* @brief Print response cache
*
* @param[in] chatter Chattiness.
* @return String containing response cache information.
***************************************************************************/
std::string GResponseCache::print(const GChatter& chatter) const
{
// Initialise result string
std::string result;
// Continue only if chatter is not silent
if (chatter != SILENT) {
// Append header
result.append("=== GResponseCache ===");
// Append total cache size
result.append("\n"+gammalib::parformat("Number of cached values"));
result.append(gammalib::str(size()));
// Append information
for (GResponseCacheName::const_iterator it_name = m_cache.begin();
it_name != m_cache.end(); ++it_name) {
// Append name
result.append("\n"+gammalib::parformat("Name")+it_name->first);
// Compute number of sky directions and energies
int ndirs = 0;
int nenergies = 0;
for (GResponseCacheEnergy::const_iterator it_energy =
it_name->second.begin();
it_energy != it_name->second.end(); ++it_energy) {
nenergies++;
for (GResponseCacheDir::const_iterator it_dir =
it_energy->second.begin();
it_dir != it_energy->second.end(); ++it_dir) {
ndirs++;
}
}
// Append number of reconstructed and true energies
result.append("\n"+gammalib::parformat("Number of energies"));
result.append(gammalib::str(nenergies));
result.append("\n"+gammalib::parformat("Number of directions"));
result.append(gammalib::str(ndirs));
} // endfor: looped over names
} // endif: chatter was not silent
// Return result
return result;
}
/*==========================================================================
= =
= Private methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Initialise class members
***************************************************************************/
void GResponseCache::init_members(void)
{
// Initialise members
m_cache.clear();
// Return
return;
}
/***********************************************************************//**
* @brief Copy class members
*
* @param[in] cache Response cache.
***************************************************************************/
void GResponseCache::copy_members(const GResponseCache& cache)
{
// Copy members
m_cache = cache.m_cache;
// Return
return;
}
/***********************************************************************//**
* @brief Delete class members
***************************************************************************/
void GResponseCache::free_members(void)
{
// Return
return;
}
/***********************************************************************//**
* @brief Encode reconstructued and true energy into hash value
*
* @param[in] ereco Reconstructed energy.
* @param[in] etrue True energy.
* @return Encoded reconstructued and true energy
*
* Encodes the reconstructued and true energy in a 64 Bit unsigned integer
* value. The energy are converted into single precision floating point
* values and mapped on a 64 Bit unsigned integer value. This provides unique
* hash values for all instruments up to the precision of floating point
* singles.
***************************************************************************/
u_int64_t GResponseCache::hash(const GEnergy& ereco,
const GEnergy& etrue) const
{
// Allocate static array to store the two energies as floats
static float buffer[2];
// Store the two energies as floats
buffer[0] = float(ereco.MeV());
buffer[1] = float(etrue.MeV());
// Map the floats to an unsigned 64 Bit integer
u_int64_t hash; std::memcpy(&hash, &buffer, sizeof hash);
// Return encoded value
return hash;
}