GResponse.cpp
74.1 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
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
/***************************************************************************
* GResponse.cpp - Abstract response base class *
* ----------------------------------------------------------------------- *
* copyright (C) 2008-2020 by Juergen Knoedlseder *
* ----------------------------------------------------------------------- *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
* *
***************************************************************************/
/**
* @file GResponse.hpp
* @brief Abstract response base class interface definition
* @author Juergen Knoedlseder
*/
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <string>
#include <unistd.h> // access() function
#include "GException.hpp"
#include "GTools.hpp"
#include "GMath.hpp"
#include "GVector.hpp"
#include "GMatrix.hpp"
#include "GMatrixSparse.hpp"
#include "GIntegral.hpp"
#include "GIntegrals.hpp"
#include "GResponse.hpp"
#include "GEvent.hpp"
#include "GPhoton.hpp"
#include "GEnergy.hpp"
#include "GTime.hpp"
#include "GSource.hpp"
#include "GEbounds.hpp"
#include "GObservation.hpp"
#include "GSkyMap.hpp"
#include "GModelSky.hpp"
#include "GModelSpatialPointSource.hpp"
#include "GModelSpatialRadial.hpp"
#include "GModelSpatialElliptical.hpp"
#include "GModelSpatialDiffuse.hpp"
#include "GModelSpatialDiffuseMap.hpp"
#include "GModelSpatialDiffuseCube.hpp"
#include "GModelSpatialComposite.hpp"
/* __ Method name definitions ____________________________________________ */
#define G_CONVOLVE "GResponse::convolve(GModelSky&, GObservation&, "\
"GMatrixSparse*)"
#define G_IRF_RADIAL "GResponse::irf_radial(GEvent&, GSource&,"\
" GObservation&)"
#define G_IRF_ELLIPTICAL "GResponse::irf_elliptical(GEvent&, GSource&,"\
" GObservation&)"
#define G_IRF_DIFFUSE "GResponse::irf_diffuse(GEvent&, GSource&,"\
" GObservation&)"
/* __ Macros _____________________________________________________________ */
/* __ Coding definitions _________________________________________________ */
/* __ Debug definitions __________________________________________________ */
/*==========================================================================
= =
= Constructors/destructors =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Void constructor
***************************************************************************/
GResponse::GResponse(void)
{
// Initialise class members for clean destruction
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Copy constructor
*
* @param[in] rsp Response.
***************************************************************************/
GResponse::GResponse(const GResponse& rsp)
{
// Initialise class members for clean destruction
init_members();
// Copy members
copy_members(rsp);
// Return
return;
}
/***********************************************************************//**
* @brief Destructor
***************************************************************************/
GResponse::~GResponse(void)
{
// Free members
free_members();
// Return
return;
}
/*==========================================================================
= =
= Operators =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Assignment operator
*
* @param[in] rsp Response.
* @return Response.
***************************************************************************/
GResponse& GResponse::operator=(const GResponse& rsp)
{
// Execute only if object is not identical
if (this != &rsp) {
// Free members
free_members();
// Initialise private members for clean destruction
init_members();
// Copy members
copy_members(rsp);
} // endif: object was not identical
// Return this object
return *this;
}
/*==========================================================================
= =
= Public methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Convolve sky model with the instrument response
*
* @param[in] model Sky model.
* @param[in] event Event.
* @param[in] obs Observation.
* @param[in] grad Should model gradients be computed?
* @return Event probability.
*
* Computes 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]
*
* without taking into account any time dispersion. Energy dispersion is
* correctly handled by this method. If time dispersion is indeed needed,
* an instrument specific method needs to be provided.
***************************************************************************/
double GResponse::convolve(const GModelSky& model,
const GEvent& event,
const GObservation& obs,
const bool& grad) const
{
// Set number of iterations for Romberg integration.
static const int iter = 6;
// Initialise result
double prob = 0.0;
// Continue only if the model has a spatial component
if (model.spatial() != NULL) {
// Get source time (no dispersion)
GTime srcTime = event.time();
// Case A: Integration
if (use_edisp()) {
// Retrieve true energy boundaries
GEbounds ebounds = this->ebounds(event.energy());
// Determine size of result array
int size = size_edisp_vector(model, obs, grad);
// Initialise vector array
GVector array(size);
// Loop over all boundaries
for (int i = 0; i < ebounds.size(); ++i) {
// Get true energy boundaries in MeV
double etrue_min = ebounds.emin(i).MeV();
double etrue_max = ebounds.emax(i).MeV();
// Continue only if valid
if (etrue_max > etrue_min) {
// Setup integration function
edisp_kerns integrand(this, &obs, &model, &event, srcTime, grad);
GIntegrals integral(&integrand);
// Set number of iterations
integral.fixed_iter(iter);
// Do Romberg integration
array += integral.romberg(etrue_min, etrue_max);
} // endif: interval was valid
} // endfor: looped over intervals
// Initialise array index
int index = 0;
// Get probability
prob = array[index++];
// Set gradients
if (grad) {
// Set spectral gradients
if (model.spectral() != NULL) {
for (int i = 0; i < model.spectral()->size(); ++i) {
GModelPar& par = (*(model.spectral()))[i];
if (par.is_free() && par.has_grad()) {
par.factor_gradient(array[index++]);
}
}
}
// Set temporal gradients
if (model.temporal() != NULL) {
for (int i = 0; i < model.temporal()->size(); ++i) {
GModelPar& par = (*(model.temporal()))[i];
if (par.is_free() && par.has_grad()) {
par.factor_gradient(array[index++]);
}
}
}
// Optionally set scale gradient for instrument
if (model.has_scales()) {
for (int i = 0; i < model.scales(); ++i) {
const GModelPar& par = model.scale(i);
if (par.name() == obs.instrument()) {
if (par.is_free() && par.has_grad()) {
par.factor_gradient(array[index++]);
}
}
}
}
} // endif: set gradients
} // endif: Case A
// Case B: No integration (assume no energy dispersion)
else {
// Get source energy (no dispersion)
GEnergy srcEng = event.energy();
// Evaluate probability
prob = eval_prob(model, event, srcEng, srcTime, obs, grad);
} // endelse: Case B
// Compile option: Check for NaN/Inf
#if defined(G_NAN_CHECK)
if (gammalib::is_notanumber(prob) || gammalib::is_infinite(prob)) {
std::cout << "*** ERROR: GResponse::convolve:";
std::cout << " NaN/Inf encountered";
std::cout << " (prob=" << prob;
std::cout << ", event=" << event;
std::cout << ", srcTime=" << srcTime;
std::cout << ")" << std::endl;
}
#endif
} // endif: spatial component valid
// Return probability
return prob;
}
/***********************************************************************//**
* @brief Convolve sky model with the instrument response
*
* @param[in] model Sky model.
* @param[in] obs Observation.
* @param[out] gradients Pointer to matrix of gradients.
* @return Vector of event probabilities.
*
* Computes 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]
*
* without taking into account any time dispersion. Energy dispersion is
* correctly handled by this method. If time dispersion is indeed needed,
* an instrument specific method needs to be provided.
***************************************************************************/
GVector GResponse::convolve(const GModelSky& model,
const GObservation& obs,
GMatrixSparse* gradients) const
{
// Set number of iterations for Romberg integration.
static const int iter = 6;
// Get number of model parameters and number of events
int npars = model.size();
int nevents = obs.events()->size();
// Initialise gradients flag
bool grad = (gradients != NULL);
// Check matrix consistency
if (grad) {
if (gradients->columns() != npars) {
std::string msg = "Number of "+gammalib::str(gradients->columns())+
" columns in gradient matrix differs from number "
"of "+gammalib::str(npars)+" parameters "
"in model. Please provide a compatible gradient "
"matrix.";
throw GException::invalid_argument(G_CONVOLVE, msg);
}
if (gradients->rows() != nevents) {
std::string msg = "Number of "+gammalib::str(gradients->rows())+
" rows in gradient matrix differs from number "
"of "+gammalib::str(nevents)+" events in "
"observation. Please provide a compatible "
"gradient matrix.";
throw GException::invalid_argument(G_CONVOLVE, msg);
}
}
// Initialise result
GVector probs(nevents);
// Continue only if the model has a spatial component
if (model.spatial() != NULL) {
// Case A: Integration
if (use_edisp()) {
// Initialise temporary vectors to hold gradients
GVector* tmp_gradients = NULL;
if (grad) {
tmp_gradients = new GVector[npars];
for (int i = 0; i < npars; ++i) {
tmp_gradients[i] = GVector(nevents);
}
}
// Determine size of result array
int size = size_edisp_vector(model, obs, grad);
// Loop over events
for (int k = 0; k < nevents; ++k) {
// Get reference to event
const GEvent& event = *((*obs.events())[k]);
// Get source time (no dispersion)
GTime srcTime = event.time();
// Retrieve true energy boundaries
GEbounds ebounds = this->ebounds(event.energy());
// Initialise vector array
GVector array(size);
// Loop over all boundaries
for (int i = 0; i < ebounds.size(); ++i) {
// Get true energy boundaries in MeV
double etrue_min = ebounds.emin(i).MeV();
double etrue_max = ebounds.emax(i).MeV();
// Continue only if valid
if (etrue_max > etrue_min) {
// Setup integration function
edisp_kerns integrand(this, &obs, &model, &event, srcTime, grad);
GIntegrals integral(&integrand);
// Set number of iterations
integral.fixed_iter(iter);
// Do Romberg integration
array += integral.romberg(etrue_min, etrue_max);
} // endif: interval was valid
} // endfor: looped over intervals
// Initialise array index
int index = 0;
// Get probability
probs[k] = array[index++];
// Set gradients
if (grad) {
// Get number of spatial, spectral and temporal parameters
int n_spat = model.spatial()->size();
int n_spec = model.spectral()->size();
int n_temp = model.temporal()->size();
// Set spectral gradients
if (model.spectral() != NULL) {
int offset = n_spat;
for (int i = 0; i < n_spec; ++i) {
const GModelPar& par = (*(model.spectral()))[i];
if (par.is_free() && par.has_grad()) {
tmp_gradients[offset+i][k] = array[index++];
}
}
}
// Set temporal gradients
if (model.temporal() != NULL) {
int offset = n_spat + n_spec;
for (int i = 0; i < n_temp; ++i) {
const GModelPar& par = (*(model.temporal()))[i];
if (par.is_free() && par.has_grad()) {
tmp_gradients[offset+i][k] = array[index++];
}
}
}
// Optionally set scale gradient for instrument
if (model.has_scales()) {
int offset = n_spat + n_spec + n_temp;
for (int i = 0; i < model.scales(); ++i) {
const GModelPar& par = model.scale(i);
if (par.name() == obs.instrument()) {
if (par.is_free() && par.has_grad()) {
tmp_gradients[offset+i][k] = array[index++];
}
}
}
}
} // endif: set gradients
// Compile option: Check for NaN/Inf
#if defined(G_NAN_CHECK)
if (gammalib::is_notanumber(probs[k]) || gammalib::is_infinite(probs[k])) {
std::cout << "*** ERROR: GResponse::convolve:";
std::cout << " NaN/Inf encountered";
std::cout << " (probs[" << k << "]=" << probs[k];
std::cout << ", event=" << event;
std::cout << ", srcTime=" << srcTime;
std::cout << ")" << std::endl;
}
#endif
} // endfor: looped over events
// Post-process gradients
if (grad) {
// Fill gradients into matrix
for (int i = 0; i < npars; ++i) {
gradients->column(i, tmp_gradients[i]);
}
// Delete temporal gradients
delete [] tmp_gradients;
} // endif: post-processed gradients
} // endif: Case A
// Case B: No integration (assume no energy dispersion)
else {
// Evaluate probability
probs = eval_probs(model, obs, gradients);
} // endelse: Case B
} // endif: spatial component valid
// Return probabilities
return probs;
}
/***********************************************************************//**
* @brief Return instrument response integrated over the spatial model
*
* @param[in] event Event.
* @param[in] source Source.
* @param[in] obs Observation.
* @return Instrument response to a spatial model.
*
* Returns the instrument response for a given event, source and observation
* integrated over the spatial model component. The method computes
*
* \f[
* {\tt irf}(p', E', t') = \int_p M_{\rm S}(p | E, t) \,
* R(p', E', t' | p, E, t) \, d\,p
* \f]
*
* where
* * \f$M_{\rm S}(p | E, t)\f$ is the spatial model component,
* * \f$R(p', E', t' | p, E, t)\f$ is the Instrument Response Function (IRF),
* * \f$p'\f$ is the measured instrument direction,
* * \f$E'\f$ is the measured or reconstructed energy,
* * \f$t'\f$ is the measured 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 trigger time.
*
* The integration is done over all relevant true sky directions \f$p\f$.
*
* Depending on the type of the source model the method branches to the
* following methods to perform the actual computations
*
* * irf_ptsrc() - for the handling of a point source
* * irf_radial() - for radial models
* * irf_elliptical() - for elliptical models
* * irf_diffuse() - for diffuse models
* * irf_composite() - for composite models
*
* The method implements a caching mechanism for spatial models that have all
* parameters fixed. For those models the instrument response for a given
* event and observation is only computed once and then stored in an internal
* cache from which it is fetched back in case that the method is called
* again for the same event and observation.
***************************************************************************/
double GResponse::irf_spatial(const GEvent& event,
const GSource& source,
const GObservation& obs) const
{
// Initialise IRF value
double irf = 0.0;
// Set IRF value attributes
std::string name = obs.id() + ":" + source.name();
const GInstDir& dir = event.dir();
const GEnergy& ereco = event.energy();
const GEnergy& etrue = source.energy();
// Signal if spatial model has free parameters
bool has_free_pars = source.model()->has_free_pars();
// If the spatial model component has free parameters, or the response
// cache should not be used, or the cache does not contain the requested
// IRF value then compute the IRF value for the spatial model.
if (has_free_pars ||
!m_use_irf_cache ||
!m_irf_cache.contains(name, dir, ereco, etrue, &irf)) {
// Compute IRF for spatial model
switch (source.model()->code()) {
case GMODEL_SPATIAL_POINT_SOURCE:
irf = irf_ptsrc(event, source, obs);
break;
case GMODEL_SPATIAL_RADIAL:
irf = irf_radial(event, source, obs);
break;
case GMODEL_SPATIAL_ELLIPTICAL:
irf = irf_elliptical(event, source, obs);
break;
case GMODEL_SPATIAL_DIFFUSE:
irf = irf_diffuse(event, source, obs);
break;
case GMODEL_SPATIAL_COMPOSITE:
irf = irf_composite(event, source, obs);
break;
default:
break;
}
} // endif: computed spatial model
// If the spatial model has no free parameters and the response cache
// should be used then put the IRF value in the response cache.
if (!has_free_pars && m_use_irf_cache) {
m_irf_cache.set(name, dir, ereco, etrue, irf);
}
// Return IRF value
return irf;
}
/***********************************************************************//**
* @brief Return instrument response vector integrated over the spatial model
*
* @param[in] model Sky model.
* @param[in] obs Observation.
* @param[in] gradients Gradients matrix.
* @return Instrument response vector to a spatial model.
*
* Returns the instrument response to a sky model integrated over the spatial
* model component for all events in a given observation. The method computes
*
* \f[
* {\tt irf}(p', E', t') = \int_p M_{\rm S}(p | E, t) \,
* R(p', E', t' | p, E, t) \, d\,p
* \f]
*
* where
* * \f$M_{\rm S}(p | E, t)\f$ is the spatial model component,
* * \f$R(p', E', t' | p, E, t)\f$ is the Instrument Response Function (IRF),
* * \f$p'\f$ is the measured instrument direction,
* * \f$E'\f$ is the measured or reconstructed energy,
* * \f$t'\f$ is the measured 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 trigger time.
*
* The integration is done over all relevant true sky directions \f$p\f$.
*
* Depending on the type of the source model the method branches to the
* following methods to perform the actual computations
*
* * irf_ptsrc() - for the handling of a point source
* * irf_radial() - for radial models
* * irf_elliptical() - for elliptical models
* * irf_diffuse() - for diffuse models
* * irf_composite() - for composite models
*
* The method implements a caching mechanism for spatial models that have all
* parameters fixed. For those models the instrument response for a given
* event and observation is only computed once and then stored in an internal
* cache from which it is fetched back in case that the method is called
* again for the same event and observation.
***************************************************************************/
GVector GResponse::irf_spatial(const GModelSky& model,
const GObservation& obs,
GMatrix* gradients) const
{
// Get number of model parameters and number of events
int npars = model.size();
int nevents = obs.events()->size();
// Initialise result
GVector irfs(nevents);
// Continue only if model has a spatial component
if (model.spatial() != NULL) {
// Set IRF cache identifier
std::string cache_id = obs.id() + ":" + model.name();
// Signal if spatial model has free parameters
bool has_free_pars = model.spatial()->has_free_pars();
// If the spatial model component has free parameters, or the response
// cache should not be used, or the cache does not contain the requested
// IRF value then compute the IRF value for the spatial model.
if (has_free_pars ||
!m_use_irf_cache ||
!m_irf_vector_cache.contains(cache_id, &irfs)) {
// Compute IRF for spatial model
switch (model.spatial()->code()) {
case GMODEL_SPATIAL_POINT_SOURCE:
irfs = irf_ptsrc(model, obs, gradients);
break;
case GMODEL_SPATIAL_RADIAL:
irfs = irf_radial(model, obs, gradients);
break;
case GMODEL_SPATIAL_ELLIPTICAL:
irfs = irf_elliptical(model, obs, gradients);
break;
case GMODEL_SPATIAL_DIFFUSE:
irfs = irf_diffuse(model, obs, gradients);
break;
case GMODEL_SPATIAL_COMPOSITE:
irfs = irf_composite(model, obs, gradients);
break;
default:
break;
}
// If the spatial model has no free parameters and the response cache
// should be used then put the IRF value in the response cache.
if (!has_free_pars && m_use_irf_cache) {
m_irf_vector_cache.set(cache_id, irfs);
}
} // endif: computed spatial model
} // endif: model had spatial component
// Return IRF values
return irfs;
}
/***********************************************************************//**
* @brief Remove response cache for model
*
* @param[in] name Model name.
*
* Remove response cache for model @p name from response cache.
***************************************************************************/
void GResponse::remove_response_cache(const std::string& name)
{
// Remove model from response caches
m_irf_cache.remove(name);
m_nroi_cache.remove(name);
// Return
return;
}
/*==========================================================================
= =
= Protected methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Initialise class members
***************************************************************************/
void GResponse::init_members(void)
{
// Initialize members
m_use_irf_cache = true; //!< Switched on by default
m_use_nroi_cache = true; //!< Switched on by default
m_irf_radial_iter_theta = 6;
m_irf_radial_iter_phi = 6;
m_irf_elliptical_iter_theta = 6;
m_irf_elliptical_iter_phi = 6;
m_irf_diffuse_resolution = 0.1; //!< Angular resolution (deg)
// Clear cache
m_irf_cache.clear();
m_nroi_cache.clear();
m_irf_vector_cache.clear();
// Return
return;
}
/***********************************************************************//**
* @brief Copy class members
*
* @param[in] rsp Response.
***************************************************************************/
void GResponse::copy_members(const GResponse& rsp)
{
// Copy members
m_use_irf_cache = rsp.m_use_irf_cache;
m_use_nroi_cache = rsp.m_use_nroi_cache;
m_irf_radial_iter_theta = rsp.m_irf_radial_iter_theta;
m_irf_radial_iter_phi = rsp.m_irf_radial_iter_phi;
m_irf_elliptical_iter_theta = rsp.m_irf_elliptical_iter_theta;
m_irf_elliptical_iter_phi = rsp.m_irf_elliptical_iter_phi;
m_irf_diffuse_resolution = rsp.m_irf_diffuse_resolution;
m_irf_cache = rsp.m_irf_cache;
m_nroi_cache = rsp.m_nroi_cache;
m_irf_vector_cache = rsp.m_irf_vector_cache;
// Return
return;
}
/***********************************************************************//**
* @brief Delete class members
***************************************************************************/
void GResponse::free_members(void)
{
// Return
return;
}
/***********************************************************************//**
* @brief Return instrument response to point source
*
* @param[in] event Observed event.
* @param[in] source Source.
* @param[in] obs Observation.
* @return Instrument response to point source.
*
* Returns the instrument response to a point source.
***************************************************************************/
double GResponse::irf_ptsrc(const GEvent& event,
const GSource& source,
const GObservation& obs) const
{
// Get pointer to point source model
const GModelSpatialPointSource* model =
static_cast<const GModelSpatialPointSource*>(source.model());
// Setup photon
GPhoton photon(model->dir(), source.energy(), source.time());
// Get IRF
double irf = this->irf(event, photon, obs);
// Return IRF value
return irf;
}
/***********************************************************************//**
* @brief Return instrument response to radial source
*
* @param[in] event Observed event.
* @param[in] source Source.
* @param[in] obs Observation.
* @return Instrument response to radial source.
*
* Returns the instrument response to a radial source for a given event,
* source and observation. The method computes
*
* \f[
* {\tt irf}(p', E', t') = \int_0^{\theta_{\rm max}}
* M_{\rm S}(\theta | E, t) \, sin \, \theta
* \int_0^{2\pi}
* R(p', E', t' | \theta, \phi, E, t) \,
* d\,\phi \, d\,\theta
* \f]
*
* where
* * \f$M_{\rm S}(\theta | E, t)\f$ is the radial model component,
* * \f$R(p', E', t' | \theta, \phi, E, t)\f$ is the Instrument Response
* Function (IRF),
* * \f$p'\f$ is the measured instrument direction,
* * \f$E'\f$ is the measured or reconstructed energy,
* * \f$t'\f$ is the measured arrival time,
* * \f$\theta\f$ is the radial distance from the model centre,
* * \f$\phi\f$ is the azimuthal angle around the model centre,
* * \f$E\f$ is the true photon energy, and
* * \f$t\f$ is the true trigger time.
*
* The azimuth integration is done over \f$2\pi\f$ using the
* irf_radial_kern_phi::eval() method.
* The radial integration is done out to a maximum angle
* \f$\theta_{\rm max}\f$, given by GModelSpatialRadial::theta_max(), by the
* irf_radial_kern_theta::eval() method.
***************************************************************************/
double GResponse::irf_radial(const GEvent& event,
const GSource& source,
const GObservation& obs) const
{
// Initialise IRF
double irf = 0.0;
// Get pointer to radial model
const GModelSpatialRadial* model =
static_cast<const GModelSpatialRadial*>(source.model());
// Get source attributes
const GEnergy& srcEng = source.energy();
const GTime& srcTime = source.time();
// Set radial integration range (radians)
double theta_min = 0.0;
double theta_max = model->theta_max() - 1.0e-12; // Kludge to stay inside
// the boundary of a
// sharp edged model
// Integrate if interval is valid
if (theta_max > theta_min) {
// Allocate Euler and rotation matrices
GMatrix ry;
GMatrix rz;
// Set up rotation matrix to rotate from native model coordinates to
// celestial coordinates
ry.eulery( model->dir().dec_deg() - 90.0);
rz.eulerz(-model->dir().ra_deg());
GMatrix rot = (ry * rz).transpose();
// Setup integration kernel
irf_radial_kern_theta integrand(this,
&event,
&obs,
model,
&rot,
&srcEng,
&srcTime,
m_irf_radial_iter_phi);
// Integrate over model's radial coordinate
GIntegral integral(&integrand);
integral.fixed_iter(m_irf_radial_iter_theta);
// Integrate kernel
irf = integral.romberg(theta_min, theta_max, m_irf_radial_iter_theta);
// Compile option: Check for NaN/Inf
#if defined(G_NAN_CHECK)
if (gammalib::is_notanumber(irf) || gammalib::is_infinite(irf)) {
std::cout << "*** ERROR: GResponse::irf_radial:";
std::cout << " NaN/Inf encountered";
std::cout << " (irf=" << irf;
std::cout << ", theta_min=" << theta_min;
std::cout << ", theta_max=" << theta_max << ")";
std::cout << std::endl;
}
#endif
} // endif: integration interval was valid
// Return IRF value
return irf;
}
/***********************************************************************//**
* @brief Return instrument response to elliptical source
*
* @param[in] event Observed event.
* @param[in] source Source.
* @param[in] obs Observation.
* @return Instrument response to elliptical source.
*
* Returns the instrument response to an elliptical source for a given event,
* source and observation. The method computes
*
* \f[
* {\tt irf}(p', E', t') = \int_0^{\theta_{\rm max}} \int_0^{2\pi}
* M_{\rm S}(\theta, \phi | E, t) \,
* R(p', E', t' | \theta, \phi, E, t) \,
* sin \, \theta \,
* d\,\phi \, d\,\theta
* \f]
*
* where
* * \f$M_{\rm S}(\theta, \phi | E, t)\f$ is the elliptical model component,
* * \f$R(p', E', t' | \theta, \phi, E, t)\f$ is the Instrument Response
* Function (IRF),
* * \f$p'\f$ is the measured instrument direction,
* * \f$E'\f$ is the measured or reconstructed energy,
* * \f$t'\f$ is the measured arrival time,
* * \f$\theta\f$ is the radial distance from the model centre,
* * \f$\phi\f$ is the azimuthal angle around the model centre,
* * \f$E\f$ is the true photon energy, and
* * \f$t\f$ is the true trigger time.
*
* The azimuth integration is done over \f$2\pi\f$ using the
* irf_elliptical_kern_phi::eval() method.
* The radial integration is done out to a maximum angle
* \f$\theta_{\rm max}\f$, given by GModelSpatialElliptical::theta_max(), by
* the irf_elliptical_kern_theta::eval() method.
***************************************************************************/
double GResponse::irf_elliptical(const GEvent& event,
const GSource& source,
const GObservation& obs) const
{
// Initialise IRF
double irf = 0.0;
// Get pointer to elliptical model
const GModelSpatialElliptical* model =
static_cast<const GModelSpatialElliptical*>(source.model());
// Get source attributes
const GEnergy& srcEng = source.energy();
const GTime& srcTime = source.time();
// Set radial integration range (radians)
double theta_min = 0.0;
double theta_max = model->theta_max() - 1.0e-6; // Kludge to stay inside
// the boundary of a
// sharp edged model
// Integrate if interval is valid
if (theta_max > theta_min) {
// Allocate Euler and rotation matrices
GMatrix ry;
GMatrix rz;
// Set up rotation matrix to rotate from native model coordinates to
// celestial coordinates
ry.eulery( model->dir().dec_deg() - 90.0);
rz.eulerz(-model->dir().ra_deg());
GMatrix rot = (ry * rz).transpose();
// Setup integration kernel
irf_elliptical_kern_theta integrand(this,
&event,
&obs,
model,
&rot,
&srcEng,
&srcTime,
m_irf_elliptical_iter_phi);
// Integrate over model's radial coordinate
GIntegral integral(&integrand);
integral.fixed_iter(m_irf_elliptical_iter_theta);
// Integrate kernel
irf = integral.romberg(theta_min, theta_max, m_irf_elliptical_iter_theta);
// Compile option: Check for NaN/Inf
#if defined(G_NAN_CHECK)
if (gammalib::is_notanumber(irf) || gammalib::is_infinite(irf)) {
std::cout << "*** ERROR: GResponse::irf_elliptical:";
std::cout << " NaN/Inf encountered";
std::cout << " (irf=" << irf;
std::cout << ", theta_min=" << theta_min;
std::cout << ", theta_max=" << theta_max << ")";
std::cout << std::endl;
}
#endif
} // endif: integration interval was valid
// Return IRF value
return irf;
}
/***********************************************************************//**
* @brief Return instrument response to diffuse source
*
* @param[in] event Observed event.
* @param[in] source Source.
* @param[in] obs Observation.
* @return Instrument response to diffuse source.
*
* Returns the instrument response to a diffuse source for a given event,
* source and observation. The method computes
*
* \f[
* {\tt irf}(p', E', t') = \sum_p M_{\rm S}(p | E, t) \, \Delta(p)
* R(p', E', t' | p, E, t)
* \f]
*
* where
* * \f$M_{\rm S}(p | E, t)\f$ is the diffuse model component,
* * \f$\Delta(p)\f$ is the solid angle of the map pixel
* * \f$R(p', E', t' | p, E, t)\f$ is the Instrument Response Function (IRF),
* * \f$p'\f$ is the measured instrument direction,
* * \f$E'\f$ is the measured or reconstructed energy,
* * \f$t'\f$ is the measured 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 trigger time.
*
* The method simply adds up all sky map pixels multiplied with the IRF for
* all diffuse model pixels. For models that do not contain sky map pixels
* (such as the GModelSpatialDiffuseConst model) the method allocates an
* all-sky sky map with an angular resolution that is specified by the
* m_irf_diffuse_resolution member.
***************************************************************************/
double GResponse::irf_diffuse(const GEvent& event,
const GSource& source,
const GObservation& obs) const
{
// Initialise IRF
double irf = 0.0;
// Get source attributes
const GEnergy& srcEng = source.energy();
const GTime& srcTime = source.time();
// If model is a diffuse map model then extract sky map
const GModelSpatialDiffuseMap* map =
dynamic_cast<const GModelSpatialDiffuseMap*>(source.model());
if (map != NULL) {
// Get reference to sky map
const GSkyMap& skymap = map->map();
// Loop over all sky map pixels
for (int i = 0; i < skymap.npix(); ++i) {
// Get map value
double value = skymap(i);
// Go to next pixel if map value is not positive
if (value <= 0.0) {
continue;
}
// Get sky direction
GSkyDir srcDir = skymap.inx2dir(i);
// Setup photon
GPhoton photon(srcDir, srcEng, srcTime);
// Add IRF multiplied by flux in map pixel. Since the map value
// is per steradian we have to multiply with the solid angle of
// the map pixel
irf += this->irf(event, photon, obs) * value * skymap.solidangle(i);
} // endfor: looped over all sky map pixels
} // endif: model was diffuse map
// ... otherwise if model is a cube map model then extract sky map
else {
const GModelSpatialDiffuseCube* cube =
dynamic_cast<const GModelSpatialDiffuseCube*>(source.model());
if (cube != NULL) {
// Get reference to sky cube
const GSkyMap& skymap = cube->cube();
// Loop over all sky map pixels
for (int i = 0; i < skymap.npix(); ++i) {
// Get sky direction
GSkyDir srcDir = skymap.inx2dir(i);
// Setup photon
GPhoton photon(srcDir, srcEng, srcTime);
// Get map value
double value = cube->eval(photon);
// Go to next pixel if map value is not positive
if (value <= 0.0) {
continue;
}
// Add IRF multiplied by flux in map pixel. Since the map
// value is per steradian we have to multiply with the solid
// angle of the map pixel
irf += this->irf(event, photon, obs) * value * skymap.solidangle(i);
} // endfor: looped over all sky map pixels
} // endelse: model was diffuse cube
// ... otherwise allocate all sky map with specified resolution
else {
// Allocate sky map
int nx = int(360.0/m_irf_diffuse_resolution + 0.5);
int ny = int(180.0/m_irf_diffuse_resolution + 0.5);
double dx = 360.0 / double(nx);
double dy = 180.0 / double(ny);
GSkyMap skymap = GSkyMap("CAR", "CEL", 0.0, 0.0, -dx, dy, nx, ny);
// Get pointer to diffuse model
const GModelSpatialDiffuse* model =
static_cast<const GModelSpatialDiffuse*>(source.model());
// Loop over all sky map pixels
for (int i = 0; i < skymap.npix(); ++i) {
// Get sky direction
GSkyDir srcDir = skymap.inx2dir(i);
// Setup photon
GPhoton photon(srcDir, srcEng, srcTime);
// Get model value
double value = model->eval(photon);
// Go to next pixel if map value is not positive
if (value <= 0.0) {
continue;
}
// Add IRF multiplied by flux in map pixel. Since the map
// value is per steradian we have to multiply with the solid
// angle of the map pixel
irf += this->irf(event, photon, obs) * value * skymap.solidangle(i);
} // endfor: looped over sky map pixels
} // endelse: model was not a cube
} // endelse: model was not a map
// Return IRF value
return irf;
}
/***********************************************************************//**
* @brief Return instrument response to composite source
*
* @param[in] event Observed event.
* @param[in] source Source.
* @param[in] obs Observation.
* @return Instrument response to composite source.
*
* Returns the instrument response to a specified composite source.
***************************************************************************/
double GResponse::irf_composite(const GEvent& event,
const GSource& source,
const GObservation& obs) const
{
// Initialise IRF
double irf = 0.0;
// Get pointer to composite model
const GModelSpatialComposite* model =
dynamic_cast<const GModelSpatialComposite*>(source.model());
// Loop over model components
for (int i = 0; i < model->components(); ++i) {
// Get pointer to spatial component
GModelSpatial* spat = const_cast<GModelSpatial*>(model->component(i));
// Create new GSource object
GSource src(source.name(), spat, source.energy(), source.time());
// Compute irf value
irf += irf_spatial(event, src, obs) * model->scale(i);
}
// Divide by number of model components
double sum = model->sum_of_scales();
if (sum > 0.0) {
irf /= sum;
}
// Return IRF value
return irf;
}
/***********************************************************************//**
* @brief Return instrument response to point source sky model
*
* @param[in] model Sky model.
* @param[in] obs Observation.
* @param[in] gradients Gradients matrix.
* @return Instrument response to point source sky model.
*
* Returns the instrument response to a point source sky model for all
* events.
***************************************************************************/
GVector GResponse::irf_ptsrc(const GModelSky& model,
const GObservation& obs,
GMatrix* gradients) const
{
// Get number of events
int nevents = obs.events()->size();
// Initialise result
GVector irfs(nevents);
// Loop over events
for (int k = 0; k < nevents; ++k) {
// Get reference to event
const GEvent& event = *((*obs.events())[k]);
// Get source energy and time (no dispersion)
GEnergy srcEng = event.energy();
GTime srcTime = event.time();
// Setup source
GSource source(model.name(), model.spatial(), srcEng, srcTime);
// Get IRF value for event
irfs[k] = this->irf_ptsrc(event, source, obs);
} // endfor: looped over events
// Return IRF value
return irfs;
}
/***********************************************************************//**
* @brief Return instrument response to radial source sky model
*
* @param[in] model Sky model.
* @param[in] obs Observation.
* @param[in] gradients Gradients matrix.
* @return Instrument response to radial source sky model.
*
* Returns the instrument response to a radial source sky model for all
* events.
***************************************************************************/
GVector GResponse::irf_radial(const GModelSky& model,
const GObservation& obs,
GMatrix* gradients) const
{
// Get number of events
int nevents = obs.events()->size();
// Initialise result
GVector irfs(nevents);
// Loop over events
for (int k = 0; k < nevents; ++k) {
// Get reference to event
const GEvent& event = *((*obs.events())[k]);
// Get source energy and time (no dispersion)
GEnergy srcEng = event.energy();
GTime srcTime = event.time();
// Setup source
GSource source(model.name(), model.spatial(), srcEng, srcTime);
// Get IRF value for event
irfs[k] = this->irf_radial(event, source, obs);
} // endfor: looped over events
// Return IRF value
return irfs;
}
/***********************************************************************//**
* @brief Return instrument response to ellipitical source sky model
*
* @param[in] model Sky model.
* @param[in] obs Observation.
* @param[in] gradients Gradients matrix.
* @return Instrument response to ellipitical source sky model.
*
* Returns the instrument response to a ellipitical source sky model for all
* events.
***************************************************************************/
GVector GResponse::irf_elliptical(const GModelSky& model,
const GObservation& obs,
GMatrix* gradients) const
{
// Get number of events
int nevents = obs.events()->size();
// Initialise result
GVector irfs(nevents);
// Loop over events
for (int k = 0; k < nevents; ++k) {
// Get reference to event
const GEvent& event = *((*obs.events())[k]);
// Get source energy and time (no dispersion)
GEnergy srcEng = event.energy();
GTime srcTime = event.time();
// Setup source
GSource source(model.name(), model.spatial(), srcEng, srcTime);
// Get IRF value for event
irfs[k] = this->irf_elliptical(event, source, obs);
} // endfor: looped over events
// Return IRF value
return irfs;
}
/***********************************************************************//**
* @brief Return instrument response to diffuse source sky model
*
* @param[in] model Sky model.
* @param[in] obs Observation.
* @param[in] gradients Gradients matrix.
* @return Instrument response to diffuse source sky model.
*
* Returns the instrument response to a diffuse source sky model for all
* events.
***************************************************************************/
GVector GResponse::irf_diffuse(const GModelSky& model,
const GObservation& obs,
GMatrix* gradients) const
{
// Get number of events
int nevents = obs.events()->size();
// Initialise result
GVector irfs(nevents);
// Loop over events
for (int k = 0; k < nevents; ++k) {
// Get reference to event
const GEvent& event = *((*obs.events())[k]);
// Get source energy and time (no dispersion)
GEnergy srcEng = event.energy();
GTime srcTime = event.time();
// Setup source
GSource source(model.name(), model.spatial(), srcEng, srcTime);
// Get IRF value for event
irfs[k] = this->irf_diffuse(event, source, obs);
} // endfor: looped over events
// Return IRF value
return irfs;
}
/***********************************************************************//**
* @brief Return instrument response to composite source sky model
*
* @param[in] model Sky model.
* @param[in] obs Observation.
* @param[in] gradients Gradients matrix.
* @return Instrument response to composite source sky model.
*
* Returns the instrument response to a composite source sky model for all
* events.
***************************************************************************/
GVector GResponse::irf_composite(const GModelSky& model,
const GObservation& obs,
GMatrix* gradients) const
{
// Get number of events
int nevents = obs.events()->size();
// Initialise result
GVector irfs(nevents);
// Get pointer to composite spatial model
const GModelSpatialComposite* composite =
dynamic_cast<const GModelSpatialComposite*>(model.spatial());
// Create copy of sky model
GModelSky sky = model;
// Loop over model components
for (int i = 0; i < composite->components(); ++i) {
// Set spatial component of sky model
sky.spatial(const_cast<GModelSpatial*>(composite->component(i)));
// Compute and add IRF values
irfs += irf_spatial(sky, obs, gradients) * composite->scale(i);
} // endfor: looped over all model components
// Divide by number of model components
double sum = composite->sum_of_scales();
if (sum > 0.0) {
irfs /= sum;
}
// Return IRF values
return irfs;
}
/***********************************************************************//**
* @brief Convolve sky model with the instrument response
*
* @param[in] model Sky model.
* @param[in] event Event.
* @param[in] srcEng Source energy.
* @param[in] srcTime Source time.
* @param[in] obs Observation.
* @param[in] grad Should model gradients be computed? (default: true)
* @return Event probability.
*
* Computes the event probability
*
* \f[
* P(p',E',t'|E,t) = \int S(p,E,t) \times R(p',E',t'|p,E,t) \, dp
* \f]
*
* for a given true energy \f$E\f$ and time \f$t\f$.
***************************************************************************/
double GResponse::eval_prob(const GModelSky& model,
const GEvent& event,
const GEnergy& srcEng,
const GTime& srcTime,
const GObservation& obs,
const bool& grad) const
{
// Initialise result
double prob = 0.0;
// Continue only if the model has a spatial component
if (model.spatial() != NULL) {
// Set source
GSource source(model.name(), model.spatial(), srcEng, srcTime);
// Compute IRF value
double irf = irf_spatial(event, source, obs);
// Continue only if IRF value is positive
if (irf > 0.0) {
// Optionally get scaling
double scale = (model.has_scales())
? model.scale(obs.instrument()).value() : 1.0;
// Evaluate spectral and temporal components
double spec = (model.spectral() != NULL)
? model.spectral()->eval(srcEng, srcTime, grad) : 1.0;
double temp = (model.temporal() != NULL)
? model.temporal()->eval(srcTime, grad) : 1.0;
// Compute probability
prob = spec * temp * irf * scale;
// Optionally compute partial derivatives
if (grad) {
// Multiply factors to spectral gradients
if (model.spectral() != NULL) {
double fact = temp * irf * scale;
if (fact != 1.0) {
for (int i = 0; i < model.spectral()->size(); ++i) {
(*model.spectral())[i].factor_gradient((*model.spectral())[i].factor_gradient() * fact);
}
}
}
// Multiply factors to temporal gradients
if (model.temporal() != NULL) {
double fact = spec * irf * scale;
if (fact != 1.0) {
for (int i = 0; i < model.temporal()->size(); ++i) {
(*model.temporal())[i].factor_gradient((*model.temporal())[i].factor_gradient() * fact);
}
}
}
// Optionally compute scale gradient for instrument
if (model.has_scales()) {
for (int i = 0; i < model.scales(); ++i) {
double g_scale = 0.0;
if (model.scale(i).name() == obs.instrument()) {
if (model.scale(i).is_free()) {
g_scale = model.scale(i).scale() * spec * temp * irf;
}
}
model.scale(i).factor_gradient(g_scale);
}
}
} // endif: computed partial derivatives
// Compile option: Check for NaN/Inf
#if defined(G_NAN_CHECK)
if (gammalib::is_notanumber(prob) || gammalib::is_infinite(prob)) {
std::cout << "*** ERROR: GResponse::eval_prob:";
std::cout << " NaN/Inf encountered";
std::cout << " (prob=" << prob;
std::cout << ", spec=" << spec;
std::cout << ", temp=" << temp;
std::cout << ", irf=" << irf;
std::cout << ")" << std::endl;
}
#endif
} // endif: IRF value was positive
// ... otherwise if gradient computation is requested then set the
// spectral and temporal gradients to zero
else if (grad) {
// Reset spectral gradients
if (model.spectral() != NULL) {
for (int i = 0; i < model.spectral()->size(); ++i) {
(*model.spectral())[i].factor_gradient(0.0);
}
}
// Reset temporal gradients
if (model.temporal() != NULL) {
for (int i = 0; i < model.temporal()->size(); ++i) {
(*model.temporal())[i].factor_gradient(0.0);
}
}
// Optionally reset scale gradients
if (model.has_scales()) {
for (int i = 0; i < model.scales(); ++i) {
model.scale(i).factor_gradient(0.0);
}
}
} // endelse: IRF value was not positive
} // endif: Gamma-ray source model had a spatial component
// Return event probability
return prob;
}
/***********************************************************************//**
* @brief Convolve sky model with the instrument response
*
* @param[in] model Sky model.
* @param[in] obs Observation.
* @param[out] gradients Pointer to matrix of gradients.
* @return Event probabilities.
*
* Computes the event probability
*
* \f[
* P(p',E',t'|E,t) = \int S(p,E,t) \times R(p',E',t'|p,E,t) \, dp
* \f]
*
* for a all events.
***************************************************************************/
GVector GResponse::eval_probs(const GModelSky& model,
const GObservation& obs,
GMatrixSparse* gradients) const
{
// Get number of model parameters and number of events
int npars = model.size();
int nevents = obs.events()->size();
// Initialise gradients flag
bool grad = (gradients != NULL);
// Initialise result
GVector probs(nevents);
// Continue only if the model has a spatial component
if (model.spatial() != NULL) {
// Initialise matrix to hold spatial gradients
GMatrix spat_gradients(nevents, model.spatial()->size());
// Compute IRF value
probs = irf_spatial(model, obs, &spat_gradients);
// Get global model scaling
double scale = (model.has_scales())
? model.scale(obs.instrument()).value() : 1.0;
// Initialise temporary vectors to hold gradients
GVector* tmp_gradients = NULL;
if (grad) {
tmp_gradients = new GVector[npars];
for (int i = 0; i < npars; ++i) {
tmp_gradients[i] = GVector(nevents);
}
}
// Loop over events
for (int k = 0; k < nevents; ++k) {
// Get probability
double spat = probs[k];
// Continue only if spatial value is positive
if (spat > 0.0) {
// Get reference to event
const GEvent& event = *((*obs.events())[k]);
// Get source energy and time
GEnergy srcEng = event.energy();
GTime srcTime = event.time();
// Evaluate spectral and temporal components
double spec = (model.spectral() != NULL)
? model.spectral()->eval(srcEng, srcTime, grad)
: 1.0;
double temp = (model.temporal() != NULL)
? model.temporal()->eval(srcTime, grad)
: 1.0;
// Compute probability
probs[k] = spat * spec * temp * scale;
// Optionally compute partial derivatives
if (grad) {
// Get number of spatial, spectral and temporal parameters
int n_spat = model.spatial()->size();
int n_spec = model.spectral()->size();
int n_temp = model.temporal()->size();
// Multiply factors to spatial gradients
if (model.spatial() != NULL) {
double fact = spec * temp * scale;
for (int i = 0; i < n_spat; ++i) {
tmp_gradients[i][k] = spat_gradients(k,i) * fact;
}
}
// Multiply factors to spectral gradients
if (model.spectral() != NULL) {
int offset = n_spat;
double fact = spat * temp * scale;
for (int i = 0; i < n_spec; ++i) {
tmp_gradients[offset+i][k] =
(*(model.spectral()))[i].factor_gradient() * fact;
}
}
// Multiply factors to temporal gradients
if (model.temporal() != NULL) {
int offset = n_spat + n_spec;
double fact = spat * spec * scale;
for (int i = 0; i < n_temp; ++i) {
tmp_gradients[offset+i][k] =
(*(model.temporal()))[i].factor_gradient() * fact;
}
}
// Optionally set scale gradient for instrument
if (model.has_scales()) {
int offset = n_spat + n_spec + n_temp;
double fact = spat * spec * temp;
for (int i = 0; i < model.scales(); ++i) {
const GModelPar& par = model.scale(i);
double g_scale = 0.0;
if (par.name() == obs.instrument()) {
if (par.is_free()) {
tmp_gradients[offset+i][k] = par.scale() * fact;
}
}
}
}
} // endif: computed partial derivatives
} // endif: IRF spatial value was positive
// Compile option: Check for NaN/Inf
#if defined(G_NAN_CHECK)
if (gammalib::is_notanumber(probs[k]) || gammalib::is_infinite(probs[k])) {
std::cout << "*** ERROR: GResponse::eval_prob:";
std::cout << " NaN/Inf encountered";
std::cout << " (probs[" << k << "]=" << probs[k];
std::cout << ", spat=" << spat;
std::cout << ")" << std::endl;
}
#endif
} // endfor: looped over events
// Post-process gradients
if (grad) {
// Fill gradients into matrix
for (int i = 0; i < npars; ++i) {
gradients->column(i, tmp_gradients[i]);
}
// Delete temporal gradients
delete [] tmp_gradients;
} // endif: gradient post processing
} // endif: Gamma-ray source model had a spatial component
// Return event probabilities
return probs;
}
/***********************************************************************//**
* @brief Return size of vector for energy dispersion computation
*
* @param[in] model Sky model.
* @param[in] obs Observation.
* @param[out] grad Signals whether gradients should be computed.
* @return Size of vector for energy dispersion computation.
*
* Computes the size of the vector that will be computed for the computation
* of the energy dispersion.
***************************************************************************/
int GResponse::size_edisp_vector(const GModelSky& model,
const GObservation& obs,
const bool& grad) const
{
// Initialise vector size
int size = 1;
// Determine size of gradient part
if (grad) {
if (model.spectral() != NULL) {
for (int i = 0; i < model.spectral()->size(); ++i) {
GModelPar& par = (*(model.spectral()))[i];
if (par.is_free() && par.has_grad()) {
size++;
}
}
}
if (model.temporal() != NULL) {
for (int i = 0; i < model.temporal()->size(); ++i) {
GModelPar& par = (*(model.temporal()))[i];
if (par.is_free() && par.has_grad()) {
size++;
}
}
}
if (model.has_scales()) {
for (int i = 0; i < model.scales(); ++i) {
GModelPar& par = const_cast<GModelPar&>(model.scale(i));
if (par.name() == obs.instrument()) {
if (par.is_free() && par.has_grad()) {
size++;
}
}
}
}
}
// Return size
return size;
}
/***********************************************************************//**
* @brief Constructor for energy dispersion integration kernels class
*
* @param[in] parent Pointer to response.
* @param[in] obs Pointer to observation.
* @param[in] model Pointer to sky model.
* @param[in] event Pointer to event.
* @param[in] srcTime True time.
* @param[in] grad Evaluate gradients?
*
* This method constructs the integration kernel needed for the energy
* dispersion computation.
***************************************************************************/
GResponse::edisp_kerns::edisp_kerns(const GResponse* parent,
const GObservation* obs,
const GModelSky* model,
const GEvent* event,
const GTime& srcTime,
const bool& grad)
{
// Set members
m_parent = parent;
m_obs = obs;
m_model = model;
m_event = event;
m_size = 1;
m_srcTime = srcTime;
m_grad = grad;
// If gradients are requested then put pointers to all relevant parameter
// in the parameter pointer vector
m_pars.clear();
if (m_grad) {
// Add free spectral parameters with analytical gradients
if (m_model->spectral() != NULL) {
for (int i = 0; i < m_model->spectral()->size(); ++i) {
GModelPar& par = (*(m_model->spectral()))[i];
if (par.is_free() && par.has_grad()) {
m_pars.push_back(&par);
}
}
}
// Add free temporal parameters with analytical gradients
if (m_model->temporal() != NULL) {
for (int i = 0; i < m_model->temporal()->size(); ++i) {
GModelPar& par = (*(m_model->temporal()))[i];
if (par.is_free() && par.has_grad()) {
m_pars.push_back(&par);
}
}
}
// Add free scaling factors
if (m_model->has_scales()) {
for (int i = 0; i < m_model->scales(); ++i) {
GModelPar& par = const_cast<GModelPar&>(m_model->scale(i));
if (par.name() == m_obs->instrument()) {
if (par.is_free() && par.has_grad()) {
m_pars.push_back(&par);
}
}
}
}
// Update size
m_size += m_pars.size();
} // endif: gradients were requested
// Return
return;
}
/***********************************************************************//**
* @brief Evaluate energy dispersion integration kernel
*
* @param[in] etrue True photon energy in MeV.
*
* This method implements the integration kernel needed for the
* GResponse::edisp_kern() class.
***************************************************************************/
GVector GResponse::edisp_kerns::eval(const double& etrue)
{
// Initialise result
GVector kernels(m_size);
// Initialise Ndarray array index
int index = 0;
// Set true energy
GEnergy srcEng;
srcEng.MeV(etrue);
// Get function value
kernels[index++] = m_parent->eval_prob(*m_model, *m_event,
srcEng, m_srcTime, *m_obs,
m_grad);
// If gradients are requested then extract them and put them into the
// array
if (m_grad) {
for (int i = 0; i < m_pars.size(); ++i, ++index) {
kernels[index] = m_pars[i]->factor_gradient();
}
}
// Compile option: Check for NaN
#if defined(G_NAN_CHECK)
if (gammalib::is_notanumber(kernels[0]) || gammalib::is_infinite(kernels[0])) {
std::cout << "*** ERROR: GResponse::edisp_kern::eval";
std::cout << "(etrue=" << etrue << "): NaN/Inf encountered";
std::cout << " (value=" << kernels[0] << ")" << std::endl;
}
#endif
// Return kernels
return kernels;
}
/***********************************************************************//**
* @brief Zenith angle integration kernel for radial model
*
* @param[in] theta Zenith angle (radians).
* @return IRF value.
*
* Integrated the IRF multiplied by the model value for a given zenith angle
* over all azimuth angles.
***************************************************************************/
double GResponse::irf_radial_kern_theta::eval(const double& theta)
{
// Initialise result
double irf = 0.0;
// Continue only for positive zenith angles (otherwise the integral will
// be zero)
if (theta > 0.0) {
// Evaluate sky model
double model = m_model->eval(theta, *m_srcEng, *m_srcTime);
// Continue only if model is positive
if (model > 0.0) {
// Set azimuthal integration range
double phi_min = 0.0;
double phi_max = gammalib::twopi;
// Setup integration kernel
irf_radial_kern_phi integrand(m_rsp,
m_event,
m_obs,
m_rot,
theta,
m_srcEng,
m_srcTime);
// Setup integration
GIntegral integral(&integrand);
integral.fixed_iter(m_iter_phi);
// Integrate over phi
irf = integral.romberg(phi_min, phi_max, m_iter_phi) *
model * std::sin(theta);
} // endif: model was positive
} // endif: theta was positive
// Return result
return irf;
}
/***********************************************************************//**
* @brief Azimuth angle integration kernel for radial model
*
* @param[in] phi Azimuth angle (radians).
* @return IRF value.
*
* Computes the IRF at a given zenith and azimuth angle with respect to a
* specified centre.
***************************************************************************/
double GResponse::irf_radial_kern_phi::eval(const double& phi)
{
// Set up native coordinate vector
double cos_phi = std::cos(phi);
double sin_phi = std::sin(phi);
GVector native(-cos_phi*m_sin_theta, sin_phi*m_sin_theta, m_cos_theta);
// Rotate vector into celestial coordinates
GVector vector = (*m_rot) * native;
// Convert vector into sky direction
GSkyDir dir(vector);
// Setup photon
GPhoton photon(dir, *m_srcEng, *m_srcTime);
// Evaluate IRF for photon
double irf = m_rsp->irf(*m_event, photon, *m_obs);
// Return
return irf;
}
/***********************************************************************//**
* @brief Zenith angle integration kernel for elliptical model
*
* @param[in] theta Zenith angle (radians).
* @return IRF value.
*
* Integrated the IRF multiplied by the model value for a given zenith angle
* over all azimuth angles.
***************************************************************************/
double GResponse::irf_elliptical_kern_theta::eval(const double& theta)
{
// Initialise result
double irf = 0.0;
// Continue only for positive zenith angles (otherwise the integral will
// be zero)
if (theta > 0.0) {
// Set azimuthal integration range
double phi_min = 0.0;
double phi_max = gammalib::twopi;
// Setup integration kernel
irf_elliptical_kern_phi integrand(m_rsp,
m_event,
m_obs,
m_model,
m_rot,
theta,
m_srcEng,
m_srcTime);
// Setup integration
GIntegral integral(&integrand);
integral.fixed_iter(m_iter_phi);
// Integrate over phi
irf = integral.romberg(phi_min, phi_max, m_iter_phi) * std::sin(theta);
} // endif: theta was positive
// Return result
return irf;
}
/***********************************************************************//**
* @brief Azimuth angle integration kernel for elliptical model
*
* @param[in] phi Azimuth angle (radians).
* @return IRF value.
*
* Computes the IRF at a given zenith and azimuth angle with respect to a
* specified centre.
***************************************************************************/
double GResponse::irf_elliptical_kern_phi::eval(const double& phi)
{
// Initialise result
double irf = 0.0;
// Evaluate sky model
double model = m_model->eval(m_theta, phi, *m_srcEng, *m_srcTime);
// Continue only if model is positive
if (model > 0.0) {
// Set up native coordinate vector
double cos_phi = std::cos(phi);
double sin_phi = std::sin(phi);
GVector native(-cos_phi*m_sin_theta, sin_phi*m_sin_theta, m_cos_theta);
// Rotate vector into celestial coordinates
GVector vector = (*m_rot) * native;
// Convert vector into sky direction
GSkyDir dir(vector);
// Setup photon
GPhoton photon(dir, *m_srcEng, *m_srcTime);
// Evaluate IRF for photon
irf = m_rsp->irf(*m_event, photon, *m_obs) * model;
} // endif: model was positive
// Return
return irf;
}