GObservation.cpp
50.9 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
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
/***************************************************************************
* GObservation.cpp - Abstract observation base class *
* ----------------------------------------------------------------------- *
* copyright (C) 2008-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 GObservation.cpp
* @brief Abstract observation base class implementation
* @author Juergen Knoedlseder
*/
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include "GTools.hpp"
#include "GException.hpp"
#include "GIntegral.hpp"
#include "GDerivative.hpp"
#include "GVector.hpp"
#include "GMatrixSparse.hpp"
#include "GObservation.hpp"
#include "GResponse.hpp"
#include "GEventCube.hpp"
#include "GEventList.hpp"
#include "GEventBin.hpp"
#include "GModel.hpp"
#include "GModels.hpp"
#include "GModelPar.hpp"
#include "GModelSky.hpp"
#include "GModelData.hpp"
/* __ Method name definitions ____________________________________________ */
#define G_LIKELIHOOD "GObservation::likelihood(GModels&, GVector*,"\
" GMatrixSparse*, double*)"
#define G_MODEL "GObservation::model(GModels&, GPointing&,"\
" GInstDir&, GEnergy&, GTime&, GVector*)"
#define G_EVENTS "GObservation::events()"
#define G_NPRED "GObservation::npred(GModel&)"
#define G_NPRED_SPEC "GObservation::npred_spec(GModel&, GTime&)"
/* __ Constants __________________________________________________________ */
const double minmod = 1.0e-100; //!< Minimum model value
const double minerr = 1.0e-100; //!< Minimum statistical error
/* __ Macros _____________________________________________________________ */
/* __ Coding definitions _________________________________________________ */
#define G_LN_ENERGY_INT //!< ln(E) variable substitution for integration
/* __ Debug definitions __________________________________________________ */
//#define G_OPT_DEBUG
/*==========================================================================
= =
= Constructors/destructors =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Void constructor
***************************************************************************/
GObservation::GObservation(void)
{
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Copy constructor
*
* @param[in] obs Observation.
*
* Instantiate the class by copying from an existing observation.
***************************************************************************/
GObservation::GObservation(const GObservation& obs)
{
// Initialise members
init_members();
// Copy members
copy_members(obs);
// Return
return;
}
/***********************************************************************//**
* @brief Destructor
***************************************************************************/
GObservation::~GObservation(void)
{
// Free members
free_members();
// Return
return;
}
/*==========================================================================
= =
= Operators =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Assignment operator
*
* @param[in] obs Observation.
* @return Observation.
*
* Assign observation.
***************************************************************************/
GObservation& GObservation::operator=(const GObservation& obs)
{
// Execute only if object is not identical
if (this != &obs) {
// Free members
free_members();
// Initialise members
init_members();
// Copy members
copy_members(obs);
} // endif: object was not identical
// Return this object
return *this;
}
/*==========================================================================
= =
= Public methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Compute likelihood function
*
* @param[in] models Models.
* @param[in,out] gradient Pointer to gradients.
* @param[in,out] curvature Pointer to curvature matrix.
* @param[in,out] npred Pointer to Npred value.
* @return Likelihood.
*
* Computes the likelihood for a specified set of models. The method also
* returns the gradients, the curvature matrix, and the number of events
* that are predicted by all models.
***************************************************************************/
double GObservation::likelihood(const GModels& models,
GVector* gradient,
GMatrixSparse* curvature,
double* npred) const
{
// Initialise likelihood value
double value = 0.0;
// Extract statistics for this observation
std::string statistics = gammalib::toupper(this->statistics());
// Unbinned analysis
if (dynamic_cast<const GEventList*>(events()) != NULL) {
// Poisson statistics
if (statistics == "POISSON") {
// Update the log-likelihood
value = likelihood_poisson_unbinned(models,
gradient,
curvature,
npred);
} // endif: Poisson statistics
// ... otherwise throw an exception
else {
throw GException::invalid_statistics(G_LIKELIHOOD, statistics,
"Unbinned optimization requires Poisson statistics.");
}
} // endif: unbinned analysis
// ... or binned analysis
else {
// Poisson statistics
if (statistics == "POISSON") {
value = likelihood_poisson_binned(models,
gradient,
curvature,
npred);
}
// ... or Gaussian statistics
else if (statistics == "GAUSSIAN") {
value = likelihood_gaussian_binned(models,
gradient,
curvature,
npred);
}
// ... or unsupported
else {
throw GException::invalid_statistics(G_LIKELIHOOD, statistics,
"Binned optimization requires Poisson or Gaussian"
" statistics.");
}
} // endelse: binned analysis
// Return likelihood
return value;
}
/***********************************************************************//**
* @brief Return model value and (optionally) gradient
*
* @param[in] models Model descriptor.
* @param[in] event Observed event.
* @param[out] gradient Pointer to gradient vector (optional).
*
* @exception GException::invalid_value
* Dimension of gradient vector mismatches number of parameters.
*
* Implements generic model and gradient evaluation for an observation. The
* model gives the probability for an event to occur with a given instrument
* direction, at a given energy and at a given time. The gradient is the
* parameter derivative of this probability. If NULL is passed for the
* gradient vector, then gradients will not be computed.
*
* The method will only operate on models for which the list of instruments
* and observation identifiers matches those of the observation. Models that
* do not match will be skipped.
***************************************************************************/
double GObservation::model(const GModels& models,
const GEvent& event,
GVector* gradient) const
{
// Initialise method variables
double model = 0.0; // Reset model value
int igrad = 0; // Reset gradient counter
int grad_size = 0; // Reset gradient size
// If gradient is available then reset gradient vector elements to 0
// and determine vector size
if (gradient != NULL) {
(*gradient) = 0.0;
grad_size = gradient->size();
}
// Loop over models
for (int i = 0; i < models.size(); ++i) {
// Get model pointer. Continue only if pointer is valid
const GModel* mptr = models[i];
if (mptr != NULL) {
// Continue only if model applies to specific instrument and
// observation identifier
if (mptr->is_valid(instrument(), id())) {
// Compute value and add to model. If energy dispersion
// is used, don't compute model gradients as we cannot
// use them. This is somehow a kluge, but makes the
// code faster
if (response()->use_edisp()) {
model += mptr->eval(event, *this);
}
else {
model += mptr->eval_gradients(event, *this);
}
// Optionally determine model gradients. If the model has a
// gradient then use it, unless we have energy dispersion.
// For energy dispersion, no gradients are available as we
// have not implemented code that integrates the gradients
// over the energy dispersion. Here it's simpler to just use
// numerical gradients.
if (gradient != NULL) {
for (int ipar = 0; ipar < mptr->size(); ++ipar) {
// Get reference to model parameter
const GModelPar& par = (*mptr)[ipar];
// Make sure that we have a slot for the gradient
#if defined(G_RANGE_CHECK)
if (igrad >= grad_size) {
std::string msg = "Vector has not enough elements "
"to store the model parameter "
"gradients. "+
gammalib::str(models.npars())+
" elements requested while vector "
"only contains "+
gammalib::str(gradient->size())+
" elements.";
throw GException::invalid_value(G_MODEL, msg);
}
#endif
if (par.is_free()) {
if (par.has_grad() && !response()->use_edisp()) {
(*gradient)[igrad+ipar] = par.factor_gradient();
}
else {
(*gradient)[igrad+ipar] = model_grad(*mptr, par, event);
}
}
else {
(*gradient)[igrad+ipar] = 0.0;
}
}
}
} // endif: model component was valid for instrument
// Increment parameter counter for gradients
igrad += mptr->size();
} // endif: model was valid
} // endfor: Looped over models
// Return
return model;
}
/***********************************************************************//**
* @brief Return total number (and optionally gradient) of predicted counts
* for all models
*
* @param[in] models Models.
* @param[out] gradient Model parameter gradients (optional).
*
* @exception GException::gradient_par_mismatch
* Dimension of gradient vector mismatches number of parameters.
*
* Returns the total number of predicted counts within the analysis region.
* If NULL is passed for the gradient vector then gradients will not be
* computed.
*
* The method will only operate on models for which the list of instruments
* and observation identifiers matches those of the observation. Models that
* do not match will be skipped.
***************************************************************************/
double GObservation::npred(const GModels& models, GVector* gradient) const
{
// Verify that gradient vector and models have the same dimension
#if defined(G_RANGE_CHECK)
if (gradient != NULL) {
if (models.npars() != gradient->size()) {
throw GException::gradient_par_mismatch(G_MODEL,
gradient->size(),
models.npars());
}
}
#endif
// Initialise
double npred = 0.0; // Reset predicted number of counts
int igrad = 0; // Reset gradient counter
// If gradient is available then reset gradient vector elements to 0
if (gradient != NULL) {
(*gradient) = 0.0;
}
// Loop over models
for (int i = 0; i < models.size(); ++i) {
// Get model pointer. Continue only if pointer is valid
const GModel* mptr = models[i];
if (mptr != NULL) {
// Continue only if model applies to specific instrument and
// observation identifier
if (mptr->is_valid(instrument(), id())) {
// Determine Npred for model
npred += this->npred(*mptr);
// Optionally determine Npred gradients
if (gradient != NULL) {
for (int k = 0; k < mptr->size(); ++k) {
const GModelPar& par = (*mptr)[k];
(*gradient)[igrad+k] = npred_grad(*mptr, par);
}
}
} // endif: model component was valid for instrument
// Increment parameter counter for gradient
igrad += mptr->size();
} // endif: model was valid
} // endfor: Looped over models
// Return prediction
return npred;
}
/***********************************************************************//**
* @brief Return total number of predicted counts for one model
*
* @param[in] model Gamma-ray source model.
*
* @exception GException::gti_invalid
* Good Time Interval is invalid.
*
* Computes
*
* \f[
* N_{\rm pred} = \int_{\rm GTI} \int_{E_{\rm bounds}} \int_{\rm ROI}
* P(p',E',t') \, dp' \, dE' \, dt'
* \f]
*
* of the event probability
*
* \f[
* P(p',E',t') = \int \int \int
* S(p,E,t) \times R(p',E',t'|p,E,t) \, dp \, dE \, dt
* \f]
*
* where
* \f$S(p,E,t)\f$ is the source model,
* \f$R(p',E',t'|p,E,t)\f$ is the instrument response function,
* \f$p'\f$ is the measured photon direction,
* \f$E'\f$ is the measured photon energy,
* \f$t'\f$ is the measured photon arrival time,
* \f$p\f$ is the true photon arrival direction,
* \f$E\f$ is the true photon energy, and
* \f$t\f$ is the true photon arrival time.
*
* This method performs the time integration over the Good Time Intervals
* \f${\rm GTI}\f$. Note that MET is used for the time integration interval.
* This, however, is no specialisation since npred_grad_kern_spec::eval()
* converts the argument back in a GTime object by assuming that the argument
* is in MET, hence the correct time system will be used at the end by the
* method.
***************************************************************************/
double GObservation::npred(const GModel& model) const
{
// Initialise result
double npred = 0.0;
// Continue only if model applies to specific instrument and
// observation identifier
if (model.is_valid(instrument(), id())) {
// Case A: If the model is constant then integrate analytically
if (model.is_constant()) {
// Evaluate model at first start time and multiply by ontime
double ontime = events()->gti().ontime();
// Integrate only if ontime is positive
if (ontime > 0.0) {
// Integration is a simple multiplication by the time
npred = npred_spec(model, events()->gti().tstart()) * ontime;
}
} // endif: model was constant
// ... otherwise integrate temporally
else {
// Loop over GTIs
for (int i = 0; i < events()->gti().size(); ++i) {
// Set integration interval in seconds
double tstart = events()->gti().tstart(i).secs();
double tstop = events()->gti().tstop(i).secs();
// Throw exception if time interval is not valid
if (tstop <= tstart) {
throw GException::gti_invalid(G_NPRED,
events()->gti().tstart(i),
events()->gti().tstop(i));
}
// Setup integration function
GObservation::npred_kern integrand(this, &model);
GIntegral integral(&integrand);
// Do Romberg integration
npred += integral.romberg(tstart, tstop);
} // endfor: looped over GTIs
} // endelse: integrated temporally
} // endif: model was valid
// Return Npred
return npred;
}
/***********************************************************************//**
* @brief Returns parameter gradient of model for a given event
*
* @param[in] model Model.
* @param[in] par Model parameter.
* @param[in] event Event.
*
* This method uses a robust but simple difference method to estimate
* parameter gradients that have not been provided by the model. We use here
* a simple method as this method is likely used for spatial model parameters,
* and the spatial model may eventually be noisy due to numerical integration
* limits.
*
* The step size for the simple method has been fixed to 0.0002, which
* corresponds to about 1 arcsec for parameters that are given in degrees.
* The reasoning behind this value is that parameters that use numerical
* gradients are typically angles, such as for example the position, and
* we want to achieve arcsec precision with this method.
***************************************************************************/
double GObservation::model_grad(const GModel& model,
const GModelPar& par,
const GEvent& event) const
{
// Initialise gradient
double grad = 0.0;
// Compute gradient only if parameter is free
if (par.is_free()) {
// Get non-const model pointer
GModelPar* ptr = const_cast<GModelPar*>(&par);
// Save current model parameter
GModelPar current = par;
// Get actual parameter value
double x = par.factor_value();
// Set fixed step size for computation of derivative.
// By default, the step size is fixed to 0.0002.
const double step_size = 0.0002; // ~1 arcsec
double h = step_size;
// Re-adjust the step-size h in case that the initial step size is
// larger than the allowed parameter range
if (par.has_min() && par.has_max()) {
double par_h = par.factor_max() - par.factor_min();
if (par_h < h) {
h = par_h;
}
}
// Continue only if step size is positive
if (h > 0.0) {
// Remove any boundaries to avoid limitations
//ptr->remove_range(); // Not needed in principle
// Setup derivative function
GObservation::model_func function(this, &model, ptr, &event);
GDerivative derivative(&function);
// If we are too close to the minimum boundary use a right sided
// difference ...
if (par.has_min() && ((x-par.factor_min()) < h)) {
grad = derivative.right_difference(x, h);
}
// ... otherwise if we are too close to the maximum boundary use
// a left sided difference ...
else if (par.has_max() && ((par.factor_max()-x) < h)) {
grad = derivative.left_difference(x, h);
}
// ... otherwise use a symmetric difference
else {
grad = derivative.difference(x, h);
}
} // endif: step size was positive
// Restore current model parameter
*ptr = current;
} // endif: model parameter was free
// Return gradient
return grad;
}
/***********************************************************************//**
* @brief Returns parameter gradient of Npred
*
* @param[in] model Gamma-ray source model.
* @param[in] par Model parameter.
*
* Computes
*
* \f[
* \frac{{\rm d} N_{\rm pred}}{{\rm d} a_i}
* \f]
*
* where
*
* \f[
* N_{\rm pred} = \int_{\rm GTI} \int_{E_{\rm bounds}} \int_{\rm ROI}
* P(p',E',t') \, dp' \, dE' \, dt'
* \f]
*
* is the integral of the event probability
*
* \f[
* P(p',E',t') = \int \int \int
* S(p,E,t) \times R(p',E',t'|p,E,t) \, dp \, dE \, dt
* \f]
*
* and
* \f$a_i\f$ is the model parameter \f$i\f$.
* Furthermore
* \f$S(p,E,t)\f$ is the source model,
* \f$R(p',E',t'|p,E,t)\f$ is the instrument response function,
* \f$p'\f$ is the measured photon direction,
* \f$E'\f$ is the measured photon energy,
* \f$t'\f$ is the measured photon arrival time,
* \f$p\f$ is the true photon arrival direction,
* \f$E\f$ is the true photon energy, and
* \f$t\f$ is the true photon arrival time.
*
* This method uses a robust but simple difference method to estimate
* parameter gradients that have not been provided by the model. We use here
* a simple method as this method is likely used for spatial model parameters,
* and the spatial model may eventually be noisy due to numerical integration
* limits.
*
* The step size for the simple method has been fixed to 0.0002, which
* corresponds to about 1 arcsec for parameters that are given in degrees.
* The reasoning behind this value is that parameters that use numerical
* gradients are typically angles, such as for example the position, and
* we want to achieve arcsec precision with this method.
***************************************************************************/
double GObservation::npred_grad(const GModel& model, const GModelPar& par) const
{
// Initialise result
double grad = 0.0;
// Compute gradient only if parameter is free
if (par.is_free()) {
// Get non-const model pointer
GModelPar* ptr = const_cast<GModelPar*>(&par);
// Save current model parameter
GModelPar current = par;
// Get actual parameter value
double x = par.factor_value();
// Set fixed step size for computation of derivative.
// By default, the step size is fixed to 0.0002.
const double step_size = 0.0002; // ~1 arcsec
double h = step_size;
// Re-adjust the step-size h in case that the initial step size is
// larger than the allowed parameter range
if (par.has_min() && par.has_max()) {
double par_h = par.factor_max() - par.factor_min();
if (par_h < h) {
h = par_h;
}
}
// Continue only if step size is positive
if (h > 0.0) {
// Remove any boundaries to avoid limitations
//ptr->remove_range(); // Not needed in principle
// Setup derivative function
GObservation::npred_func function(this, &model, ptr);
GDerivative derivative(&function);
// If we are too close to the minimum boundary use a right sided
// difference ...
if (par.has_min() && ((x-par.factor_min()) < h)) {
grad = derivative.right_difference(x, h);
}
// ... otherwise if we are too close to the maximum boundary use
// a left sided difference ...
else if (par.has_max() && ((par.factor_max()-x) < h)) {
grad = derivative.left_difference(x, h);
}
// ... otherwise use a symmetric difference
else {
grad = derivative.difference(x, h);
}
} // endif: step size was positive
// Restore current model parameter
*ptr = current;
} // endif: model parameter was free
// Return result
return grad;
}
/***********************************************************************//**
* @brief Set event container
*
* @param[in] events Event container.
*
* Set the event container for this observation by cloning the container
* specified in the argument.
***************************************************************************/
void GObservation::events(const GEvents& events)
{
// Remove an existing event container
if (m_events != NULL) delete m_events;
// Clone events
m_events = events.clone();
// Return
return;
}
/***********************************************************************//**
* @brief Return events
*
* @exception GException::no_events
* No events allocated for observation.
*
* Returns pointer to events.
***************************************************************************/
GEvents* GObservation::events(void)
{
// Throw an exception if the event container is not valid
if (m_events == NULL) {
std::string msg = "No events allocated for observation.";
throw GException::invalid_value(G_EVENTS, msg);
}
// Return pointer to events
return (m_events);
}
/***********************************************************************//**
* @brief Return events (const version)
*
* @exception GException::no_events
* No events allocated for observation.
*
* Returns const pointer to events.
***************************************************************************/
const GEvents* GObservation::events(void) const
{
// Throw an exception if the event container is not valid
if (m_events == NULL) {
std::string msg = "No events allocated for observation.";
throw GException::invalid_value(G_EVENTS, msg);
}
// Return pointer to events
return (m_events);
}
/*==========================================================================
= =
= Private methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Initialise class members
***************************************************************************/
void GObservation::init_members(void)
{
// Initialise members
m_name.clear();
m_id.clear();
m_statistics = "Poisson";
m_events = NULL;
// Return
return;
}
/***********************************************************************//**
* @brief Copy class members
*
* @param[in] obs Observation.
*
* Copy members from an observation.
***************************************************************************/
void GObservation::copy_members(const GObservation& obs)
{
// Copy members
m_name = obs.m_name;
m_id = obs.m_id;
m_statistics = obs.m_statistics;
// Clone members
m_events = (obs.m_events != NULL) ? obs.m_events->clone() : NULL;
// Return
return;
}
/***********************************************************************//**
* @brief Delete class members
***************************************************************************/
void GObservation::free_members(void)
{
// Free members
if (m_events != NULL) delete m_events;
// Signal free pointers
m_events = NULL;
// Return
return;
}
/*==========================================================================
= =
= Likelihood methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Evaluate log-likelihood function for Poisson statistics and
* unbinned analysis (version with working arrays)
*
* @param[in] models Models.
* @param[in,out] gradient Gradient.
* @param[in,out] curvature Curvature matrix.
* @param[in,out] npred Number of predicted events.
* @return Likelihood value.
*
* This method evaluates the -(log-likelihood) function for parameter
* optimisation using unbinned analysis and Poisson statistics.
* The -(log-likelihood) function is given by
*
* \f[
* L = N_{\rm pred} - \sum_i \log e_i
* \f]
*
* where
* \f$N_{\rm pred}\f$ is the number of events predicted by the model, and
* the sum is taken over all events. This method also computes the
* parameter gradients
* \f$\delta L/dp\f$
* and the curvature matrix
* \f$\delta^2 L/dp_1 dp_2\f$.
***************************************************************************/
double GObservation::likelihood_poisson_unbinned(const GModels& models,
GVector* gradient,
GMatrixSparse* curvature,
double* npred) const
{
// Initialise likelihood value
double value = 0.0;
// Get number of parameters
int npars = gradient->size();
// Allocate some working arrays
int* inx = new int[npars];
double* values = new double[npars];
GVector wrk_grad(npars);
// Determine Npred value and gradient for this observation
double npred_value = this->npred(models, &wrk_grad);
// Update likelihood, Npred and gradient
value += npred_value;
*npred += npred_value;
*gradient += wrk_grad;
// Iterate over all events
for (int i = 0; i < events()->size(); ++i) {
// Get event pointer
const GEvent* event = (*events())[i];
// Get model and derivative
double model = this->model(models, *event, &wrk_grad);
// Skip bin if model is too small (avoids -Inf or NaN gradients)
if (model <= minmod) {
continue;
}
// Create index array of non-zero derivatives and initialise working
// array
int ndev = 0;
for (int i = 0; i < npars; ++i) {
values[i] = 0.0;
if (wrk_grad[i] != 0.0 && !gammalib::is_infinite(wrk_grad[i])) {
inx[ndev] = i;
ndev++;
}
}
// Update Poissonian statistics (excluding factorial term for faster
// computation)
value -= log(model);
// Skip bin now if there are no non-zero derivatives
if (ndev < 1) {
continue;
}
// Update gradient vector and curvature matrix.
double fb = 1.0 / model;
double fa = fb / model;
for (int jdev = 0; jdev < ndev; ++jdev) {
// Initialise computation
register int jpar = inx[jdev];
double g = wrk_grad[jpar];
double fa_i = fa * g;
// Update gradient.
(*gradient)[jpar] -= fb * g;
// Loop over rows
register int* ipar = inx;
for (register int idev = 0; idev < ndev; ++idev, ++ipar) {
values[idev] = fa_i * wrk_grad[*ipar];
}
// Add column to matrix
curvature->add_to_column(jpar, values, inx, ndev);
} // endfor: looped over columns
} // endfor: iterated over all events
// Free temporary memory
if (values != NULL) delete [] values;
if (inx != NULL) delete [] inx;
// Return
return value;
}
/***********************************************************************//**
* @brief Evaluate log-likelihood function for Poisson statistics and
* binned analysis (version with working arrays)
*
* @param[in] models Models.
* @param[in,out] gradient Gradient.
* @param[in,out] curvature Curvature matrix.
* @param[in,out] npred Number of predicted events.
* @return Likelihood value.
*
* This method evaluates the -(log-likelihood) function for parameter
* optimisation using binned analysis and Poisson statistics.
* The -(log-likelihood) function is given by
*
* \f[
* L=-\sum_i n_i \log e_i - e_i
* \f]
*
* where the sum is taken over all data space bins, \f$n_i\f$ is the
* observed number of counts and \f$e_i\f$ is the model.
* This method also computes the parameter gradients
* \f$\delta L/dp\f$
* and the curvature matrix
* \f$\delta^2 L/dp_1 dp_2\f$
* and also updates the total number of predicted events m_npred.
***************************************************************************/
double GObservation::likelihood_poisson_binned(const GModels& models,
GVector* gradient,
GMatrixSparse* curvature,
double* npred) const
{
// Initialise likelihood value
double value = 0.0;
// Initialise statistics
#if defined(G_OPT_DEBUG)
int n_bins = 0;
int n_used = 0;
int n_small_model = 0;
int n_zero_data = 0;
int n_exclude_data = 0;
double sum_data = 0.0;
double sum_model = 0.0;
double init_value = value;
#endif
// Get number of parameters
int npars = gradient->size();
// Allocate some working arrays
int* inx = new int[npars];
double* values = new double[npars];
GVector wrk_grad(npars);
// Iterate over all bins
for (int i = 0; i < events()->size(); ++i) {
// Update number of bins
#if defined(G_OPT_DEBUG)
n_bins++;
#endif
// Get event pointer
const GEventBin* bin =
(*(static_cast<GEventCube*>(const_cast<GEvents*>(events()))))[i];
// Get number of counts in bin
double data = bin->counts();
// Skip bin if data is negative (filtering flag)
if (data < 0) {
#if defined(G_OPT_DEBUG)
n_exclude_data++;
#endif
continue;
}
// Get model and derivative
double model = this->model(models, *bin, &wrk_grad);
// Multiply model by bin size
model *= bin->size();
// Skip bin if model is too small (avoids -Inf or NaN gradients)
if (model <= minmod) {
#if defined(G_OPT_DEBUG)
n_small_model++;
#endif
continue;
}
// Update statistics
#if defined(G_OPT_DEBUG)
n_used++;
sum_data += data;
sum_model += model;
#endif
// Update Npred
*npred += model;
// Multiply gradient by bin size
wrk_grad *= bin->size();
// Create index array of non-zero derivatives and initialise working
// array
int ndev = 0;
for (int i = 0; i < npars; ++i) {
values[i] = 0.0;
if (wrk_grad[i] != 0.0 && !gammalib::is_infinite(wrk_grad[i])) {
inx[ndev] = i;
ndev++;
}
}
// Update gradient vector and curvature matrix. To avoid
// unneccessary computations we distinguish the case where
// data>0 and data=0. The second case requires much less
// computation since it does not contribute to the curvature
// matrix ...
if (data > 0.0) {
// Update Poissonian statistics (excluding factorial term for
// faster computation)
value -= data * log(model) - model;
// Skip bin now if there are no non-zero derivatives
if (ndev < 1) {
continue;
}
// Pre computation
double fb = data / model;
double fc = (1.0 - fb);
double fa = fb / model;
// Loop over columns
for (int jdev = 0; jdev < ndev; ++jdev) {
// Initialise computation
register int jpar = inx[jdev];
double g = wrk_grad[jpar];
double fa_i = fa * g;
// Update gradient
(*gradient)[jpar] += fc * g;
// Loop over rows
register int* ipar = inx;
for (register int idev = 0; idev < ndev; ++idev, ++ipar) {
values[idev] = fa_i * wrk_grad[*ipar];
}
// Add column to matrix
curvature->add_to_column(jpar, values, inx, ndev);
} // endfor: looped over columns
} // endif: data was > 0
// ... handle now data=0
else {
// Update statistics
#if defined(G_OPT_DEBUG)
n_zero_data++;
#endif
// Update Poissonian statistics (excluding factorial term for
// faster computation)
value += model;
// Skip bin now if there are no non-zero derivatives
if (ndev < 1) {
continue;
}
// Update gradient
register int* ipar = inx;
for (register int idev = 0; idev < ndev; ++idev, ++ipar) {
(*gradient)[*ipar] += wrk_grad[*ipar];
}
} // endif: data was 0
} // endfor: iterated over all events
// Free temporary memory
if (values != NULL) delete [] values;
if (inx != NULL) delete [] inx;
// Dump statistics
#if defined(G_OPT_DEBUG)
std::cout << "Number of bins: " << n_bins << std::endl;
std::cout << "Number of bins used for computation: " << n_used << std::endl;
std::cout << "Number of bins excluded from data: " << n_exclude_data << std::endl;
std::cout << "Number of bins excluded due to small model: " << n_small_model << std::endl;
std::cout << "Number of bins with zero data: " << n_zero_data << std::endl;
std::cout << "Sum of data: " << sum_data << std::endl;
std::cout << "Sum of model: " << sum_model << std::endl;
std::cout << "Initial statistics: " << init_value << std::endl;
std::cout << "Statistics: " << m_value-init_value << std::endl;
#endif
// Return
return value;
}
/***********************************************************************//**
* @brief Evaluate log-likelihood function for Gaussian statistics and
* binned analysis (version with working arrays)
*
* @param[in] models Models.
* @param[in,out] gradient Gradient.
* @param[in,out] curvature Curvature matrix.
* @param[in,out] npred Number of predicted events.
* @return Likelihood value.
*
* This method evaluates the -(log-likelihood) function for parameter
* optimisation using binned analysis and Poisson statistics.
* The -(log-likelihood) function is given by
*
* \f[
* L = 1/2 \sum_i (n_i - e_i)^2 \sigma_i^{-2}
* \f]
*
* where the sum is taken over all data space bins, \f$n_i\f$ is the
* observed number of counts, \f$e_i\f$ is the model and \f$\sigma_i\f$
* is the statistical uncertainty.
* This method also computes the parameter gradients
* \f$\delta L/dp\f$
* and the curvature matrix
* \f$\delta^2 L/dp_1 dp_2\f$
* and also updates the total number of predicted events m_npred.
***************************************************************************/
double GObservation::likelihood_gaussian_binned(const GModels& models,
GVector* gradient,
GMatrixSparse* curvature,
double* npred) const
{
// Initialise likelihood value
double value = 0.0;
// Get number of parameters
int npars = gradient->size();
// Allocate some working arrays
int* inx = new int[npars];
double* values = new double[npars];
GVector wrk_grad(npars);
// Iterate over all bins
for (int i = 0; i < events()->size(); ++i) {
// Get event pointer
const GEventBin* bin =
(*(static_cast<GEventCube*>(const_cast<GEvents*>(events()))))[i];
// Get number of counts in bin
double data = bin->counts();
// Skip bin if data is negative (filtering flag)
if (data < 0) {
continue;
}
// Get statistical uncertainty
double sigma = bin->error();
// Skip bin if statistical uncertainty is too small
if (sigma <= minerr) {
continue;
}
// Get model and derivative
double model = this->model(models, *bin, &wrk_grad);
// Multiply model by bin size
model *= bin->size();
// Skip bin if model is too small (avoids -Inf or NaN gradients)
if (model <= minmod) {
continue;
}
// Update Npred
*npred += model;
// Multiply gradient by bin size
wrk_grad *= bin->size();
// Create index array of non-zero derivatives and initialise working
// array
int ndev = 0;
for (int i = 0; i < npars; ++i) {
values[i] = 0.0;
if (wrk_grad[i] != 0.0 && !gammalib::is_infinite(wrk_grad[i])) {
inx[ndev] = i;
ndev++;
}
}
// Set weight
double weight = 1.0 / (sigma * sigma);
// Update Gaussian statistics
double fa = data - model;
value += 0.5 * (fa * fa * weight);
// Skip bin now if there are no non-zero derivatives
if (ndev < 1) {
continue;
}
// Loop over columns
for (int jdev = 0; jdev < ndev; ++jdev) {
// Initialise computation
register int jpar = inx[jdev];
double fa_i = wrk_grad[jpar] * weight;
// Update gradient
(*gradient)[jpar] -= fa * fa_i;
// Loop over rows
register int* ipar = inx;
for (register int idev = 0; idev < ndev; ++idev, ++ipar) {
values[idev] = fa_i * wrk_grad[*ipar];
}
// Add column to matrix
curvature->add_to_column(jpar, values, inx, ndev);
} // endfor: looped over columns
} // endfor: iterated over all events
// Free temporary memory
if (values != NULL) delete [] values;
if (inx != NULL) delete [] inx;
// Return
return value;
}
/*==========================================================================
= =
= Model gradient methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Model function evaluation for gradient computation
*
* @param[in] x Function value.
***************************************************************************/
double GObservation::model_func::eval(const double& x)
{
// Set value
m_par->factor_value(x);
// Compute model value
double value = m_model->eval(*m_event, *m_parent);
// Return value
return value;
}
/*==========================================================================
= =
= Npred computation methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Npred function evaluation for gradient computation
*
* @param[in] x Function value.
***************************************************************************/
double GObservation::npred_func::eval(const double& x)
{
// Set value
m_par->factor_value(x);
// Compute Npred value
double npred = m_parent->npred(*m_model);
// Return value
return npred;
}
/***********************************************************************//**
* @brief Integration kernel for npred() method
*
* @param[in] x Function value.
***************************************************************************/
double GObservation::npred_kern::eval(const double& x)
{
// Convert argument in native reference in seconds
GTime time;
time.secs(x);
// Return value
return (m_parent->npred_spec(*m_model, time));
}
/***********************************************************************//**
* @brief Integrates spatially integrated Npred kernel spectrally
*
* @param[in] model Gamma-ray source model.
* @param[in] obsTime Measured photon arrival time.
*
* @exception GException::erange_invalid
* Energy range is invalid.
*
* Computes
*
* \f[
* N_{\rm pred}(t') = \int_{E_{\rm bounds}} \int_{\rm ROI}
* P(p',E',t') \, dp' \, dE'
* \f]
*
* of the event probability
*
* \f[
* P(p',E',t') = \int \int \int
* S(p,E,t) \times R(p',E',t'|p,E,t) \, dp \, dE \, dt
* \f]
*
* where
* \f$S(p,E,t)\f$ is the source model,
* \f$R(p',E',t'|p,E,t)\f$ is the instrument response function,
* \f$p'\f$ is the measured photon direction,
* \f$E'\f$ is the measured photon energy,
* \f$t'\f$ is the measured photon arrival time,
* \f$p\f$ is the true photon arrival direction,
* \f$E\f$ is the true photon energy, and
* \f$t\f$ is the true photon arrival time.
*
* This method performs the energy intergration over the energy boundaries
* \f$E_{\rm bounds}\f$.
***************************************************************************/
double GObservation::npred_spec(const GModel& model,
const GTime& obsTime) const
{
// Set number of iterations for Romberg integration.
static const int iter = 8;
// Initialise result
double result = 0.0;
// Get energy boundaries
GEbounds ebounds = events()->ebounds();
// Loop over energy boundaries
for (int i = 0; i < ebounds.size(); ++i) {
// Get boundaries in MeV
double emin = ebounds.emin(i).MeV();
double emax = ebounds.emax(i).MeV();
// Continue only if valid
if (emax > emin) {
// Setup integration function
GObservation::npred_spec_kern integrand(this, &model, &obsTime);
GIntegral integral(&integrand);
// Set number of iterations
integral.fixed_iter(iter);
// Do Romberg integration
#if defined(G_LN_ENERGY_INT)
emin = std::log(emin);
emax = std::log(emax);
#endif
result += integral.romberg(emin, emax);
} // endif: energy interval was valid
} // endfor: looped over energy boundaries
// Compile option: Check for NaN/Inf
#if defined(G_NAN_CHECK)
if (gammalib::is_notanumber(result) || gammalib::is_infinite(result)) {
std::cout << "*** ERROR: GObservation::npred_spec:";
std::cout << " NaN/Inf encountered";
std::cout << " (result=" << result;
std::cout << ")" << std::endl;
}
#endif
// Return result
return result;
}
/***********************************************************************//**
* @brief Integration kernel for npred_spec() method
*
* @param[in] x Function value.
*
* This method implements the integration kernel needed for the npred_spec()
* method. If G_LN_ENERGY_INT is defined the energy integration is done
* logarithmically, i.e. @p x is given in ln(energy) instead of energy.
***************************************************************************/
double GObservation::npred_spec_kern::eval(const double& x)
{
// Set energy
GEnergy eng;
#if defined(G_LN_ENERGY_INT)
double expx = std::exp(x);
eng.MeV(expx);
#else
eng.MeV(x);
#endif
// Get function value
double value = m_model->npred(eng, *m_time, *m_parent);
// Save value if needed
#if defined(G_NAN_CHECK)
double value_out = value;
#endif
// Correct for variable substitution
#if defined(G_LN_ENERGY_INT)
value *= expx;
#endif
// Compile option: Check for NaN
#if defined(G_NAN_CHECK)
if (gammalib::is_notanumber(value) || gammalib::is_infinite(value)) {
std::cout << "*** ERROR: GObservation::npred_spec_kern::eval";
std::cout << "(x=" << x << "): ";
std::cout << " NaN/Inf encountered";
std::cout << " (value=" << value;
std::cout << " (value_out=" << value_out;
#if defined(G_LN_ENERGY_INT)
std::cout << " exp(x)=" << expx;
#endif
std::cout << ")" << std::endl;
}
#endif
// Return value
return value;
}