GCTAOnOffObservation.cpp
55.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
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
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
/***************************************************************************
* GCTAOnOffObservation.cpp - CTA On/Off observation class *
* ----------------------------------------------------------------------- *
* copyright (C) 2013-2017 by Chia-Chun Lu & Christoph Deil *
* ----------------------------------------------------------------------- *
* *
* 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 GCTAOnOffObservation.cpp
* @brief CTA On/Off observation class implementation
* @author Chia-Chun Lu & Christoph Deil
*/
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <typeinfo>
#include "GObservationRegistry.hpp"
#include "GTools.hpp"
#include "GModels.hpp"
#include "GModelSky.hpp"
#include "GModelSpatial.hpp"
#include "GModelSpectral.hpp"
#include "GModelTemporal.hpp"
#include "GSkyRegionCircle.hpp"
#include "GOptimizerPars.hpp"
#include "GCTAObservation.hpp"
#include "GCTAEventAtom.hpp"
#include "GCTAEventCube.hpp"
#include "GCTAResponseIrf.hpp"
#include "GCTACubeBackground.hpp"
#include "GCTAModelIrfBackground.hpp"
#include "GCTAOnOffObservation.hpp"
/* __ OpenMP section _____________________________________________________ */
#ifdef _OPENMP
#include <omp.h>
#endif
/* __ Globals ____________________________________________________________ */
const GCTAOnOffObservation g_onoff_obs_cta_seed;
const GObservationRegistry g_onoff_obs_cta_registry(&g_onoff_obs_cta_seed);
/* __ Method name definitions ____________________________________________ */
#define G_RESPONSE_SET "GCTAOnOffObservation::response(GResponse&)"
#define G_RESPONSE_GET "GCTAOnOffObservation::response()"
#define G_WRITE "GCTAOnOffObservation::write(GXmlElement&)"
#define G_READ "GCTAOnOffObservation::read(GXmlElement&)"
#define G_LIKELIHOOD "GCTAOnOffObservation::likelihood(GModels&, "\
"GOptimizerPars&, GMatrixSparse&, "\
"GVector&, double&, double&)"
#define G_SET "GCTAOnOffObservation::set(GCTAObservation&)"
#define G_COMPUTE_ARF "GCTAOnOffObservation::compute_arf(GCTAObservation&)"
#define G_COMPUTE_BGD "GCTAOnOffObservation::compute_bgd(GCTAObservation&)"
#define G_COMPUTE_ALPHA "GCTAOnOffObservation::compute_alpha("\
"GCTAObservation&)"
#define G_COMPUTE_RMF "GCTAOnOffObservation::compute_rmf(GCTAObservation&)"
/* __ Constants __________________________________________________________ */
const double minmod = 1.0e-100; //!< Minimum model value
const double minerr = 1.0e-100; //!< Minimum statistical error
/* __ Macros _____________________________________________________________ */
/* __ Coding definitions _________________________________________________ */
/* __ Debug definitions __________________________________________________ */
//#define G_LIKELIHOOD_DEBUG //!< Debug likelihood computation
/*==========================================================================
= =
= Constructors/destructors =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Void constructor
*
* Constructs empty On/Off observation.
***************************************************************************/
GCTAOnOffObservation::GCTAOnOffObservation(void) : GObservation()
{
// Initialise private members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Copy constructor
*
* @param[in] obs On/Off observation.
***************************************************************************/
GCTAOnOffObservation::GCTAOnOffObservation(const GCTAOnOffObservation& obs) :
GObservation(obs)
{
// Initialise private
init_members();
// Copy members
copy_members(obs);
// Return
return;
}
/***********************************************************************//**
* @brief CTA observation constructor
*
* @param[in] obs CTA observation.
* @param[in] etrue True energy boundaries.
* @param[in] ereco Reconstructed energy boundaries.
* @param[in] on On regions.
* @param[in] off Off regions.
*
* Constructs On/Off observation a CTA observation by filling the On and Off
* spectra and computing the Auxiliary Response File (ARF) and Redistribution
* Matrix File (RMF). The method requires the specification of the true and
* reconstructed energy boundaries, as well as the definition of On and Off
* regions.
***************************************************************************/
GCTAOnOffObservation::GCTAOnOffObservation(const GCTAObservation& obs,
const GEbounds& etrue,
const GEbounds& ereco,
const GSkyRegions& on,
const GSkyRegions& off) :
GObservation()
{
// Initialise private
init_members();
// Initialise spectra
m_on_spec = GPha(ereco);
m_off_spec = GPha(ereco);
// Initialise response information
m_arf = GArf(ereco);
m_rmf = GRmf(etrue, ereco);
// Store regions
m_on_regions = on;
m_off_regions = off;
// Set On/Off observation from CTA observation
set(obs);
// Return
return;
}
/***********************************************************************//**
* @brief Destructor
***************************************************************************/
GCTAOnOffObservation::~GCTAOnOffObservation(void)
{
// Free members
free_members();
// Return
return;
}
/*==========================================================================
= =
= Operators =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Assignment operator
*
* @param[in] obs On/Off observation.
* @return On/Off observation.
*
* Assigns one On/Off observation to another On/Off observation object.
***************************************************************************/
GCTAOnOffObservation& GCTAOnOffObservation::operator=(const GCTAOnOffObservation& obs)
{
// Execute only if object is not identical
if (this != &obs) {
// Copy base class members
this->GObservation::operator=(obs);
// Free members
free_members();
// Initialise private members for clean destruction
init_members();
// Copy members
copy_members(obs);
} // endif: object was not identical
// Return
return *this;
}
/*==========================================================================
= =
= Public methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Clear instance
*
* Clears the On/Off observation. All class members will be set to the
* initial state. Any information that was present in the object before will
* be lost.
***************************************************************************/
void GCTAOnOffObservation::clear(void)
{
// Free class members
free_members();
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Clone instance
*
* @return Pointer to deep copy of On/Off observation.
*
* Returns a pointer to a deep copy of an On/Off observation.
**************************************************************************/
GCTAOnOffObservation* GCTAOnOffObservation::clone(void) const
{
return new GCTAOnOffObservation(*this);
}
/***********************************************************************//**
* @brief Set response function
*
* @param[in] rsp Response function.
*
* @exception GException::invalid_argument
* Invalid response class specified.
*
* Sets the response function for the On/Off observation.
***************************************************************************/
void GCTAOnOffObservation::response(const GResponse& rsp)
{
// Cast response dynamically
const GCTAResponse* ptr = dynamic_cast<const GCTAResponse*>(&rsp);
// Throw exception if response is not of correct type
if (ptr == NULL) {
std::string cls = std::string(typeid(&rsp).name());
std::string msg = "Invalid response type \""+cls+"\" provided on "
"input. Please specify a \"GCTAResponse\" "
"as argument.";
throw GException::invalid_argument(G_RESPONSE_SET, msg);
}
// Free response
if (m_response != NULL) delete m_response;
// Clone response function
m_response = ptr->clone();
// Return
return;
}
/***********************************************************************//**
* @brief Return pointer to CTA response function
*
* @return Pointer to CTA response function.
*
* @exception GException::invalid_value
* No valid response found in CTA observation.
*
* Returns a pointer to the CTA response function. An exception is thrown if
* the pointer is not valid, hence the user does not need to verify the
* validity of the pointer.
***************************************************************************/
const GCTAResponse* GCTAOnOffObservation::response(void) const
{
// Throw an exception if the response pointer is not valid
if (m_response == NULL) {
std::string msg = "No valid response function found in CTA On/Off "
"observation.\n";
throw GException::invalid_value(G_RESPONSE_GET, msg);
}
// Return pointer
return m_response;
}
/***********************************************************************//**
* @brief Read On/Off observation from an XML element
*
* @param[in] xml XML element.
*
* Reads information for an On/Off observation from an XML element. The
* expected format of the XML element is
*
* <observation name="..." id="..." instrument="...">
* <parameter name="Pha_on" file="..."/>
* <parameter name="Pha_off" file="..."/>
* <parameter name="Regions_on" file="..."/>
* <parameter name="Regions_off" file="..."/>
* <parameter name="Arf" file="..."/>
* <parameter name="Rmf" file="..."/>
* </observation>
*
***************************************************************************/
void GCTAOnOffObservation::read(const GXmlElement& xml)
{
// clean object
clear();
// Extract instrument name
m_instrument = xml.attribute("instrument");
// Get file names
std::string pha_on = gammalib::xml_get_attr(G_READ, xml, "Pha_on", "file");
std::string pha_off = gammalib::xml_get_attr(G_READ, xml, "Pha_off", "file");
std::string reg_on = gammalib::xml_get_attr(G_READ, xml, "Regions_on", "file");
std::string reg_off = gammalib::xml_get_attr(G_READ, xml, "Regions_off", "file");
std::string arf = gammalib::xml_get_attr(G_READ, xml, "Arf", "file");
std::string rmf = gammalib::xml_get_attr(G_READ, xml, "Rmf", "file");
// Expand file names
pha_on = gammalib::xml_file_expand(xml, pha_on);
pha_off = gammalib::xml_file_expand(xml, pha_off);
reg_on = gammalib::xml_file_expand(xml, reg_on);
reg_off = gammalib::xml_file_expand(xml, reg_off);
arf = gammalib::xml_file_expand(xml, arf);
rmf = gammalib::xml_file_expand(xml, rmf);
// Load files
m_on_spec.load(pha_on);
m_off_spec.load(pha_off);
m_on_regions.load(reg_on);
m_off_regions.load(reg_off);
m_arf.load(arf);
m_rmf.load(rmf);
// Return
return;
}
/***********************************************************************//**
* @brief write observation to an xml element
*
* @param[in] xml XML element.
*
* Writes information for an On/Off observation into an XML element. The
* expected format of the XML element is
*
* <observation name="..." id="..." instrument="...">
* <parameter name="Pha_on" file="..."/>
* <parameter name="Pha_off" file="..."/>
* <parameter name="Regions_on" file="..."/>
* <parameter name="Regions_off" file="..."/>
* <parameter name="Arf" file="..."/>
* <parameter name="Rmf" file="..."/>
* </observation>
*
* The actual files described in the XML elements are not written.
***************************************************************************/
void GCTAOnOffObservation::write(GXmlElement& xml) const
{
// Allocate XML element pointer
GXmlElement* par;
// Set Pha_on parameter
par = gammalib::xml_need_par(G_WRITE, xml, "Pha_on");
par->attribute("file", gammalib::xml_file_reduce(xml, m_on_spec.filename()));
// Set Pha_off parameter
par = gammalib::xml_need_par(G_WRITE, xml, "Pha_off");
par->attribute("file", gammalib::xml_file_reduce(xml, m_off_spec.filename()));
// Set Regions_on parameter
par = gammalib::xml_need_par(G_WRITE, xml, "Regions_on");
par->attribute("file", gammalib::xml_file_reduce(xml, m_on_regions.filename()));
// Set Regions_off parameter
par = gammalib::xml_need_par(G_WRITE, xml, "Regions_off");
par->attribute("file", gammalib::xml_file_reduce(xml, m_off_regions.filename()));
// Set Arf parameter
par = gammalib::xml_need_par(G_WRITE, xml, "Arf");
par->attribute("file", gammalib::xml_file_reduce(xml, m_arf.filename()));
// Set Rmf parameter
par = gammalib::xml_need_par(G_WRITE, xml, "Rmf");
par->attribute("file", gammalib::xml_file_reduce(xml, m_rmf.filename()));
// Return
return;
}
/***********************************************************************//**
* @brief Evaluate log-likelihood function for On/Off analysis
*
* @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 Log-likelihood value.
*
* @exception GException::invalid_value
* There are no model parameters.
*
* Computes the log-likelihood value for the On/Off observation. The
* method loops over the energy bins to update the function value, its
* derivatives and the curvature matrix. The number of On counts
* \f$N_{\rm on}\f$ and Off counts \f$N_{\rm off}\f$ are taken from the
* On and Off spectra, the expected number of gamma-ray events
* \f$N_{\gamma}\f$ and background events \f$N_{\rm bgd}\f$ are
* computed from the spectral models of the relevant components in the
* model container (spatial and temporal components are ignored so far).
* See the N_gamma() and N_bgd() methods for details about the model
* computations.
*
* The log-likelihood is given by
*
* \f[
* \ln L = \sum_i \ln L_i
* \f]
*
* where the sum is taken over all energy bins \f$i\f$ and
*
* \f[
* \ln L_i = - N_{\rm on} \ln N_{\rm pred} + N_{\rm pred}
* - N_{\rm off} \ln N_{\rm bgd} + N_{\rm bgd}
* \f]
*
* with
*
* \f[
* N_{\rm pred} = N_{\gamma} + \alpha N_{\rm bgd}
* \f]
*
* being the total number of predicted events for an energy bin in the On
* region,
* \f$N_{\rm on}\f$ is the total number of observed events for an energy
* bin in the On region,
* \f$N_{\rm off}\f$ is the total number of observed events for an energy
* bin in the Off region, and
* \f$N_{\rm bgd}\f$ is the predicted number of background events for an
* energy bin in the Off region.
*
* The log-likelihood gradient with respect to sky model parameters
* \f$p_{\rm sky}\f$ is given by
*
* \f[
* \left( \frac{\partial \ln L_i}{\partial p_{\rm sky}} \right) =
* \left( 1 - \frac{N_{\rm on}}{N_{\rm pred}} \right)
* \left( \frac{\partial N_{\gamma}}{\partial p_{\rm sky}} \right)
* \f]
*
* and with respect to background model parameters \f$p_{\rm bgd}\f$ is
* given by
*
* \f[
* \left( \frac{\partial \ln L_i}{\partial p_{\rm bgd}} \right) =
* \left( 1 + \alpha - \frac{N_{\rm off}}{N_{\rm bgd}} -
* \frac{\alpha N_{\rm on}}{N_{\rm pred}} \right)
* \left( \frac{\partial N_{\rm bgd}}{\partial p_{\rm bgd}} \right)
* \f]
*
* The curvature matrix elements are given by
*
* \f[
* \left( \frac{\partial^2 \ln L_i}{\partial^2 p_{\rm sky}} \right) =
* \left( \frac{N_{\rm on}}{N_{\rm pred}^2} \right)
* \left( \frac{\partial N_{\gamma}}{\partial p_{\rm sky}} \right)^2
* \f]
*
* \f[
* \left( \frac{\partial^2 \ln L_i}{\partial p_{\rm sky}
* \partial p_{\rm bgd}} \right) =
* \left( \frac{\alpha N_{\rm on}}{N_{\rm pred}^2} \right)
* \left( \frac{\partial N_{\gamma}}{\partial p_{\rm sky}} \right)
* \left( \frac{\partial N_{\rm bgd}}{\partial p_{\rm bgd}} \right)
* \f]
*
* \f[
* \left( \frac{\partial^2 \ln L_i}{\partial p_{\rm bgd}
* \partial p_{\rm sky}} \right) =
* \left( \frac{\alpha N_{\rm on}}{N_{\rm pred}^2} \right)
* \left( \frac{\partial N_{\rm bgd}}{\partial p_{\rm bgd}} \right)
* \left( \frac{\partial N_{\gamma}}{\partial p_{\rm sky}} \right)
* \f]
*
* \f[
* \left( \frac{\partial^2 \ln L_i}{\partial^2 p_{\rm bgd}} \right) =
* \left( \frac{N_{\rm off}}{N_{\rm bgd}^2} +
* \frac{\alpha^2 N_{\rm on}}{N_{\rm pred}^2} \right)
* \left( \frac{\partial N_{\rm bgd}}{\partial p_{\rm bgd}} \right)^2
* \f]
***********************************************************************/
double GCTAOnOffObservation::likelihood(const GModels& models,
GVector* gradient,
GMatrixSparse* curvature,
double* npred) const
{
// Timing measurement
#if defined(G_LIKELIHOOD_DEBUG)
#ifdef _OPENMP
double t_start = omp_get_wtime();
#else
clock_t t_start = clock();
#endif
#endif
// Initialise statistics
#if defined(G_LIKELIHOOD_DEBUG)
int n_bins = m_on_spec.size();
int n_used = 0;
int n_small_model = 0;
int n_zero_data = 0;
double sum_data = 0.0;
double sum_model = 0.0;
double init_npred = *npred;
#endif
// Initialise log-likelihood value
double value = 0.0;
// Get number of model parameters in model container
int npars = models.npars();
// Create model gradient vectors for sky and background parameters
GVector sky_grad(npars);
GVector bgd_grad(npars);
// Allocate working array
GVector colvar(npars);
// Get reference to alpha parameters
const std::vector<double>& alpha = m_arf["ALPHA"];
// Check that there is at least one parameter
if (npars > 0) {
// Loop over all energy bins
for (int i = 0; i < m_on_spec.size(); ++i) {
// Reinitialize working arrays
for (int j = 0; j < npars; ++j) {
sky_grad[j] = 0.0;
bgd_grad[j] = 0.0;
}
// Get number of On and Off counts
double non = m_on_spec[i];
double noff = m_off_spec[i];
// Get number of gamma and background events (and corresponding
// spectral model gradients)
double ngam = N_gamma(models, i, &sky_grad);
double nbgd = N_bgd(models, i, &bgd_grad);
// Skip bin if model is too small (avoids -Inf or NaN gradients)
double nonpred = ngam + alpha[i] * nbgd;
if ((nbgd <= minmod) || (nonpred <= minmod)) {
#if defined(G_LIKELIHOOD_DEBUG)
n_small_model++;
#endif
continue;
}
// Now we have all predicted gamma and background events for
// current energy bin. Update the log(likelihood) and predicted
// number of events
value += -non * log(nonpred) + nonpred - noff * log(nbgd) + nbgd;
*npred += nonpred;
// Update statistics
#if defined(G_LIKELIHOOD_DEBUG)
n_used++;
sum_data += non;
sum_model += nonpred;
#endif
// Fill derivatives
double fa = non/nonpred;
double fb = fa/nonpred;
double fc = alpha[i] * fb;
double fd = fc * alpha[i] + noff/(nbgd*nbgd);
double sky_factor = 1.0 - fa;
double bgd_factor = 1.0 + alpha[i] - alpha[i] * fa - noff/nbgd;
// Loop over all parameters
for (int j = 0; j < npars; ++j) {
// If spectral model for sky component is non-zero and
// non-infinite then handle sky component gradients and
// second derivatives including at least a sky component ...
if (sky_grad[j] != 0.0 && !gammalib::is_infinite(sky_grad[j])) {
// Gradient
(*gradient)[j] += sky_factor * sky_grad[j];
// Hessian (from first-order derivatives only)
for (int k = 0; k < npars; ++k) {
// If spectral model for sky component is non-zero and
// non-infinite then we have the curvature element
// of a sky component
if (sky_grad[k] != 0.0 &&
!gammalib::is_infinite(sky_grad[k])) {
colvar[k] = sky_grad[j] * sky_grad[k] * fb;
}
// ... else if spectral model for background component
// is non-zero and non-infinite then we have the mixed
// curvature element between a sky and a background
// component
else if (bgd_grad[k] != 0.0 &&
!gammalib::is_infinite(bgd_grad[k])) {
colvar[k] = sky_grad[j] * bgd_grad[k] * fc;
}
// ...else neither sky nor background
else {
colvar[k] = 0.0;
}
} // endfor: Hessian computation
// Update matrix
curvature->add_to_column(j, colvar);
} // endif: spectral model is non-zero and non-infinite
// ... otherwise if spectral model for background component is
// non-zero and non-infinite then handle background component
// gradients and second derivatives including at least a
// background component
else if (bgd_grad[j] != 0.0 &&
!gammalib::is_infinite(bgd_grad[j])) {
// Gradient
(*gradient)[j] += bgd_factor * bgd_grad[j];
// Hessian (from first-order derivatives only)
for (int k = 0; k < npars; ++k) {
// If spectral model for sky component is non-zero and
// non-infinite then we have the mixed curvature element
// between a sky and a background component
if (sky_grad[k] != 0.0 &&
!gammalib::is_infinite(sky_grad[k])) {
colvar[k] = bgd_grad[j] * sky_grad[k] * fc;
}
// ... else if spectral model for background component
// is non-zero and non-infinite then we have the
// curvature element of a background component
else if (bgd_grad[k] != 0.0 &&
!gammalib::is_infinite(bgd_grad[k])) {
colvar[k] = bgd_grad[j] * bgd_grad[k] * fd;
}
// ... else neither sky nor background
else {
colvar[k] = 0.0;
}
} // endfor: Hessian computation
// Update matrix
curvature->add_to_column(j, colvar);
} // endif: spectral model for background component valid
} // endfor: looped over all parameters for derivatives computation
} // endfor: looped over energy bins
} // endif: number of parameters was positive
// ... else there are no parameters, so throw an exception
else {
std::string msg ="No model parameter for the computation of the "
"likelihood in observation \""+this->name()+
"\" (ID "+this->id()+").\n";
throw GException::invalid_value(G_LIKELIHOOD, msg);
}
// Dump statistics
#if defined(G_LIKELIHOOD_DEBUG)
std::cout << "Number of parameters: " << npars << std::endl;
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 due to small model: ";
std::cout << n_small_model << std::endl;
std::cout << "Number of bins with zero data: " << n_zero_data << std::endl;
std::cout << "Sum of data (On): " << sum_data << std::endl;
std::cout << "Sum of model (On): " << sum_model << std::endl;
std::cout << "Statistics: " << value << std::endl;
#endif
// Optionally dump gradient and curvature matrix
#if defined(G_LIKELIHOOD_DEBUG)
std::cout << *gradient << std::endl;
std::cout << *curvature << std::endl;
#endif
// Timing measurement
#if defined(G_LIKELIHOOD_DEBUG)
#ifdef _OPENMP
double t_elapse = omp_get_wtime()-t_start;
#else
double t_elapse = (double)(clock() - t_start) / (double)CLOCKS_PER_SEC;
#endif
std::cout << "GCTAOnOffObservation::optimizer::likelihood: CPU usage = "
<< t_elapse << " sec" << std::endl;
#endif
// Return
return value;
}
/***********************************************************************//**
* @brief Print On/Off observation information
*
* @return String containing On/Off observation information.
***************************************************************************/
std::string GCTAOnOffObservation::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("=== GCTAOnOffObservation ===");
// Append parameters
result.append("\n"+gammalib::parformat("Name")+m_name);
result.append("\n"+gammalib::parformat("Identifier")+m_id);
// Append spectra, ARF and RMF
result.append("\n"+m_on_spec.print(gammalib::reduce(chatter)));
result.append("\n"+m_off_spec.print(gammalib::reduce(chatter)));
result.append("\n"+m_arf.print(gammalib::reduce(chatter)));
result.append("\n"+m_rmf.print(gammalib::reduce(chatter)));
// Append regions
result.append("\n"+m_on_regions.print(gammalib::reduce(chatter)));
result.append("\n"+m_off_regions.print(gammalib::reduce(chatter)));
}
// Return result
return result;
}
/*==========================================================================
= =
= Private methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Initialise class members
***************************************************************************/
void GCTAOnOffObservation::init_members(void)
{
// Initialise members
m_instrument = "CTAOnOff";
m_response = NULL;
m_ontime = 0.0;
m_livetime = 0.0;
m_deadc = 1.0;
m_on_spec.clear();
m_off_spec.clear();
m_arf.clear();
m_rmf.clear();
m_on_regions.clear();
m_off_regions.clear();
// Return
return;
}
/***********************************************************************//**
* @brief Copy class members
*
* @param[in] obs CTA On/Off observation.
***************************************************************************/
void GCTAOnOffObservation::copy_members(const GCTAOnOffObservation& obs)
{
// Copy attributes
m_instrument = obs.m_instrument;
m_ontime = obs.m_ontime;
m_livetime = obs.m_livetime;
m_deadc = obs.m_deadc;
m_on_spec = obs.m_on_spec;
m_off_spec = obs.m_off_spec;
m_arf = obs.m_arf;
m_rmf = obs.m_rmf;
m_on_regions = obs.m_on_regions;
m_off_regions = obs.m_off_regions;
// Clone members
m_response = (obs.m_response != NULL) ? obs.m_response->clone() : NULL;
// Return
return;
}
/***********************************************************************//**
* @brief Delete class members
***************************************************************************/
void GCTAOnOffObservation::free_members(void)
{
// Return
return;
}
/***********************************************************************//**
* @brief Set On/Off observation from a CTA observation
*
* @param[in] obs CTA observation.
*
* @exception GException::invalid_value
* No CTA event list found in CTA observation.
*
* Sets an On/Off observation from a CTA observation by filling the events
* that fall in the On and Off regions into the PHA spectra and by computing
* the corresponding ARF and RMF response functions.
***************************************************************************/
void GCTAOnOffObservation::set(const GCTAObservation& obs)
{
// Get CTA event list pointer
const GCTAEventList* events = dynamic_cast<const GCTAEventList*>(obs.events());
if (events == NULL) {
std::string msg = "No event list found in CTA observation \""+
obs.name()+"\" (ID="+obs.id()+"). ON/OFF observation "
"can only be filled from event list.";
throw GException::invalid_value(G_SET, msg);
}
// Loop over all events
for (int i = 0; i < events->size(); ++i) {
// Get measured event direction
const GCTAEventAtom* atom = (*events)[i];
GSkyDir dir = atom->dir().dir();
// Fill in spectrum according to region containment
if (m_on_regions.contains(dir)) {
m_on_spec.fill(atom->energy());
}
if (m_off_regions.contains(dir)) {
m_off_spec.fill(atom->energy());
}
} // endfor: looped over all events
// Store the livetime as exposures of the spectra
m_on_spec.exposure(obs.livetime());
m_off_spec.exposure(obs.livetime());
// Store the ontime, livetime and deadtime correction in the observation
m_ontime = obs.ontime();
m_livetime = obs.livetime();
m_deadc = obs.deadc();
// Compute response components
compute_arf(obs);
compute_bgd(obs);
compute_alpha(obs);
compute_rmf(obs);
// Return
return;
}
/***********************************************************************//**
* @brief Compute ARF of On/Off observation
*
* @param[in] obs CTA observation.
*
* @exception GException::invalid_value
* No CTA response found in CTA observation.
*
* @todo Implement GCTAResponse::npred usage instead of computing Aeff
* (required the integration of PSF over On region).
* @todo Allow general region, not only circles.
***************************************************************************/
void GCTAOnOffObservation::compute_arf(const GCTAObservation& obs)
{
// Get reconstructed energy boundaries from on ARF
GEbounds ereco = m_arf.ebounds();
int nreco = ereco.size();
// Continue only if there are ARF bins
if (nreco > 0) {
// Get CTA response pointer. Throw an exception if no response is found
const GCTAResponseIrf* response =
dynamic_cast<const GCTAResponseIrf*>(obs.response());
if (response == NULL) {
std::string msg = "Response in CTA observation \""+obs.name()+"\" "
"(ID="+obs.id()+") is not of the GCTAResponseIrf "
"type.";
throw GException::invalid_value(G_COMPUTE_ARF, msg);
}
// Get CTA observation pointing direction, zenith, and azimuth
GCTAPointing obspnt = obs.pointing();
GSkyDir obsdir = obspnt.dir();
double zenith = obspnt.zenith();
double azimuth = obspnt.azimuth();
// Loop over reconstructed energies
for (int i = 0; i < nreco; ++i) {
// Get mean energy of bin
double logEreco = ereco.elogmean(i).log10TeV();
// Initialize effective area for this bin
m_arf[i] = 0.0;
// Loop over On sky regions
for (int m = 0; m < m_on_regions.size(); ++m) {
// If region is of type GSkyRegionCircle
const GSkyRegionCircle* skyreg =
dynamic_cast<const GSkyRegionCircle*>(m_on_regions[m]);
if (skyreg != NULL) {
// Get centre of circular region
GSkyDir centre(skyreg->centre());
// Compute position of region centre in instrument coordinates
double theta = obsdir.dist(centre);
double phi = obsdir.posang(centre);
// Add up effective area
m_arf[i] += response->aeff(theta,
phi,
zenith,
azimuth,
logEreco);
} // endif: sky region is of type GSkyRegionCircle
} // endfor: looped over On regions
} // endfor: looped over reconstructed energies
} // endif: there were energy bins
// Return
return;
}
/***********************************************************************//**
* @brief Compute background rate in Off region
*
* @param[in] obs CTA observation.
*
* @exception GException::invalid_argument
* Observation does not contain relevant response or background
* information
*
* Compute the background rate in units of events/s/MeV in all Off regions
* and stores the background rate as additional column with name
* `BACKGROUND` in the Auxiliary Response File (ARF).
*
* @todo Should implement integration of background model over region.
* @todo Allow general region, not only circles.
***************************************************************************/
void GCTAOnOffObservation::compute_bgd(const GCTAObservation& obs)
{
// Get reconstructed energy boundaries from on ARF
GEbounds ereco = m_arf.ebounds();
int nreco = ereco.size();
// Continue only if there are ARF bins
if (nreco > 0) {
// Initialise background rates to zero
std::vector<double> background(nreco, 0.0);
// Get CTA observation pointing direction
GCTAPointing obspnt = obs.pointing();
// Get pointer on CTA IRF response
const GCTAResponseIrf* rsp =
dynamic_cast<const GCTAResponseIrf*>(obs.response());
if (rsp == NULL) {
std::string msg = "Specified observation does not contain an "
"IRF response.\n" + obs.print();
throw GException::invalid_argument(G_COMPUTE_BGD, msg);
}
// Get pointer to CTA background
const GCTABackground* bgd = rsp->background();
if (bgd == NULL) {
std::string msg = "Specified observation contains no "
"background information.\n" + obs.print();
throw GException::invalid_argument(G_COMPUTE_BGD, msg);
}
// Loop over Off regions
for (int m = 0; m < m_off_regions.size(); ++m) {
// Get region centre direction, fall through if region is not
// of type GSkyRegionCircle
const GSkyRegionCircle* skyreg =
dynamic_cast<const GSkyRegionCircle*>(m_off_regions[m]);
if (skyreg == NULL) {
continue;
}
// Get centre of circular region
GSkyDir centre = skyreg->centre();
// Get instrument direction of region centre
GCTAInstDir offdir = obspnt.instdir(centre);
// Loop over energy bins
for (int i = 0; i < nreco; ++i) {
// Get log10(E/TeV) of mean reconstructed bin energy
double logEreco = m_on_spec.ebounds().elogmean(i).log10TeV();
// Get background rate in events/s/MeV
background[i] += (*bgd)(logEreco,
offdir.detx(),
offdir.dety()) * skyreg->solidangle();
} // endfor: looped over energy bins
} // endfor: looped over sky regions
// Append background vector to ARF
m_arf.append("BACKGROUND", background);
} // endif: there were spectral bins
// Return
return;
}
/***********************************************************************//**
* @brief Compute vector of alpha parameters
*
* @param[in] obs CTA observation.
*
* @exception GException::invalid_value
* No CTA response found in CTA observation.
*
* Compute the alpha parameters for all energy bins. The alpha parameter
* gives the ratio between the On and Off region background acceptance
* multiplied by the ratio between On and Off region solid angles.
*
* @todo Implement for general sky regions, not only circles
* @todo Integrate over the sky region instead of taking the values at the
* sky region centre
***************************************************************************/
void GCTAOnOffObservation::compute_alpha(const GCTAObservation& obs)
{
// Get reconstructed energy boundaries from on ARF
GEbounds ereco = m_arf.ebounds();
int nreco = ereco.size();
// Continue only if there are ARF bins
if (nreco > 0) {
// Initialise On/Off exposure ratios
std::vector<double> alpha(nreco, 0.0);
// Get CTA response pointer. Throw an exception if no response is found
const GCTAResponseIrf* response =
dynamic_cast<const GCTAResponseIrf*>(obs.response());
if (response == NULL) {
std::string msg = "Response in CTA observation \""+obs.name()+"\" "
"(ID="+obs.id()+") is not of the GCTAResponseIrf "
"type.";
throw GException::invalid_value(G_COMPUTE_ALPHA, msg);
}
// Get CTA observation pointing direction, zenith, and azimuth
GCTAPointing obspnt = obs.pointing();
GSkyDir obsdir = obspnt.dir();
// Loop over reconstructed energies
for (int i = 0; i < nreco; ++i) {
// Get mean log10 energy in TeV of bin
double logEreco = ereco.elogmean(i).log10TeV();
// Initialise effective area totals
double aon(0.0);
double aoff(0.0);
// Loop over ON sky regions
for (int m = 0; m < m_on_regions.size(); ++m) {
// If region is of type GSkyRegionCircle
const GSkyRegionCircle* skyreg =
dynamic_cast<const GSkyRegionCircle*>(m_on_regions[m]);
if (skyreg != NULL) {
// Get centre of circular region
GSkyDir centreg = skyreg->centre();
// Compute instrument direction from region centre
GCTAInstDir instdir(obspnt.instdir(centreg));
// Add up acceptance
aon += (*response->background())(logEreco,
instdir.detx(),
instdir.dety()) *
skyreg->solidangle();
} // endif: sky region is of type GSkyRegionCircle
} // Looped over ON regions
// Loop over OFF sky regions
for (int m = 0; m < m_off_regions.size(); ++m) {
// If region is of type GSkyRegionCircle
const GSkyRegionCircle* skyreg =
dynamic_cast<const GSkyRegionCircle*>(m_off_regions[m]);
if (skyreg != NULL) {
// Get centre of circular region
GSkyDir centreg = skyreg->centre();
// Compute instrument direction from region centre
GCTAInstDir instdir(obspnt.instdir(centreg));
// Add up acceptance
aoff += (*response->background())(logEreco,
instdir.detx(),
instdir.dety()) *
skyreg->solidangle();
} // endif: sky region is of type GSkyRegionCircle
} // endfor: looped over OFF regions
// Compute alpha for this energy bin
if (aoff > 0.0) {
alpha[i] = aon/aoff;
}
} // endfor: looped over reconstructed energies
// Append alpha vector to ARF
m_arf.append("ALPHA", alpha);
} // endif: there were energy bins
// Return
return;
}
/***********************************************************************//**
* @brief Compute RMF of On/Off observation
*
* @param[in] obs CTA observation.
*
* @exception GException::invalid_value
* Observation does not contain IRF response
*
* Compute the energy redistribution matrix for an On/Off observation. The
* method requires that the RMF energy axes have been defined before.
*
* @todo Check if we really should use reconstructed energy in the Aeff
* access.
* @todo Generalise to any kind of sky region
***************************************************************************/
void GCTAOnOffObservation::compute_rmf(const GCTAObservation& obs)
{
// Get true and reconstructed energy boundaries from RMF
GEbounds etrue = m_rmf.etrue();
GEbounds ereco = m_rmf.emeasured();
int ntrue = etrue.size();
int nreco = ereco.size();
// Continue only if there are RMF bins
if (ntrue > 0 && nreco > 0) {
// Get CTA response pointer
const GCTAResponseIrf* response =
dynamic_cast<const GCTAResponseIrf*>(obs.response());
if (response == NULL) {
std::string msg = "Response in CTA observation \""+obs.name()+"\" "
"(ID="+obs.id()+") is not of the GCTAResponseIrf "
"type.";
throw GException::invalid_value(G_COMPUTE_RMF, msg);
}
// Get CTA observation pointing direction, zenith, and azimuth
GCTAPointing obspnt = obs.pointing();
GSkyDir obsdir = obspnt.dir();
double zenith = obspnt.zenith();
double azimuth = obspnt.azimuth();
// Loop over reconstructed energy
for (int ireco = 0; ireco < nreco; ++ireco) {
// Get log10(E)
double logEreco = ereco.elogmean(ireco).log10TeV();
// Loop over true energy
for (int itrue = 0; itrue < ntrue; ++itrue) {
// Initialise RMF element
m_rmf(itrue, ireco) = 0.0;
// Compute true energy and initialise weight for this bin
double logEtrue = etrue.elogmean(itrue).log10TeV();
double weight = 0.0;
// Loop over ON sky regions
for (int m = 0; m < m_on_regions.size(); ++m) {
// Fall through if region is not of type GSkyRegionCircle
const GSkyRegionCircle* skyreg =
dynamic_cast<const GSkyRegionCircle*>(m_on_regions[m]);
if (skyreg == NULL) {
continue;
}
// Get centre of circular region
GSkyDir centreg(skyreg->centre());
// Compute position of region centre in instrument coordinates
double theta = obsdir.dist(centreg);
double phi = obsdir.posang(centreg);
// Get effective area
double aeff = response->aeff(theta,
phi,
zenith,
azimuth,
logEreco);
// Add up energy dispersion weighted by effective area
weight += aeff;
m_rmf(itrue, ireco) += response->edisp(ereco.elogmean(ireco),
theta,
phi,
zenith,
azimuth,
logEtrue) * aeff;
} // endfor: looped over ON regions
// Complete weighing by dividing by total effective area
if (weight > 0.0) {
m_rmf(itrue, ireco) /= weight;
}
} // endfor: looped over true energy
} // endfor: looped over reconstructed energy
} // endif: there were energy bins
// Return
return;
}
/***********************************************************************
* @brief Compute \f$N_{\gamma}\f$ value and model parameter gradients
*
* @param[in] models Model container.
* @param[in] ibin Energy bin number.
* @param[in,out] grad Model gradient vector.
*
* Returns the predicted number of source events \f$N_{\gamma}\f$
* in the On regions for a given energy bin. The method computes also
*
* \f[
* \left( \frac{\partial N_{\gamma}}{\partial p_{\rm sky}} \right)
* \f]
*
* which are the gradients in the predicted number of source events with
* respect to all model parameters.
*
* The method assumes that parameters are stored in the order
* spatial-spectral-temporal.
*
* @todo I think this method only works for point sources. What happens
* for an extended source?
***********************************************************************/
double GCTAOnOffObservation::N_gamma(const GModels& models,
const int& ibin,
GVector* grad) const
{
// Get total number of model parameters
int npars = models.npars();
// Initialize results
double value = 0.0;
for (int i = 0; i < npars; ++i) {
(*grad)[i] = 0.0;
}
// Continue only if bin number is in range and there are model parameters
if ((ibin >= 0) && (ibin < m_on_spec.size()) && (npars > 0)) {
// Initialise parameter index
int ipar = 0;
// Get energy bin bounds
const GEnergy emin = m_on_spec.ebounds().emin(ibin);
const GEnergy emax = m_on_spec.ebounds().emax(ibin);
const GEnergy emean = m_on_spec.ebounds().elogmean(ibin);
const double ewidth = m_on_spec.ebounds().ewidth(ibin).MeV();
// Compute normalisation factors
double exposure = m_on_spec.exposure();
double norm_flux = m_arf[ibin] * exposure; // cm2 s
double norm_grad = norm_flux * ewidth; // cm2 s MeV
// Loop over models
for (int j = 0; j < models.size(); ++j) {
// Get model pointer. Fall through if pointer is not valid
const GModel* mptr = models[j];
if (mptr == NULL) {
continue;
}
// Fall through if model does not apply to specific instrument
// and observation identifier
if (!mptr->is_valid(instrument(), id())) {
ipar += mptr->size();
continue;
}
// Fall through if this model component is a not sky component
const GModelSky* sky = dynamic_cast<const GModelSky*>(mptr);
if (sky == NULL) {
ipar += mptr->size();
continue;
}
// Increase parameter counter for spatial parameter
GModelSpatial* spatial = sky->spatial();
if (spatial != NULL) {
ipar += spatial->size();
}
// Spectral component (the useful one)
GModelSpectral* spectral = sky->spectral();
if (spectral != NULL) {
// Determine the number of gamma-ray events in model by
// computing the flux over the energy bin in ph/cm2/s
// and multiplying this flux by the effective area (cm2)
// and the livetime (s)
value += spectral->flux(emin, emax) * norm_flux;
// Determine the model gradients at the current energy. The
// eval() method needs a time in case that the spectral model
// has a time dependence. We simply use a dummy time here.
spectral->eval(emean, GTime(), true);
// Loop over spectral model parameters
for (int k = 0; k < spectral->size(); ++k, ++ipar) {
GModelPar& par = (*spectral)[k];
if (par.is_free() && ipar < npars) {
(*grad)[ipar] = par.factor_gradient() * norm_grad;
}
}
} // endif: spectral component
// Increase parameter counter for temporal parameter
GModelTemporal* temporal = sky->temporal();
if (temporal != NULL) {
ipar += temporal->size();
}
} // endfor: looped over model components
} // endif: bin number is in the range and model container is not empty
// Return number of gamma-ray events
return value;
}
/***********************************************************************
* @brief Compute \f$N_{\rm bgd}\f$ value and model parameter gradients
*
* @param[in] models Model container.
* @param[in] ibin Energy bin index.
* @param[in,out] grad Model gradient vector.
* @return Predicted number of background events in Off regions.
*
* Returns the predicted number of background events \f$N_{\rm bgd}\f$
* in the Off regions for a given energy bin. The method computes also
*
* \f[
* \left( \frac{\partial N_{\rm bgd}}{\partial p_{\rm bgd}} \right)
* \f]
*
* which are the gradients in the predicted number of background events
* with respect to all model parameters.
*
* The method assumes that the model parameters are stored in the order
* spectral-temporal.
*
* @todo So far only handles the GCTAModelIrfBackground background model;
* Should be more generic, but there is maybe for the moment no
* other choice than implementing something for all possible
* background models; that's not very satisfactory ...
***********************************************************************/
double GCTAOnOffObservation::N_bgd(const GModels& models,
const int& ibin,
GVector* grad) const
{
// Get total number of model parameters
int npars = models.npars();
// Initialize results
double value = 0.0;
for (int i = 0; i < npars; ++i) {
(*grad)[i] = 0.0;
}
// Continue only if bin number is valid and if there are model parameters
if ((ibin >= 0) && (ibin < m_off_spec.size()) && (npars > 0)) {
// Initialise parameter index
int ipar = 0;
// Get reference to background rates (events/MeV/s)
const std::vector<double>& background = m_arf["BACKGROUND"];
// Get energy bin mean and width
const GEnergy emean = m_off_spec.ebounds().elogmean(ibin);
const double ewidth = m_off_spec.ebounds().ewidth(ibin).MeV();
// Compute normalisation factor (events)
double exposure = m_off_spec.exposure();
double norm = background[ibin] * exposure * ewidth;
// Loop over models
for (int j = 0; j < models.size(); ++j) {
// Get model pointer. Fall through if pointer is not valid
const GModel* mptr = models[j];
if (mptr == NULL) {
continue;
}
// Fall through if model does not apply to specific instrument
// and observation identifier.
if (!mptr->is_valid(this->instrument(), this->id())) {
ipar += mptr->size();
continue;
}
// Fall through if model is not an IRF background component
const GCTAModelIrfBackground* bgd =
dynamic_cast<const GCTAModelIrfBackground*>(mptr);
if (bgd == NULL) {
ipar += mptr->size();
continue;
}
// Get spectral component
GModelSpectral* spectral = bgd->spectral();
if (spectral != NULL) {
// Determine the number of background events in model by
// computing the model normalization at the mean bin energy bin
// and multiplying the normalisation with the number of
// background events. The eval() method needs a time in case
// that the spectral model has a time dependence. We simply
// use a dummy time here.
value += spectral->eval(emean, GTime(), true) * norm;
// Compute the parameter gradients for all spectral model
// parameters
for (int k = 0; k < spectral->size(); ++k, ++ipar) {
GModelPar& par = (*spectral)[k];
if (par.is_free() && ipar < npars) {
(*grad)[ipar] += par.factor_gradient() * norm;
}
}
} // endif: pointer to spectral component was not NULL
// Increase parameter counter for temporal parameter
GModelTemporal* temporal = bgd->temporal();
if (temporal != NULL) {
ipar += temporal->size();
}
} // endfor: looped over model components
} // endif: bin number is in the range and model container is not empty
// Return
return value;
}