GCTAResponseIrf.cpp
121 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
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
/***************************************************************************
* GCTAResponseIrf.cpp - CTA instrument response function class *
* ----------------------------------------------------------------------- *
* copyright (C) 2010-2015 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 GCTAResponseIrf.cpp
* @brief CTA response class implementation
* @author Juergen Knoedlseder
*/
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <cmath>
#include <vector>
#include <string>
#include "GFits.hpp"
#include "GTools.hpp"
#include "GMath.hpp"
#include "GIntegral.hpp"
#include "GCaldb.hpp"
#include "GSource.hpp"
#include "GRan.hpp"
#include "GModelSky.hpp"
#include "GModelSpatialPointSource.hpp"
#include "GModelSpatialRadial.hpp"
#include "GModelSpatialRadialShell.hpp"
#include "GModelSpatialElliptical.hpp"
#include "GCTAObservation.hpp"
#include "GCTAResponseIrf.hpp"
#include "GCTAResponse_helpers.hpp"
#include "GCTAPointing.hpp"
#include "GCTAEventAtom.hpp"
#include "GCTAEventList.hpp"
#include "GCTARoi.hpp"
#include "GCTAException.hpp"
#include "GCTASupport.hpp"
#include "GCTAAeff2D.hpp"
#include "GCTAAeffArf.hpp"
#include "GCTAAeffPerfTable.hpp"
#include "GCTAPsf2D.hpp"
#include "GCTAPsfVector.hpp"
#include "GCTAPsfPerfTable.hpp"
#include "GCTAPsfKing.hpp"
#include "GCTAAeff.hpp"
#include "GCTAPsf.hpp"
#include "GCTAEdisp.hpp"
#include "GCTAEdisp2D.hpp"
#include "GCTAEdispRmf.hpp"
#include "GCTAEdispPerfTable.hpp"
#include "GCTABackground.hpp"
#include "GCTABackgroundPerfTable.hpp"
#include "GCTABackground3D.hpp"
/* __ Method name definitions ____________________________________________ */
#define G_IRF "GCTAResponseIrf::irf(GInstDir&, GEnergy&, GTime&, GSkyDir&,"\
" GEnergy&, GTime&, GObservation&)"
#define G_MC "GCTAResponseIrf::mc(double&, GPhoton&, GObservation&, GRan&)"
#define G_READ "GCTAResponseIrf::read(GXmlElement&)"
#define G_WRITE "GCTAResponseIrf::write(GXmlElement&)"
#define G_LOAD_AEFF "GCTAResponseIrf::load_aeff(std::string&)"
#define G_LOAD_PSF "GCTAResponseIrf::load_psf(std::string&)"
#define G_LOAD_EDISP "GCTAResponseIrf::load_edisp(std::string&)"
#define G_LOAD_BACKGROUND "GCTAResponseIrf::load_background(std::string&)"
#define G_NIRF "GCTAResponseIrf::nirf(GPhoton&, GEnergy&, GTime&,"\
" GObservation&)"
#define G_IRF_RADIAL "GCTAResponseIrf::irf_radial(GEvent&, GSource&,"\
" GObservation&)"
#define G_IRF_ELLIPTICAL "GCTAResponseIrf::irf_elliptical(GEvent&, GSource&,"\
" GObservation&)"
#define G_IRF_DIFFUSE "GCTAResponseIrf::irf_diffuse(GEvent&, GSource&,"\
" GObservation&)"
#define G_NROI_RADIAL "GCTAResponseIrf::nroi_radial(GModelSky&, GEnergy&,"\
" GTime&, GEnergy&, GTime&, GObservation&)"
#define G_NROI_ELLIPTICAL "GCTAResponseIrf::nroi_elliptical(GModelSky&,"\
" GEnergy&, GTime&, GEnergy&, GTime&, GObservation&)"
#define G_NROI_DIFFUSE "GCTAResponseIrf::nroi_diffuse(GModelSky&, GEnergy&,"\
" GTime&, GEnergy&, GTime&, GObservation&)"
#define G_AEFF "GCTAResponseIrf::aeff(double&, double&, double&, double&,"\
" double&)"
#define G_PSF "GCTAResponseIrf::psf(double&, double&, double&, double&,"\
" double&)"
#define G_PSF_DELTA_MAX "GCTAResponseIrf::psf_delta_max(double&, double&,"\
" double&, double&, double&)"
/* __ Macros _____________________________________________________________ */
/* __ Coding definitions _________________________________________________ */
#define G_USE_IRF_CACHE //!< Use IRF cache in irf_diffuse method
#define G_USE_NPRED_CACHE //!< Use Npred cache in npred_diffuse method
//#define G_USE_PSF_SYSTEM //!< Do radial Irf integrations in Psf system
/* __ Debug definitions __________________________________________________ */
//#define G_DEBUG_IRF_RADIAL //!< Debug irf_radial method
//#define G_DEBUG_IRF_DIFFUSE //!< Debug irf_diffuse method
//#define G_DEBUG_IRF_ELLIPTICAL //!< Debug irf_elliptical method
//#define G_DEBUG_NROI_RADIAL //!< Debug npred_radial method
//#define G_DEBUG_NROI_ELLIPTICAL //!< Debug npred_elliptical method
//#define G_DEBUG_NROI_DIFFUSE //!< Debug npred_diffuse method
//#define G_DEBUG_PRINT_AEFF //!< Debug print() Aeff method
//#define G_DEBUG_PRINT_PSF //!< Debug print() Psf method
//#define G_DEBUG_PSF_DUMMY_SIGMA //!< Debug psf_dummy_sigma method
/* __ Constants __________________________________________________________ */
/*==========================================================================
= =
= Constructors/destructors =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Void constructor
*
* Constructs void CTA response.
***************************************************************************/
GCTAResponseIrf::GCTAResponseIrf(void) : GCTAResponse()
{
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Copy constructor
*
* @param[in] rsp CTA response.
*
* Constructs CTA response by making a deep copy of an existing object.
**************************************************************************/
GCTAResponseIrf::GCTAResponseIrf(const GCTAResponseIrf& rsp) : GCTAResponse(rsp)
{
// Initialise members
init_members();
// Copy members
copy_members(rsp);
// Return
return;
}
/***********************************************************************//**
* @brief XML constructor
*
* @param[in] xml XML element.
*
* Construct CTA response from XML element.
***************************************************************************/
GCTAResponseIrf::GCTAResponseIrf(const GXmlElement& xml) : GCTAResponse()
{
// Initialise members
init_members();
// Read information from XML element
read(xml);
// Return
return;
}
/***********************************************************************//**
* @brief Response constructor
*
* @param[in] rspname Response file name.
* @param[in] caldb Calibration database.
*
* Create instance of CTA response by specifying the response name and the
* calibration database. The response name can be either a response identifier
* or a filename (see GCTAResponseIrf::load for more information).
***************************************************************************/
GCTAResponseIrf::GCTAResponseIrf(const std::string& rspname,
const GCaldb& caldb) : GCTAResponse()
{
// Initialise members
init_members();
// Set calibration database
m_caldb = caldb;
// Load IRF
load(rspname);
// Return
return;
}
/***********************************************************************//**
* @brief Destructor
*
* Destroys instance of CTA response object.
***************************************************************************/
GCTAResponseIrf::~GCTAResponseIrf(void)
{
// Free members
free_members();
// Return
return;
}
/*==========================================================================
= =
= Operators =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Assignment operator
*
* @param[in] rsp CTA response.
* @return CTA response.
*
* Assigns CTA response object to another CTA response object. The assignment
* performs a deep copy of all information, hence the original object from
* which the assignment has been performed can be destroyed after this
* operation without any loss of information.
***************************************************************************/
GCTAResponseIrf& GCTAResponseIrf::operator=(const GCTAResponseIrf& rsp)
{
// Execute only if object is not identical
if (this != &rsp) {
// Copy base class members
this->GCTAResponse::operator=(rsp);
// Free members
free_members();
// Initialise members
init_members();
// Copy members
copy_members(rsp);
} // endif: object was not identical
// Return this object
return *this;
}
/*==========================================================================
= =
= Public methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Clear instance
*
* Clears CTA response object by resetting all members to an initial state.
* Any information that was present in the object before will be lost.
***************************************************************************/
void GCTAResponseIrf::clear(void)
{
// Free class members (base and derived classes, derived class first)
free_members();
this->GCTAResponse::free_members();
this->GResponse::free_members();
// Initialise members
this->GResponse::init_members();
this->GCTAResponse::init_members();
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Clone instance
*
* @return Pointer to deep copy of CTA response.
*
* Creates a clone (deep copy) of a CTA response object.
***************************************************************************/
GCTAResponseIrf* GCTAResponseIrf::clone(void) const
{
return new GCTAResponseIrf(*this);
}
/***********************************************************************//**
* @brief Return value of instrument response function
*
* @param[in] event Observed event.
* @param[in] photon Incident photon.
* @param[in] obs Observation.
*
* @todo Set polar angle phi of photon in camera system
***************************************************************************/
double GCTAResponseIrf::irf(const GEvent& event,
const GPhoton& photon,
const GObservation& obs) const
{
// Retrieve CTA pointing and instrument direction
const GCTAPointing& pnt = retrieve_pnt(G_IRF, obs);
const GCTAInstDir& dir = retrieve_dir(G_IRF, event);
// Get event attributes
const GSkyDir& obsDir = dir.dir();
const GEnergy& obsEng = event.energy();
// Get photon attributes
const GSkyDir& srcDir = photon.dir();
const GEnergy& srcEng = photon.energy();
const GTime& srcTime = photon.time();
// Get pointing direction zenith angle and azimuth [radians]
double zenith = pnt.zenith();
double azimuth = pnt.azimuth();
// Get radial offset and polar angles of true photon in camera [radians]
double theta = pnt.dir().dist(srcDir);
double phi = 0.0; //TODO: Implement Phi dependence
// Get log10(E/TeV) of true photon energy.
double srcLogEng = srcEng.log10TeV();
// Determine angular separation between true and measured photon
// direction in radians
double delta = obsDir.dist(srcDir);
// Get maximum angular separation for which PSF is significant
double delta_max = psf_delta_max(theta, phi, zenith, azimuth, srcLogEng);
// Initialise IRF value
double irf = 0.0;
// Compute only if we're sufficiently close to PSF
if (delta <= delta_max) {
// Get effective area component
irf = aeff(theta, phi, zenith, azimuth, srcLogEng);
// Multiply-in PSF
if (irf > 0.0) {
// Get PSF component
irf *= psf(delta, theta, phi, zenith, azimuth, srcLogEng);
// Multiply-in energy dispersion
if (use_edisp() && irf > 0.0) {
// Multiply-in energy dispersion
irf *= edisp(obsEng, theta, phi, zenith, azimuth, srcLogEng);
} // endif: energy dispersion was available and PSF was non-zero
// Apply deadtime correction
irf *= obs.deadc(srcTime);
} // endif: Aeff was non-zero
} // endif: we were sufficiently close to PSF
// Compile option: Check for NaN/Inf
#if defined(G_NAN_CHECK)
if (gammalib::is_notanumber(irf) || gammalib::is_infinite(irf)) {
std::cout << "*** ERROR: GCTAResponseIrf::irf:";
std::cout << " NaN/Inf encountered";
std::cout << " (irf=" << irf;
std::cout << ", theta=" << theta;
std::cout << ", phi=" << phi << ")";
std::cout << std::endl;
}
#endif
// Return IRF value
return irf;
}
/***********************************************************************//**
* @brief Return instrument response
*
* @param[in] event Event.
* @param[in] source Source.
* @param[in] obs Observation.
* @return Instrument response.
*
* Returns the instrument response for a given event, source and observation.
***************************************************************************/
double GCTAResponseIrf::irf(const GEvent& event,
const GSource& source,
const GObservation& obs) const
{
// Initialise IRF value
double irf = 0.0;
// Select IRF depending on the spatial model type
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;
default:
break;
}
// Return IRF value
return irf;
}
/***********************************************************************//**
* @brief Return integral of event probability for a given sky model over ROI
*
* @param[in] model Sky model.
* @param[in] obsEng Observed photon energy.
* @param[in] obsTime Observed photon arrival time.
* @param[in] obs Observation.
* @return Event probability.
*
* @exception GException::feature_not_implemented
* Method is not implemented.
*
* Computes the integral
*
* \f[
* N_{\rm ROI}(E',t') = \int_{\rm ROI} P(p',E',t') dp'
* \f]
*
* of the event probability
*
* \f[
* P(p',E',t') = \int \int \int
* S(p,E,t) \times R(p',E',t'|p,E,t) \, dp \, dE \, dt
* \f]
*
* for a given sky model \f$S(p,E,t)\f$ and response function
* \f$R(p',E',t'|p,E,t)\f$ over the Region of Interest (ROI).
***************************************************************************/
double GCTAResponseIrf::nroi(const GModelSky& model,
const GEnergy& obsEng,
const GTime& obsTime,
const GObservation& obs) const
{
// Set number of iterations for Romberg integration.
static const int iter = 6;
// Initialise Nroi value
double nroi = 0.0;
// No time dispersion supported
const GTime& srcTime = obsTime;
// If energy dispersion is requested then integrate over the relevant
// true photon energies ...
if (use_edisp()) {
// Retrieve true energy boundaries
double obsLogEng = obsEng.log10TeV();
GEbounds ebounds = edisp()->ebounds_src(obsLogEng);
// Loop over all boundaries
for (int i = 0; i < ebounds.size(); ++i) {
// Get boundaries in MeV
double emin = ebounds.emin(i).MeV();
double emax = ebounds.emax(i).MeV();
// Continue only if valid
if (emax > emin) {
// Setup integration function
cta_nroi_kern integrand(this, &obs, &model, srcTime, obsEng, obsTime);
GIntegral integral(&integrand);
// Set fixed number of iterations
integral.fixed_iter(iter);
// Do Romberg integration
emin = std::log(emin);
emax = std::log(emax);
nroi += integral.romberg(emin, emax);
} // endif: interval was valid
} // endfor: looped over energy intervals
} // endif: energy dispersion requested
// ... otherwise evaluate
else {
// No energy dispersion
const GEnergy& srcEng = obsEng;
// Compute response components
double npred_spatial = this->nroi(model, srcEng, srcTime, obsEng, obsTime, obs);
double npred_spectral = model.spectral()->eval(srcEng, srcTime);
double npred_temporal = model.temporal()->eval(srcTime);
// Compute response
nroi = npred_spatial * npred_spectral * npred_temporal;
} // endelse: no energy dispersion requested
// If required, apply instrument specific model scaling
if (model.has_scales()) {
nroi *= model.scale(obs.instrument()).value();
}
// Compile option: Check for NaN/Inf
#if defined(G_NAN_CHECK)
if (gammalib::is_notanumber(nroi) || gammalib::is_infinite(nroi)) {
std::cout << "*** ERROR: GCTAResponseIrf::nroi:";
std::cout << " NaN/Inf encountered";
std::cout << " (nroi=" << nroi;
std::cout << ", obsEng=" << obsEng;
std::cout << ", obsTime=" << obsTime;
std::cout << ")" << std::endl;
}
#endif
// Return response value
return nroi;
}
/***********************************************************************//**
* @brief Return true energy boundaries for a specific observed energy
*
* @param[in] obsEnergy Observed Energy.
* @return True energy boundaries for given observed energy.
***************************************************************************/
GEbounds GCTAResponseIrf::ebounds(const GEnergy& obsEnergy) const
{
// Initialise an empty boundary object
GEbounds ebounds;
// If energy dispersion is available then set the energy boundaries
if (edisp() != NULL) {
double obsLogEng = obsEnergy.log10TeV();
ebounds = edisp()->ebounds_src(obsLogEng); // Requires TeV
}
// Return energy boundaries
return ebounds;
}
/***********************************************************************//**
* @brief Simulate event from photon
*
* @param[in] area Simulation surface area.
* @param[in] photon Photon.
* @param[in] obs Observation.
* @param[in] ran Random number generator.
* @return Simulated event.
*
* Simulates a CTA event using the response function from an incident photon.
* If the event is not detected a NULL pointer is returned.
*
* The method also applies a deadtime correction using a Monte Carlo process,
* taking into account temporal deadtime variations. For this purpose, the
* method makes use of the time dependent GObservation::deadc method.
*
* @todo Set polar angle phi of photon in camera system
* @todo Implement energy dispersion
***************************************************************************/
GCTAEventAtom* GCTAResponseIrf::mc(const double& area, const GPhoton& photon,
const GObservation& obs, GRan& ran) const
{
// Initialise event
GCTAEventAtom* event = NULL;
// Retrieve CTA pointing
const GCTAPointing& pnt = retrieve_pnt(G_MC, obs);
// Get pointing direction zenith angle and azimuth [radians]
double zenith = pnt.zenith();
double azimuth = pnt.azimuth();
// Get radial offset and polar angles of true photon in camera [radians]
double theta = pnt.dir().dist(photon.dir());
double phi = 0.0; //TODO Implement Phi dependence
// Compute effective area for photon
double srcLogEng = photon.energy().log10TeV();
double effective_area = aeff(theta, phi, zenith, azimuth, srcLogEng);
// Compute limiting value
double ulimite = effective_area / area;
// Warning if ulimite is larger than one
if (ulimite > 1.0) {
std::string msg = "Effective area "+
gammalib::str(effective_area)+
" cm2 is larger than simulation surface area "+
gammalib::str(area)+
" cm2 for photon energy "+
gammalib::str(photon.energy().TeV())+
" TeV. Simulations are inaccurate.";
gammalib::warning(G_MC, msg);
}
// Continue only if event is detected
if (ran.uniform() <= ulimite) {
// Apply deadtime correction
double deadc = obs.deadc(photon.time());
if (deadc >= 1.0 || ran.uniform() <= deadc) {
// Simulate offset from photon arrival direction
double delta = psf()->mc(ran, srcLogEng, theta, phi, zenith, azimuth) *
gammalib::rad2deg;
double alpha = 360.0 * ran.uniform();
// Rotate sky direction by offset
GSkyDir sky_dir = photon.dir();
sky_dir.rotate_deg(alpha, delta);
// Set measured photon arrival direction in instrument direction
GCTAInstDir inst_dir = pnt.instdir(sky_dir);
// Set measured photon energy
GEnergy energy = photon.energy();
if (use_edisp()) {
energy = edisp()->mc(ran, srcLogEng, theta, phi, zenith, azimuth);
}
// Allocate event
event = new GCTAEventAtom;
// Set event attributes
event->dir(inst_dir);
event->energy(energy);
event->time(photon.time());
} // endif: detector was alive
} // endif: event was detected
// Return event
return event;
}
/***********************************************************************//**
* @brief Read response from XML element
*
* @param[in] xml XML element.
*
* Reads information for a CTA observation from an XML element. The
* calibration database and response name can be specified using
*
* <observation name="..." id="..." instrument="...">
* ...
* <parameter name="Calibration" database="..." response="..."/>
* </observation>
*
* If even more control is required over the response, individual file names
* can be specified using
*
* <observation name="..." id="..." instrument="...">
* ...
* <parameter name="EffectiveArea" file="..."/>
* <parameter name="PointSpreadFunction" file="..."/>
* <parameter name="EnergyDispersion" file="..."/>
* <parameter name="Background" file="..."/>
* </observation>
*
***************************************************************************/
void GCTAResponseIrf::read(const GXmlElement& xml)
{
// First check for "Calibration" parameter
if (gammalib::xml_has_par(xml, "Calibration")) {
// Get parameter
const GXmlElement* par = gammalib::xml_get_par(G_READ, xml, "Calibration");
// Read database and response
std::string xml_caldb = gammalib::strip_whitespace(par->attribute("database"));
std::string xml_rspname = gammalib::strip_whitespace(par->attribute("response"));
// Set calibration database
GCaldb caldb;
if (gammalib::dir_exists(xml_caldb)) {
caldb.rootdir(xml_caldb);
}
else {
caldb.open("cta", xml_caldb);
}
this->caldb(caldb);
// Load response
this->load(xml_rspname);
// If there is a sigma attribute then set sigma values of Aeff and
// Background
if (par->has_attribute("sigma")) {
// Get sigma value
double sigma = gammalib::todouble(par->attribute("sigma"));
// If we have an effective area performance table then set sigma
// value
GCTAAeffPerfTable* perf = const_cast<GCTAAeffPerfTable*>(dynamic_cast<const GCTAAeffPerfTable*>(aeff()));
if (perf != NULL) {
perf->sigma(sigma);
}
// If we have a background performance table then set sigma value
GCTABackgroundPerfTable* bgm = const_cast<GCTABackgroundPerfTable*>(dynamic_cast<const GCTABackgroundPerfTable*>(background()));
if (bgm != NULL) {
bgm->sigma(sigma);
}
} // endif: sigma attribute specified
// Store database and response names (we do this now since the
// load() method results the object, except of the calibration
// database)
m_xml_caldb = xml_caldb;
m_xml_rspname = xml_rspname;
} // endif: "Calibration" parameter found
// ... otherwise check for components
else {
// Handle effective area
if (gammalib::xml_has_par(xml, "EffectiveArea")) {
// Get parameter
const GXmlElement* par = gammalib::xml_get_par(G_READ, xml, "EffectiveArea");
// Get filename
m_xml_aeff = gammalib::strip_whitespace(par->attribute("file"));
// If filename is not empty then load effective area
if (!m_xml_aeff.empty()) {
if (par->has_attribute("extname")) {
// Store HDU name
m_xml_aeff_extname = par->attribute("extname");
// Load effective area with extension attribute
load_aeff(m_xml_aeff, m_xml_aeff_extname);
}
else {
// Load effective area with default extension name
load_aeff(m_xml_aeff);
}
// Optional attributes
double thetacut = 0.0;
double scale = 1.0;
double sigma = 3.0;
// Optionally extract thetacut (0.0 if no thetacut)
if (par->has_attribute("thetacut")) {
thetacut = gammalib::todouble(par->attribute("thetacut"));
}
// Optionally extract scale factor (1.0 if no scale)
if (par->has_attribute("scale")) {
scale = gammalib::todouble(par->attribute("scale"));
}
// Optionally extract sigma (3.0 if no sigma)
if (par->has_attribute("sigma")) {
sigma = gammalib::todouble(par->attribute("sigma"));
}
// If we have an ARF then set attributes
GCTAAeffArf* arf = const_cast<GCTAAeffArf*>(dynamic_cast<const GCTAAeffArf*>(aeff()));
if (arf != NULL) {
arf->thetacut(thetacut);
arf->scale(scale);
arf->sigma(sigma);
}
// If we have a performance table then set attributes
GCTAAeffPerfTable* perf = const_cast<GCTAAeffPerfTable*>(dynamic_cast<const GCTAAeffPerfTable*>(aeff()));
if (perf != NULL) {
perf->sigma(sigma);
}
} // endif: effective area filename was valid
} // endif: handled effective area
// Handle PSF
if (gammalib::xml_has_par(xml, "PointSpreadFunction")) {
// Get parameter
const GXmlElement* par = gammalib::xml_get_par(G_READ, xml, "PointSpreadFunction");
// Get filename
m_xml_psf = gammalib::strip_whitespace(par->attribute("file"));
// If filename is not empty then load point spread function
if (!m_xml_psf.empty()) {
if (par->has_attribute("extname")) {
// Store hdu name
m_xml_psf_extname = par->attribute("extname");
// Load PSF with extension attribute
load_psf(m_xml_psf, m_xml_psf_extname);
}
else {
// Load PSF with default extension name
load_psf(m_xml_psf);
}
} // endif: PSF file name was valid
} // endif: handled PSF
// Handle energy dispersion
if (gammalib::xml_has_par(xml, "EnergyDispersion")) {
// Get parameter
const GXmlElement* par = gammalib::xml_get_par(G_READ, xml, "EnergyDispersion");
// Get filename
m_xml_edisp = gammalib::strip_whitespace(par->attribute("file"));
// If filename is not empty then load energy dispersion
if (!m_xml_edisp.empty()) {
if (par->has_attribute("extname")) {
// Store hdu name
m_xml_edisp_extname = par->attribute("extname");
// Load energy dispersion with extension attribute
load_edisp(m_xml_edisp, m_xml_edisp_extname);
}
else {
// Load energy dispersion with default extension name
load_edisp(m_xml_edisp);
}
} // endif: Edisp file name was valid
} // endif: handled energy dispersion
// Handle Background
if (gammalib::xml_has_par(xml, "Background")) {
// Get parameter
const GXmlElement* par = gammalib::xml_get_par(G_READ, xml, "Background");
// Get filename
m_xml_background = gammalib::strip_whitespace(par->attribute("file"));
// If filename is not empty then load background model
if (!m_xml_background.empty()) {
if (par->has_attribute("extname")) {
// Store hdu name
m_xml_background_extname = par->attribute("extname");
// Load background with extension attribute
load_background(m_xml_background, m_xml_background_extname);
}
else {
// Load background with default extension name
load_background(m_xml_background);
}
} // endif: background file name was valid
// Optional attributes
double sigma = 3.0;
// Optionally extract sigma (3.0 if no sigma)
if (par->has_attribute("sigma")) {
sigma = gammalib::todouble(par->attribute("sigma"));
}
// If we have a performance table then set attributes
GCTABackgroundPerfTable* bgm = const_cast<GCTABackgroundPerfTable*>(dynamic_cast<const GCTABackgroundPerfTable*>(background()));
if (bgm != NULL) {
bgm->sigma(sigma);
}
}
} // endelse: handled components
// If we have an ARF then remove thetacut if necessary
GCTAAeffArf* arf = const_cast<GCTAAeffArf*>(dynamic_cast<const GCTAAeffArf*>(aeff()));
if (arf != NULL) {
if (arf->thetacut() > 0.0) {
arf->remove_thetacut(*this);
}
}
// Return
return;
}
/***********************************************************************//**
* @brief Write response information into XML element
*
* @param[in] xml XML element.
*
* Writes information for a CTA response into an XML element. If the
* calibration database and response name had been specified, the following
* output is written
*
* <observation name="..." id="..." instrument="...">
* ...
* <parameter name="Calibration" database="..." response="..."/>
* </observation>
*
* If even more control was required over the response and individual file
* names were specified, the following output is written
*
* <observation name="..." id="..." instrument="...">
* ...
* <parameter name="EffectiveArea" file="..."/>
* <parameter name="PointSpreadFunction" file="..."/>
* <parameter name="EnergyDispersion" file="..."/>
* <parameter name="Background" file="..."/>
* </observation>
***************************************************************************/
void GCTAResponseIrf::write(GXmlElement& xml) const
{
// Determine number of existing parameter nodes in XML element
//int npars = xml.elements("parameter");
// If we have a calibration database and response name, then set
// the information ...
if (!m_xml_caldb.empty() || !m_xml_rspname.empty()) {
GXmlElement* par = gammalib::xml_need_par(G_WRITE, xml, "Calibration");
par->attribute("database", m_xml_caldb);
par->attribute("response", m_xml_rspname);
}
// ... otherwise add response components if they exist
else {
// Add effective area if it exists
if (aeff() != NULL) {
if (!(m_xml_aeff.empty())) {
// Get pointer to effective area
GXmlElement* par = gammalib::xml_need_par(G_WRITE, xml, "EffectiveArea");
// Initialise attributes
double thetacut = 0.0;
double scale = 1.0;
double sigma = 0.0;
// Get optional ARF attributes
const GCTAAeffArf* arf = dynamic_cast<const GCTAAeffArf*>(aeff());
if (arf != NULL) {
thetacut = arf->thetacut();
scale = arf->scale();
sigma = arf->sigma();
}
// Get optional performance table attributes
const GCTAAeffPerfTable* perf = dynamic_cast<const GCTAAeffPerfTable*>(aeff());
if (perf != NULL) {
sigma = perf->sigma();
}
// Set attributes
par->attribute("file", m_xml_aeff);
if (!(m_xml_aeff_extname.empty())) {
par->attribute("hdu", m_xml_aeff_extname);
}
if (thetacut > 0.0) {
par->attribute("thetacut", gammalib::str(thetacut));
}
if (scale != 1.0) {
par->attribute("scale", gammalib::str(scale));
}
if (sigma > 0.0) {
par->attribute("sigma", gammalib::str(sigma));
}
}
}
// Add PSF if it exists
if (psf() != NULL) {
if (!(m_xml_psf.empty())) {
GXmlElement* par = gammalib::xml_need_par(G_WRITE, xml, "PointSpreadFunction");
par->attribute("file", m_xml_psf);
if (!m_xml_psf_extname.empty()) {
par->attribute("hdu", m_xml_psf_extname);
}
}
}
// Add Edisp if it exists
if (edisp() != NULL) {
if (!(m_xml_edisp.empty())) {
GXmlElement* par = gammalib::xml_need_par(G_WRITE, xml, "EnergyDispersion");
par->attribute("file", m_xml_edisp);
if (!m_xml_edisp_extname.empty()) {
par->attribute("hdu", m_xml_edisp_extname);
}
}
}
// Add background if it exists
if (background() != NULL) {
if (!(m_xml_background.empty())) {
GXmlElement* par = gammalib::xml_need_par(G_WRITE, xml, "Background");
par->attribute("file", m_xml_background);
if (!m_xml_background_extname.empty()) {
par->attribute("hdu", m_xml_background_extname);
}
}
}
} // endelse: response components added
// Return
return;
}
/***********************************************************************//**
* @brief Load CTA response
*
* @param[in] rspname CTA response name.
*
* Loads the CTA response with specified name @p rspname. The method first
* searchs for an appropriate response in the calibration database. If no
* appropriate response is found, the method takes the database root path
* and response name to build the full path to the response file, and tries
* to load the response from these paths.
***************************************************************************/
void GCTAResponseIrf::load(const std::string& rspname)
{
// Clear instance but conserve calibration database
GCaldb caldb = m_caldb;
clear();
m_caldb = caldb;
// First attempt reading the response using the GCaldb interface
std::string expr = "NAME("+rspname+")";
std::string aeffname = m_caldb.filename("","","EFF_AREA","","",expr);
std::string psfname = m_caldb.filename("","","RPSF","","",expr);
std::string edispname = m_caldb.filename("","","EDISP","","",expr);
std::string bgdname = m_caldb.filename("","","BGD","","",expr);
// If filenames are empty then build filenames from CALDB root path and
// response name
if (aeffname.length() < 1) {
aeffname = irf_filename(gammalib::filepath(m_caldb.rootdir(), rspname));
}
if (psfname.length() < 1) {
psfname = irf_filename(gammalib::filepath(m_caldb.rootdir(), rspname));
}
if (edispname.length() < 1) {
edispname = irf_filename(gammalib::filepath(m_caldb.rootdir(), rspname));
}
if (bgdname.length() < 1) {
bgdname = irf_filename(gammalib::filepath(m_caldb.rootdir(), rspname));
}
// Load effective area
load_aeff(aeffname);
// Load point spread function
load_psf(psfname);
// Load energy dispersion
load_edisp(edispname);
// Load background
load_background(bgdname);
// Remove theta cut
GCTAAeffArf* arf = const_cast<GCTAAeffArf*>(dynamic_cast<const GCTAAeffArf*>(m_aeff));
if (arf != NULL) {
arf->remove_thetacut(*this);
}
// Store response name
m_rspname = rspname;
// Return
return;
}
/***********************************************************************//**
* @brief Load effective area
*
* @param[in] filename Effective area filename.
*
* @exception GException::file_error
* File not found.
*
* Loads the effective area from a response file. If the file is a FITS file
* the method first checks whether it contains an "EFFECTIVE AREA" extension.
* If such an extension is found, a GCTAAeff2D effective area will be
* allocated. Otherwise, the method checks whether the FITS file contains
* a "SPECRESP" extension, and if this is the case, the method will allocate
* a GCTAAeffArf effective area object. In both cases, the file will
* extract the optional "LO_THRES" and "HI_THRES" save energy thresholds
* from the FITS file header. If the file is not a FITS file, it will be
* interpreted as a GCTAAeffPerfTable performance table.
***************************************************************************/
void GCTAResponseIrf::load_aeff(const std::string& filename, const std::string& extname)
{
// Free any existing effective area instance
if (m_aeff != NULL) delete m_aeff;
m_aeff = NULL;
// Check for existence of file
if (!gammalib::file_exists_gzip(filename)) {
std::string msg = "File \""+filename+"\" not found. Please specify "
"a valid effective area response file.";
throw GException::file_error(G_LOAD_AEFF, msg);
}
// If file is a FITS file ...
if (gammalib::is_fits(filename)) {
// Open FITS file
GFits file(filename);
// Get HDU
const GFitsTable& table = *file.table(extname);
// Read save energy thresholds if available
if (table.has_card("LO_THRES")) {
m_lo_save_thres = table.real("LO_THRES");
}
if (table.has_card("HI_THRES")) {
m_hi_save_thres = table.real("HI_THRES");
}
// Load as Arf if "SPECRESP" column is found
if (table.contains("SPECRESP")) {
// Close file
file.close();
// Try to load as Arf
m_aeff = new GCTAAeffArf(filename, extname);
} // endif: SPECRESP was present
else {
// Close file
file.close();
// Read effective area 2D
m_aeff = new GCTAAeff2D(filename , extname);
}
} // endif: file was FITS file
// ... otherwise handle ASCII performance tables
else {
// Allocate a performance table
m_aeff = new GCTAAeffPerfTable(filename);
}
// Return
return;
}
/***********************************************************************//**
* @brief Load CTA PSF vector
*
* @param[in] filename FITS file name.
*
* @exception GException::file_error
* File not found.
*
* Loads the point spead function from a response file. If the file is a
* FITS file, the method first checks whether it contains a
* "POINT SPREAD FUNCTION" extension. If such an extension is found,
* either a GCTAPsfKing or a GCTAPsf2D point spread function will be
* allocated depending on the column names that are found in the extension.
* If the "POINT SPREAD FUNCTION" extension is not found, the FITS file will
* be interpreted as a GCTAPsfVector point spread function. If the file is
* not a FITS file, it will be interpreted as a GCTAPsfPerfTable performance
* table.
***************************************************************************/
void GCTAResponseIrf::load_psf(const std::string& filename, const std::string& extname)
{
// Free any existing point spread function instance
if (m_psf != NULL) delete m_psf;
m_psf = NULL;
// Check for existence of file
if (!gammalib::file_exists_gzip(filename)) {
std::string msg = "File \""+filename+"\" not found. Please specify "
"a valid point spread function response file.";
throw GException::file_error(G_LOAD_PSF, msg);
}
// If file is a FITS file ...
if (gammalib::is_fits(filename)) {
// Open FITS file
GFits file(filename);
const GFitsTable& table = *file.table(extname);
if (table.contains("GAMMA") && table.contains("SIGMA")) {
file.close();
m_psf = new GCTAPsfKing(filename, extname);
}
else if (table.contains("SCALE") && table.contains("SIGMA_1") &&
table.contains("AMPL_2") && table.contains("SIGMA_2") &&
table.contains("AMPL_3") && table.contains("SIGMA_3")) {
file.close();
m_psf = new GCTAPsf2D(filename, extname);
}
else {
file.close();
m_psf = new GCTAPsfVector(filename);
}
} // endif: file was FITS file
// ... otherwise load file as a performance table
else {
// Allocate a performance table
m_psf = new GCTAPsfPerfTable(filename);
}
// Return
return;
}
/***********************************************************************//**
* @brief Load energy dispersion information
*
* @param[in] filename Energy dispersion file name.
*
* @exception GException::file_error
* File not found.
*
* Loads the energy dispersion from a response file. If the file is a FITS
* file, the method first checks whether it contains a "ENERGY DISPERSION"
* extension. If such an extension is found, a GCTAEdisp2D energy dispersion
* is allocated on the basis of the information found in the file. If the
* "ENERGY DISPERSION" extension is not found, the FITS file will be
* interpreted as a GCTAEdispRmf energy dispersion. If the file is not a
* FITS file, it will be interpreted as a GCTAEdispPerfTable performance
* table.
***************************************************************************/
void GCTAResponseIrf::load_edisp(const std::string& filename, const std::string& extname)
{
// Free any existing energy dispersion instance
if (m_edisp != NULL) delete m_edisp;
m_edisp = NULL;
// Check for existence of file
if (!gammalib::file_exists_gzip(filename)) {
std::string msg = "File \""+filename+"\" not found. Please specify "
"a valid energy dispersion response file.";
throw GException::file_error(G_LOAD_EDISP, msg);
}
// If file is a FITS file ...
if (gammalib::is_fits(filename)) {
// Open FITS file
GFits file(filename);
const GFitsTable& table = *file.table(extname);
if (table.contains("MIGRA_LO") && table.contains("MIGRA_HI")) {
file.close();
m_edisp = new GCTAEdisp2D(filename, extname);
}
// ... otherwise load it as RMF
else {
file.close();
m_edisp = new GCTAEdispRmf(filename, extname);
}
} // endif: file was FITS file
// ... otherwise load file as a performance table
else {
// Allocate a performance table
m_edisp = new GCTAEdispPerfTable(filename);
}
// Return
return;
}
/***********************************************************************//**
* @brief Load background model
*
* @param[in] filename Background model file name.
*
* @exception GException::file_error
* File not found.
*
* Loads the background model from a response file. If the file is a FITS
* file the method allocates a GCTABackground3D response and loads the
* information from the FITS file. If the file is not a FITS file it will
* be interpreted as a GCTABackgroundPerfTable performance table.
***************************************************************************/
void GCTAResponseIrf::load_background(const std::string& filename, const std::string& extname)
{
// Free any existing background model instance
if (m_background != NULL) delete m_background;
m_background = NULL;
// Check for existence of file
if (!gammalib::file_exists_gzip(filename)) {
std::string msg = "File \""+filename+"\" not found. Please specify "
"a valid background response file.";
throw GException::file_error(G_LOAD_BACKGROUND, msg);
}
// If file is a FITS file than load background as 3D background
if (gammalib::is_fits(filename)) {
m_background = new GCTABackground3D(filename, extname);
}
// ... otherwise load background as performance table
else {
m_background = new GCTABackgroundPerfTable(filename);
}
// Return
return;
}
/***********************************************************************//**
* @brief Set offset angle dependence (degrees)
*
* @param[in] sigma Offset angle dependence value (degrees).
*
* Set the offset angle dependence for 1D effective area functions. The
* method set the sigma value in case that the effective area function
* is of type GCTAAeffArf or GCTAAeffPerfTable. Otherwise, nothing will
* be done.
***************************************************************************/
void GCTAResponseIrf::offset_sigma(const double& sigma)
{
// If effective area is an ARF then set offset angle
GCTAAeffArf* arf = dynamic_cast<GCTAAeffArf*>(m_aeff);
if (arf != NULL) {
arf->sigma(sigma);
}
// If effective area is a performance table then set offset angle
GCTAAeffPerfTable* prf = dynamic_cast<GCTAAeffPerfTable*>(m_aeff);
if (prf != NULL) {
prf->sigma(sigma);
}
// Return
return;
}
/***********************************************************************//**
* @brief Return offset angle dependence (degrees)
*
* @return Offset angle dependence value (degrees).
*
* Return the offset angle dependence for 1D effective area functions. The
* method returns the sigma value in case that the effective area function
* is of type GCTAAeffArf or GCTAAeffPerfTable. Otherwise, 0.0 will be
* returned.
***************************************************************************/
double GCTAResponseIrf::offset_sigma(void) const
{
// Initialise value
double sigma = 0.0;
// If effective area is an ARF then get offset angle
GCTAAeffArf* arf = dynamic_cast<GCTAAeffArf*>(m_aeff);
if (arf != NULL) {
sigma = arf->sigma();
}
// If effective area is a performance table then get offset angle
GCTAAeffPerfTable* prf = dynamic_cast<GCTAAeffPerfTable*>(m_aeff);
if (prf != NULL) {
sigma = prf->sigma();
}
// Return sigma
return sigma;
}
/***********************************************************************//**
* @brief Print CTA response information
*
* @param[in] chatter Chattiness (defaults to NORMAL).
* @return String containing CTA response information.
***************************************************************************/
std::string GCTAResponseIrf::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("=== GCTAResponseIrf ===");
// Append response information
result.append("\n"+gammalib::parformat("Caldb mission")+m_caldb.mission());
result.append("\n"+gammalib::parformat("Caldb instrument")+m_caldb.instrument());
result.append("\n"+gammalib::parformat("Response name")+m_rspname);
result.append("\n"+gammalib::parformat("Energy dispersion"));
if (use_edisp()) {
result.append("Used");
}
else {
if (apply_edisp()) {
result.append("Not available");
}
else {
result.append("Not used");
}
}
// Append save energy threshold information
result.append("\n"+gammalib::parformat("Save energy range"));
if (m_lo_save_thres > 0.0 && m_hi_save_thres) {
result.append(gammalib::str(m_lo_save_thres));
result.append(" - ");
result.append(gammalib::str(m_hi_save_thres));
result.append(" TeV");
}
else if (m_lo_save_thres > 0.0) {
result.append("> ");
result.append(gammalib::str(m_lo_save_thres));
result.append(" TeV");
}
else if (m_hi_save_thres > 0.0) {
result.append("< ");
result.append(gammalib::str(m_hi_save_thres));
result.append(" TeV");
}
else {
result.append("undefined");
}
// Append detailed information
GChatter reduced_chatter = gammalib::reduce(chatter);
if (reduced_chatter > SILENT) {
// Append calibration database
result.append("\n"+m_caldb.print(reduced_chatter));
// Append effective area information
if (m_aeff != NULL) {
result.append("\n"+m_aeff->print(reduced_chatter));
}
// Append point spread function information
if (m_psf != NULL) {
result.append("\n"+m_psf->print(reduced_chatter));
}
// Append energy dispersion information
if (m_edisp != NULL) {
result.append("\n"+m_edisp->print(reduced_chatter));
}
// Append background information
if (m_background != NULL) {
result.append("\n"+m_background->print(reduced_chatter));
}
}
// EXPLICIT: Append Npred cache information
if (chatter >= EXPLICIT) {
if (!m_npred_names.empty()) {
for (int i = 0; i < m_npred_names.size(); ++i) {
result.append("\n"+gammalib::parformat("Npred cache " +
gammalib::str(i)));
result.append(m_npred_names[i]+", ");
result.append(m_npred_energies[i].print()+", ");
result.append(m_npred_times[i].print()+" = ");
result.append(gammalib::str(m_npred_values[i]));
}
}
} // endif: chatter was explicit
} // endif: chatter was not silent
// Return result
return result;
}
/*==========================================================================
= =
= Low-level CTA response methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Return effective area (in units of cm2)
*
* @param[in] theta Radial offset angle of photon in camera (radians).
* @param[in] phi Polar angle of photon in camera (radians).
* @param[in] zenith Zenith angle of telescope pointing (radians).
* @param[in] azimuth Azimuth angle of telescope pointing (radians).
* @param[in] srcLogEng Log10 of true photon energy (E/TeV).
* @return Effective area in units fo cm2.
*
* @exception GException::invalid_value
* No effective area information found.
*
* Returns the effective area as function of the true photon position in the
* camera system and the telescope pointing direction in the Earth system.
***************************************************************************/
double GCTAResponseIrf::aeff(const double& theta,
const double& phi,
const double& zenith,
const double& azimuth,
const double& srcLogEng) const
{
// Throw an exception if instrument response is not defined
if (m_aeff == NULL) {
std::string msg = "No effective area information found in response.\n"
"Please make sure that the instrument response is"
" properly defined.";
throw GException::invalid_value(G_AEFF, msg);
}
// Get effective area
double aeff = (*m_aeff)(srcLogEng, theta, phi, zenith, azimuth);
// Return effective area
return aeff;
}
/***********************************************************************//**
* @brief Return point spread function (in units of sr^-1)
*
* @param[in] delta Angular separation between true and measured photon
* directions (radians).
* @param[in] theta Radial offset angle of photon in camera (radians).
* @param[in] phi Polar angle of photon in camera (radians).
* @param[in] zenith Zenith angle of telescope pointing (radians).
* @param[in] azimuth Azimuth angle of telescope pointing (radians).
* @param[in] srcLogEng Log10 of true photon energy (E/TeV).
*
* @exception GException::invalid_value
* No point spread function information found.
*
* Returns the point spread function for a given offset angle as function
* of the true photon position in the camera system and the telescope
* pointing direction in the Earth system.
***************************************************************************/
double GCTAResponseIrf::psf(const double& delta,
const double& theta,
const double& phi,
const double& zenith,
const double& azimuth,
const double& srcLogEng) const
{
// Throw an exception if instrument response is not defined
if (m_psf == NULL) {
std::string msg = "No point spread function information found in"
" response.\n"
"Please make sure that the instrument response is"
" properly defined.";
throw GException::invalid_value(G_PSF, msg);
}
// Compute PSF
double psf = (*m_psf)(delta, srcLogEng, theta, phi, zenith, azimuth);
// Return PSF
return psf;
}
/***********************************************************************//**
* @brief Return maximum angular separation (in radians)
*
* @param[in] theta Radial offset angle in camera (radians).
* @param[in] phi Polar angle in camera (radians).
* @param[in] zenith Zenith angle of telescope pointing (radians).
* @param[in] azimuth Azimuth angle of telescope pointing (radians).
* @param[in] srcLogEng Log10 of true photon energy (E/TeV).
*
* @exception GException::invalid_value
* No point spread function information found.
*
* This method returns the maximum angular separation between true and
* measured photon directions for which the PSF is non zero as function
* of the true photon position in the camera system and the telescope
* pointing direction in the Earth system.
***************************************************************************/
double GCTAResponseIrf::psf_delta_max(const double& theta,
const double& phi,
const double& zenith,
const double& azimuth,
const double& srcLogEng) const
{
// Throw an exception if instrument response is not defined
if (m_psf == NULL) {
std::string msg = "No point spread function information found in"
" response.\n"
"Please make sure that the instrument response is"
" properly defined.";
throw GException::invalid_value(G_PSF_DELTA_MAX, msg);
}
// Compute PSF
double delta_max = m_psf->delta_max(srcLogEng, theta, phi, zenith, azimuth);
// Return PSF
return delta_max;
}
/***********************************************************************//**
* @brief Return energy dispersion (in units or MeV^-1)
*
* @param[in] obsEng Measured event energy.
* @param[in] theta Radial offset angle in camera (radians).
* @param[in] phi Polar angle in camera (radians).
* @param[in] zenith Zenith angle of telescope pointing (radians).
* @param[in] azimuth Azimuth angle of telescope pointing (radians).
* @param[in] srcLogEng Log10 of true photon energy (E/TeV).
***************************************************************************/
double GCTAResponseIrf::edisp(const GEnergy& obsEng,
const double& theta,
const double& phi,
const double& zenith,
const double& azimuth,
const double& srcLogEng) const
{
// Compute log10 energy in TeV and linear energy in MeV
double obsLogEng = obsEng.log10TeV();
double energy = obsEng.MeV();
// Compute energy dispersion
double edisp = (*m_edisp)(obsLogEng, srcLogEng, theta, phi, zenith, azimuth) /
(gammalib::ln10 * energy);
// Return energy dispersion
return edisp;
}
/***********************************************************************//**
* @brief Return spatial integral of sky model
*
* @param[in] model Sky Model.
* @param[in] srcEng True photon energy.
* @param[in] srcTime True photon arrival time.
* @param[in] obsEng Observed event energy.
* @param[in] obsTime Observed event arrival time.
* @param[in] obs Observation.
*
* Computes the integral
*
* \f[
* N_{\rm ROI}(E',t'|E,t) = \int_{\rm ROI} P(p',E',t'|E,t) dp'
* \f]
*
* of
*
* \f[
* P(p',E',t'|E,t) = \int
* S(p,E,t) \times R(p',E',t'|p,E,t) \, dp
* \f]
*
* over the Region of Interest (ROI) for a sky model \f$S(p,E,t)\f$ and the
* response function \f$R(p',E',t'|p,E,t)\f$.
***************************************************************************/
double GCTAResponseIrf::nroi(const GModelSky& model,
const GEnergy& srcEng,
const GTime& srcTime,
const GEnergy& obsEng,
const GTime& obsTime,
const GObservation& obs) const
{
// Initialise response value
double nroi = 0.0;
// Select method depending on the spatial model type
switch (model.spatial()->code()) {
case GMODEL_SPATIAL_POINT_SOURCE:
nroi = nroi_ptsrc(model, srcEng, srcTime, obsEng, obsTime, obs);
break;
case GMODEL_SPATIAL_RADIAL:
nroi = nroi_radial(model, srcEng, srcTime, obsEng, obsTime, obs);
break;
case GMODEL_SPATIAL_ELLIPTICAL:
nroi = nroi_elliptical(model, srcEng, srcTime, obsEng, obsTime, obs);
break;
case GMODEL_SPATIAL_DIFFUSE:
nroi = nroi_diffuse(model, srcEng, srcTime, obsEng, obsTime, obs);
break;
default:
break;
}
// Return response value
return nroi;
}
/***********************************************************************//**
* @brief Return spatial integral of Instrument Response Function
*
* @param[in] photon Photon.
* @param[in] obsEng Observed event energy.
* @param[in] obsTime Observed event time.
* @param[in] obs Observation.
*
* Computes the integral of the instrument response function over the Region
* of Interest
*
* \f[
* R(E',t'|p,E,t) = \int_{\rm ROI} R(p',E',t'|p,E,t) dp'
* \f]
***************************************************************************/
double GCTAResponseIrf::nirf(const GPhoton& photon,
const GEnergy& obsEng,
const GTime& obsTime,
const GObservation& obs) const
{
// Retrieve CTA observation, ROI and pointing
const GCTAObservation& cta = retrieve_obs(G_NIRF, obs);
const GCTARoi& roi = retrieve_roi(G_NIRF, obs);
const GCTAPointing& pnt = cta.pointing();
// Get photon attributes
const GSkyDir& srcDir = photon.dir();
const GEnergy& srcEng = photon.energy();
const GTime& srcTime = photon.time();
// Get pointing direction zenith angle and azimuth [radians]
double zenith = pnt.zenith();
double azimuth = pnt.azimuth();
// Get radial offset and polar angles of true photon in camera [radians]
double theta = pnt.dir().dist(srcDir);
double phi = 0.0; //TODO: Implement Phi dependence
// Get log10(E/TeV) of true photon energy.
double srcLogEng = srcEng.log10TeV();
// Get effectve area components
double nroi = aeff(theta, phi, zenith, azimuth, srcLogEng);
// Multiply-in PSF
if (nroi > 0.0) {
// Get PSF
nroi *= npsf(srcDir, srcLogEng, srcTime, pnt, roi);
// Multiply-in energy dispersion
if (use_edisp() && nroi > 0.0) {
// Multiply-in energy dispersion
nroi *= edisp(obsEng, theta, phi, zenith, azimuth, srcLogEng);
} // endif: had energy dispersion
// Apply deadtime correction
nroi *= obs.deadc(srcTime);
} // endif: had non-zero effective area
// Compile option: Check for NaN/Inf
#if defined(G_NAN_CHECK)
if (gammalib::is_notanumber(nroi) || gammalib::is_infinite(nroi)) {
std::cout << "*** ERROR: GCTAResponseIrf::nroi:";
std::cout << " NaN/Inf encountered";
std::cout << " (nroi=" << nroi;
std::cout << ", theta=" << theta;
std::cout << ", phi=" << phi << ")";
std::cout << std::endl;
}
#endif
// Return Nroi
return nroi;
}
/***********************************************************************//**
* @brief Return result of PSF integration over ROI.
*
* @param[in] srcDir True photon direction.
* @param[in] srcLogEng Log10 of true photon energy (E/TeV).
* @param[in] srcTime True photon arrival time (not used).
* @param[in] pnt CTA pointing.
* @param[in] roi CTA region of interest.
*
* This method integrates the PSF over the circular region of interest (ROI).
* Integration is done in a polar coordinate system centred on the PSF since
* the PSF is assumed to be azimuthally symmetric. The polar integration is
* done using the method npsf_kern_rad_azsym() that computes analytically
* the arclength that is comprised within the ROI.
*
* Note that the integration is only performed when the PSF is spilling out
* of the ROI border, otherwise the integral is simply 1. Numerical
* integration is done using the standard Romberg method. The integration
* boundaries are computed so that only the PSF section that falls in the ROI
* is considered.
*
* @todo Enhance romberg() integration method for small integration regions
* (see comment about kluge below)
* @todo Implement phi dependence in camera system
***************************************************************************/
double GCTAResponseIrf::npsf(const GSkyDir& srcDir,
const double& srcLogEng,
const GTime& srcTime,
const GCTAPointing& pnt,
const GCTARoi& roi) const
{
// Set number of iterations for Romberg integration.
static const int iter = 6;
// Declare result
double value = 0.0;
// Get pointing direction zenith angle and azimuth [radians]
double zenith = pnt.zenith();
double azimuth = pnt.azimuth();
// Compute offset angle of source direction in camera system
double theta = pnt.dir().dist(srcDir);
// Compute azimuth angle of source direction in camera system
double phi = 0.0; //TODO: Implement phi dependence
// Extract relevant parameters from arguments
double roi_radius = roi.radius() * gammalib::deg2rad;
double roi_psf_distance = roi.centre().dir().dist(srcDir);
double rmax = psf_delta_max(theta, phi, zenith, azimuth, srcLogEng);
// If PSF is fully enclosed by the ROI then skip the numerical
// integration and assume that the integral is 1.0
if (roi_psf_distance + rmax <= roi_radius) {
value = 1.0;
}
// ... otherwise perform numerical integration
else {
// Compute minimum PSF integration radius
double rmin = (roi_psf_distance > roi_radius)
? roi_psf_distance - roi_radius : 0.0;
// Continue only if integration range is valid
if (rmax > rmin) {
// Setup integration kernel
cta_npsf_kern_rad_azsym integrand(this,
roi_radius,
roi_psf_distance,
srcLogEng,
theta,
phi,
zenith,
azimuth);
// Setup integration
GIntegral integral(&integrand);
// Set fixed number of iterations
integral.fixed_iter(iter);
// Radially integrate PSF. In case that the radial integration
// region is small, we do the integration using a simple
// trapezoidal rule. This is a kluge to prevent convergence
// problems in the romberg() method for small integration intervals.
// Ideally, the romberg() method should be enhanced to handle this
// case automatically. The kluge threshold was fixed manually!
if (rmax-rmin < 1.0e-12) {
value = integral.trapzd(rmin, rmax);
}
else {
value = integral.romberg(rmin, rmax);
}
// Compile option: Check for NaN/Inf
#if defined(G_NAN_CHECK)
if (gammalib::is_notanumber(value) || gammalib::is_infinite(value)) {
std::cout << "*** ERROR: GCTAResponseIrf::npsf:";
std::cout << " NaN/Inf encountered";
std::cout << " (value=" << value;
std::cout << ", roi_radius=" << roi_radius;
std::cout << ", roi_psf_distance=" << roi_psf_distance;
//std::cout << ", sigma=" << sigma;
std::cout << ", r=[" << rmin << "," << rmax << "])";
std::cout << std::endl;
}
#endif
} // endif: integration range was valid
} // endelse: numerical integration required
// Return integrated PSF
return value;
}
/*==========================================================================
= =
= Private methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Initialise class members
***************************************************************************/
void GCTAResponseIrf::init_members(void)
{
// Initialise members
m_caldb.clear();
m_rspname.clear();
m_aeff = NULL;
m_psf = NULL;
m_edisp = NULL;
m_background = NULL;
m_apply_edisp = false; //!< Switched off by default
m_lo_save_thres = 0.0;
m_hi_save_thres = 0.0;
// XML response filenames
m_xml_caldb.clear();
m_xml_rspname.clear();
m_xml_aeff.clear();
m_xml_psf.clear();
m_xml_edisp.clear();
m_xml_background.clear();
m_xml_aeff_extname.clear();
m_xml_psf_extname.clear();
m_xml_edisp_extname.clear();
m_xml_background_extname.clear();
// Initialise Npred cache
m_npred_names.clear();
m_npred_energies.clear();
m_npred_times.clear();
m_npred_values.clear();
// Return
return;
}
/***********************************************************************//**
* @brief Copy class members
*
* @param[in] rsp Response to be copied
***************************************************************************/
void GCTAResponseIrf::copy_members(const GCTAResponseIrf& rsp)
{
// Copy members
m_caldb = rsp.m_caldb;
m_rspname = rsp.m_rspname;
m_apply_edisp = rsp.m_apply_edisp;
m_lo_save_thres = rsp.m_lo_save_thres;
m_hi_save_thres = rsp.m_hi_save_thres;
// Copy response filenames
m_xml_caldb = rsp.m_xml_caldb;
m_xml_rspname = rsp.m_xml_rspname;
m_xml_aeff = rsp.m_xml_aeff;
m_xml_psf = rsp.m_xml_psf;
m_xml_edisp = rsp.m_xml_edisp;
m_xml_background = rsp.m_xml_background;
m_xml_aeff_extname = rsp.m_xml_aeff_extname;
m_xml_psf_extname = rsp.m_xml_psf_extname;
m_xml_edisp_extname = rsp.m_xml_edisp_extname;
m_xml_background_extname = rsp.m_xml_background_extname;
// Copy cache
m_npred_names = rsp.m_npred_names;
m_npred_energies = rsp.m_npred_energies;
m_npred_times = rsp.m_npred_times;
m_npred_values = rsp.m_npred_values;
// Clone members
m_aeff = (rsp.m_aeff != NULL) ? rsp.m_aeff->clone() : NULL;
m_psf = (rsp.m_psf != NULL) ? rsp.m_psf->clone() : NULL;
m_edisp = (rsp.m_edisp != NULL) ? rsp.m_edisp->clone() : NULL;
m_background = (rsp.m_background != NULL) ? rsp.m_background->clone() : NULL;
// Return
return;
}
/***********************************************************************//**
* @brief Delete class members
***************************************************************************/
void GCTAResponseIrf::free_members(void)
{
// Free memory
if (m_aeff != NULL) delete m_aeff;
if (m_psf != NULL) delete m_psf;
if (m_edisp != NULL) delete m_edisp;
if (m_background != NULL) delete m_background;
// Initialise pointers
m_aeff = NULL;
m_psf = NULL;
m_edisp = NULL;
m_background = NULL;
// Return
return;
}
/***********************************************************************//**
* @brief Return filename with appropriate extension
*
* @param[in] filename File name.
* @return File name.
*
* Checks if the specified @p filename exists, and if not, checks whether a
* file with the added suffix .dat exists. Returns the file name with the
* appropriate extension.
***************************************************************************/
std::string GCTAResponseIrf::irf_filename(const std::string& filename) const
{
// Set input filename as result filename
std::string result = filename;
// If file does not exist then try a variant with extension .dat
if (!gammalib::file_exists(result)) {
std::string testname = result + ".dat";
if (gammalib::file_exists(testname)) {
result = testname;
}
}
// Return result
return result;
}
/***********************************************************************//**
* @brief Return value of point source instrument response function
*
* @param[in] event Observed event.
* @param[in] source Source.
* @param[in] obs Observation.
* @return Value of instrument response function for a point source.
*
* This method returns the value of the instrument response function for a
* point source. The method assumes that source.model() is of type
* GModelSpatialPointSource.
***************************************************************************/
double GCTAResponseIrf::irf_ptsrc(const GEvent& event,
const GSource& source,
const GObservation& obs) const
{
// Get point source spatial model
const GModelSpatialPointSource* src =
static_cast<const GModelSpatialPointSource*>(source.model());
// Set Photon
GPhoton photon(src->dir(), source.energy(), source.time());
// Compute IRF
double irf = this->irf(event, photon, obs);
// Return IRF
return irf;
}
/***********************************************************************//**
* @brief Return IRF value for radial source model
*
* @param[in] event Observed event.
* @param[in] source Source.
* @param[in] obs Observation.
*
* @exception GCTAException::bad_model_type
* Model is not a radial model.
*
* Integrates the product of the spatial model and the instrument response
* function over the true photon arrival direction using
*
* \f[
* \int_{\rho_{\rm min}}^{\rho_{\rm max}}
* \sin \rho \times S_{\rm p}(\rho | E, t) \times
* \int_{\omega_{\rm min}}^{\omega_{\rm max}}
* {\rm Irf}(\rho, \omega) d\omega d\rho
* \f]
*
* where
* \f$S_{\rm p}(\rho | E, t)\f$ is the radial spatial model,
* \f${\rm Irf}(\rho, \omega)\f$ is the instrument response function,
* \f$\rho\f$ is the radial distance from the model centre, and
* \f$\omega\f$ is the position angle with respect to the connecting line
* between the model centre and the observed photon arrival direction.
*
* The integration is performed in the coordinate system of the source
* model spanned by \f$\rho\f$ and \f$\omega\f$ which allows to benefit
* from the symmetry of the source model.
*
* The source centre is located at \f$\vec{m}\f$, and a spherical system
* is defined around this location with \f$(\omega,\rho)\f$ being the
* azimuth and zenith angles, respectively. \f$\omega=0\f$ is defined
* by the direction that connects the source centre \f$\vec{m}\f$ to the
* measured photon direction \f$\vec{p'}\f$, and \f$\omega\f$ increases
* counterclockwise.
*
* Note that this method approximates the true theta angle (angle between
* incident photon and pointing direction) by the measured theta angle
* (angle between the measured photon arrival direction and the pointing
* direction). Given the slow variation of the Psf shape over the field of
* view, this approximation should be fine. It helps in fact a lot in
* speeding up the computations.
***************************************************************************/
double GCTAResponseIrf::irf_radial(const GEvent& event,
const GSource& source,
const GObservation& obs) const
{
// Retrieve CTA pointing
const GCTAPointing& pnt = retrieve_pnt(G_IRF_RADIAL, obs);
const GCTAInstDir& dir = retrieve_dir(G_IRF_RADIAL, event);
// Get pointer on radial model
const GModelSpatialRadial* model =
dynamic_cast<const GModelSpatialRadial*>(source.model());
if (model == NULL) {
throw GCTAException::bad_model_type(G_IRF_RADIAL);
}
// Get pointer on shell model (will be NULL for other models)
const GModelSpatialRadialShell* shell =
dynamic_cast<const GModelSpatialRadialShell*>(model);
// Set number of iterations for Romberg integration.
// These values have been determined after careful testing, see
// https://cta-redmine.irap.omp.eu/issues/1299
// https://cta-redmine.irap.omp.eu/issues/1521
// Unless we have a shell model the number of iterations is set
// to 5. Only for a shell model we used an increased number of
// iterations to cover the case of a shell that has a width
// comparable to the angular resolution of CTA.
int iter_rho = 5;
int iter_phi = 5;
if (shell != NULL) {
iter_rho = 6;
iter_phi = 6;
}
// Get event attributes
const GSkyDir& obsDir = dir.dir();
const GEnergy& obsEng = event.energy();
// Get source attributes
const GSkyDir& centre = model->dir();
const GEnergy& srcEng = source.energy();
const GTime& srcTime = source.time();
// Get pointing direction zenith angle and azimuth [radians]
double zenith = pnt.zenith();
double azimuth = pnt.azimuth();
// Determine angular distance between measured photon direction and model
// centre [radians]
double zeta = centre.dist(obsDir);
// Determine angular distance between measured photon direction and
// pointing direction [radians]
double eta = pnt.dir().dist(obsDir);
// Determine angular distance between model centre and pointing direction
// [radians]
double lambda = centre.dist(pnt.dir());
// Compute azimuth angle of pointing in model system [radians]
// Will be comprised in interval [0,pi]
double omega0 = 0.0;
double denom = std::sin(lambda) * std::sin(zeta);
if (denom != 0.0) {
double arg = (std::cos(eta) - std::cos(lambda) * std::cos(zeta))/denom;
omega0 = gammalib::acos(arg);
}
// Get log10(E/TeV) of true photon energy
double srcLogEng = srcEng.log10TeV();
// Assign the observed theta angle (eta) as the true theta angle
// between the source and the pointing directions. This is a (not
// too bad) approximation which helps to speed up computations.
// If we want to do this correctly, however, we would need to move
// the psf_dummy_sigma down to the integration kernel, and we would
// need to make sure that psf_delta_max really gives the absolute
// maximum (this is certainly less critical)
double theta = eta;
double phi = 0.0; //TODO: Implement IRF Phi dependence
// Get maximum PSF and source radius in radians.
double delta_max = psf_delta_max(theta, phi, zenith, azimuth, srcLogEng);
double src_max = model->theta_max();
// Set radial model zenith angle range
double rho_min = (zeta > delta_max) ? zeta - delta_max : 0.0;
double rho_max = zeta + delta_max;
if (rho_max > src_max) {
rho_max = src_max;
}
// Initialise IRF value
double irf = 0.0;
// Perform zenith angle integration if interval is valid
if (rho_max > rho_min) {
// Setup integration kernel
cta_irf_radial_kern_rho integrand(this,
model,
zenith,
azimuth,
srcEng,
srcTime,
srcLogEng,
obsEng,
zeta,
lambda,
omega0,
delta_max,
iter_phi);
// Integrate over model's zenith angle
GIntegral integral(&integrand);
integral.fixed_iter(iter_rho);
// Setup integration boundaries
std::vector<double> bounds;
bounds.push_back(rho_min);
bounds.push_back(rho_max);
// If the integration range includes a transition between full
// containment of model within Psf and partial containment, then
// add a boundary at this location
double transition_point = delta_max - zeta;
if (transition_point > rho_min && transition_point < rho_max) {
bounds.push_back(transition_point);
}
// If we have a shell model then add an integration boundary for the
// shell radius as a function discontinuity will occur at this
// location
if (shell != NULL) {
double shell_radius = shell->radius() * gammalib::deg2rad;
if (shell_radius > rho_min && shell_radius < rho_max) {
bounds.push_back(shell_radius);
}
}
// Integrate kernel
irf = integral.romberg(bounds, iter_rho);
// Compile option: Check for NaN/Inf
#if defined(G_NAN_CHECK)
if (gammalib::is_notanumber(irf) || gammalib::is_infinite(irf)) {
std::cout << "*** ERROR: GCTAResponseIrf::irf_radial:";
std::cout << " NaN/Inf encountered";
std::cout << " (irf=" << irf;
std::cout << ", rho_min=" << rho_min;
std::cout << ", rho_max=" << rho_max;
std::cout << ", omega0=" << omega0 << ")";
std::cout << std::endl;
}
#endif
// Apply deadtime correction
irf *= obs.deadc(srcTime);
} // endif: integration interval is valid
// Compile option: Show integration results
#if defined(G_DEBUG_IRF_RADIAL)
std::cout << "GCTAResponseIrf::irf_radial:";
std::cout << " rho=[" << rho_min*gammalib::rad2deg;
std::cout << ", " << rho_max*gammalib::rad2deg << " deg;";
std::cout << " zeta=" << zeta*gammalib::rad2deg << " deg;";
std::cout << " eta=" << eta*gammalib::rad2deg << " deg;";
std::cout << " lambda=" << lambda*gammalib::rad2deg << " deg;";
std::cout << " omega0=" << omega0*gammalib::rad2deg << " deg;";
std::cout << " theta_max=" << src_max*gammalib::rad2deg << " deg;";
std::cout << " delta_max=" << delta_max*gammalib::rad2deg << " deg;";
std::cout << " obsDir=" << obsDir << ";";
std::cout << " modelDir=" << model->dir() << ";";
std::cout << " irf=" << irf << std::endl;
#endif
// Return IRF value
return irf;
}
/***********************************************************************//**
* @brief Return Irf value for elliptical source model
*
* @param[in] event Observed event.
* @param[in] source Source.
* @param[in] obs Observation.
*
* @exception GCTAException::bad_instdir_type
* Instrument direction is not a valid CTA instrument direction.
* @exception GCTAException::bad_model_type
* Model is not an elliptical model.
*
* Integrates the product of the model and the IRF over the true photon
* arrival direction using
*
* \f[
* \int_{\rho_{\rm min}}^{\rho_{\rm max}}
* \sin \rho \times
* \int_{\omega}
* S_{\rm p}(\rho, \omega | E, t) \, IRF(\rho, \omega) d\omega d\rho
* \f]
*
* where
* \f$S_{\rm p}(\rho, \omega | E, t)\f$ is the elliptical model,
* \f$IRF(\rho, \omega)\f$ is the instrument response function,
* \f$\rho\f$ is the distance from the model centre, and
* \f$\omega\f$ is the position angle with respect to the connecting line
* between the model centre and the observed photon arrival direction.
*
* The source model centre is located at \f$\vec{m}\f$, and a spherical
* coordinate system is defined around this location with \f$(\rho,\omega)\f$
* being the zenith and azimuth angles, respectively. The azimuth angle
* \f$(\omega)\f$ is counted counterclockwise from the vector that runs from
* the model centre \f$\vec{m}\f$ to the measured photon direction
* \f$\vec{p'}\f$.
***************************************************************************/
double GCTAResponseIrf::irf_elliptical(const GEvent& event,
const GSource& source,
const GObservation& obs) const
{
// Set number of iterations for Romberg integration.
// These values have been determined after careful testing, see
// https://cta-redmine.irap.omp.eu/issues/1299
// https://cta-redmine.irap.omp.eu/issues/1521
static const int iter_rho = 5;
static const int iter_phi = 5;
// Retrieve CTA pointing
const GCTAPointing& pnt = retrieve_pnt(G_IRF_ELLIPTICAL, obs);
const GCTAInstDir& dir = retrieve_dir(G_IRF_ELLIPTICAL, event);
// Get pointer on elliptical model
const GModelSpatialElliptical* model =
dynamic_cast<const GModelSpatialElliptical*>(source.model());
if (model == NULL) {
throw GCTAException::bad_model_type(G_IRF_ELLIPTICAL);
}
// Get event attributes (measured photon)
const GSkyDir& obsDir = dir.dir();
const GEnergy& obsEng = event.energy();
// Get source attributes
const GSkyDir& centre = model->dir();
const GEnergy& srcEng = source.energy();
const GTime& srcTime = source.time();
// Get pointing direction zenith angle and azimuth [radians]
double zenith = pnt.zenith();
double azimuth = pnt.azimuth();
// Determine angular distance between observed photon direction and model
// centre and position angle of observed photon direction seen from the
// model centre [radians]
double rho_obs = centre.dist(obsDir);
double posangle_obs = centre.posang(obsDir);
// Determine angular distance between model centre and pointing direction
// [radians]
double rho_pnt = centre.dist(pnt.dir());
double posangle_pnt = centre.posang(pnt.dir());
// Compute azimuth angle of pointing in model coordinate system [radians]
double omega_pnt = posangle_pnt - posangle_obs;
// Get log10(E/TeV) of true photon energy
double srcLogEng = srcEng.log10TeV();
// Get maximum PSF radius [radians]. We assign here the measured theta
// angle (eta) as the true theta angle between the source and the pointing
// directions. As we only use the angle to determine the maximum PSF size,
// this should be sufficient.
double theta = pnt.dir().dist(obsDir);
double phi = 0.0; //TODO: Implement IRF Phi dependence
double delta_max = psf_delta_max(theta, phi, zenith, azimuth, srcLogEng);
// Get the ellipse boundary (radians). Note that these are NOT the
// parameters of the ellipse but of a boundary ellipse that is used
// for computing the relevant omega angle intervals for a given angle
// rho. The boundary ellipse takes care of the possibility that the
// semiminor axis is larger than the semimajor axis
double semimajor; // Will be the larger axis
double semiminor; // Will be the smaller axis
double posangle; // Will be the corrected position angle
double aspect_ratio; // Ratio between smaller/larger axis of model
if (model->semimajor() >= model->semiminor()) {
aspect_ratio = (model->semimajor() > 0.0) ?
model->semiminor() / model->semimajor() : 0.0;
posangle = model->posangle() * gammalib::deg2rad;
}
else {
aspect_ratio = (model->semiminor() > 0.0) ?
model->semimajor() / model->semiminor() : 0.0;
posangle = model->posangle() * gammalib::deg2rad + gammalib::pihalf;
}
semimajor = model->theta_max();
semiminor = semimajor * aspect_ratio;
// Set zenith angle integration range for elliptical model
double rho_min = (rho_obs > delta_max) ? rho_obs - delta_max : 0.0;
double rho_max = rho_obs + delta_max;
if (rho_max > semimajor) {
rho_max = semimajor;
}
// Initialise IRF value
double irf = 0.0;
// Perform zenith angle integration if interval is valid
if (rho_max > rho_min) {
// Setup integration kernel
cta_irf_elliptical_kern_rho integrand(this,
model,
semimajor,
semiminor,
posangle,
zenith,
azimuth,
srcEng,
srcTime,
srcLogEng,
obsEng,
rho_obs,
posangle_obs,
rho_pnt,
omega_pnt,
delta_max,
iter_phi);
// Integrate over model's zenith angle
GIntegral integral(&integrand);
integral.fixed_iter(iter_rho);
// Setup integration boundaries
std::vector<double> bounds;
bounds.push_back(rho_min);
bounds.push_back(rho_max);
// If the integration range includes the semiminor boundary, then
// add an integration boundary at that location
if (semiminor > rho_min && semiminor < rho_max) {
bounds.push_back(semiminor);
}
// Integrate kernel
irf = integral.romberg(bounds, iter_rho);
// Compile option: Check for NaN/Inf
#if defined(G_NAN_CHECK)
if (gammalib::is_notanumber(irf) || gammalib::is_infinite(irf)) {
std::cout << "*** ERROR: GCTAResponseIrf::irf_elliptical:";
std::cout << " NaN/Inf encountered";
std::cout << " (irf=" << irf;
std::cout << ", rho_min=" << rho_min;
std::cout << ", rho_max=" << rho_max << ")";
std::cout << std::endl;
}
#endif
// Apply deadtime correction
irf *= obs.deadc(srcTime);
} // endif: integration interval is valid
// Compile option: Show integration results
#if defined(G_DEBUG_IRF_ELLIPTICAL)
std::cout << "GCTAResponseIrf::irf_elliptical:";
std::cout << " rho_min=" << rho_min;
std::cout << " rho_max=" << rho_max;
std::cout << " irf=" << irf << std::endl;
#endif
// Return IRF value
return irf;
}
/***********************************************************************//**
* @brief Return value of diffuse source instrument response function
*
* @param[in] event Observed event.
* @param[in] source Source.
* @param[in] obs Observation.
*
* Integrates the product of the model and the IRF over the true photon
* arrival direction using
*
* \f[
* \int_{0}^{\theta_{\rm max}}
* \sin \theta \times PSF(\theta)
* \int_{0}^{2\pi}
* S_{\rm p}(\theta, \phi | E, t) \,
* Aeff(\theta, \phi) \,
* Edisp(\theta, \phi) d\phi
* \f]
*
* where
* - \f$S_{\rm p}(\theta, \phi | E, t)\f$ is the diffuse model,
* - \f$PSF(\theta)\f$ is the azimuthally symmetric Point Spread Function,
* - \f$Aeff(\theta, \phi)\f$ is the effective area,
* - \f$Edisp(\theta, \phi)\f$ is the energy dispersion,
* - \f$\theta\f$ is the distance from the PSF centre, and
* - \f$\phi\f$ is the azimuth angle.
*
* The integration is performed in the reference of the observed arrival
* direction. Integration is done first over the azimuth angle \f$\phi\f$ and
* then over the offset angle \f$\theta\f$.
*
* The integration kernels for this method are implemented by the response
* helper classes cta_irf_diffuse_kern_theta and cta_irf_diffuse_kern_phi.
***************************************************************************/
double GCTAResponseIrf::irf_diffuse(const GEvent& event,
const GSource& source,
const GObservation& obs) const
{
// Set number of iterations for Romberg integration.
// These values have been determined after careful testing, see
// https://cta-redmine.irap.omp.eu/issues/1248
static const int iter_rho = 5;
static const int iter_phi = 5;
// Initialise IRF value
bool has_irf = false;
double irf = 0.0;
// Retrieve CTA pointing
const GCTAPointing& pnt = retrieve_pnt(G_IRF_DIFFUSE, obs);
// Try getting the IRF value from cache
#if defined(G_USE_IRF_CACHE)
const GCTAEventList* list = dynamic_cast<const GCTAEventList*>(obs.events());
const GCTAEventAtom* atom = dynamic_cast<const GCTAEventAtom*>(&event);
if (list != NULL && atom != NULL) {
irf = list->irf_cache(source.name(), atom->index());
if (irf >= 0.0) {
has_irf = true;
#if defined(G_DEBUG_IRF_DIFFUSE)
std::cout << "GCTAResponseIrf::irf_diffuse:";
std::cout << " cached irf=" << irf << std::endl;
#endif
}
else {
irf = 0.0;
}
}
#endif
// Continue only if we have no IRF value
if (!has_irf) {
// Get CTA instrument direction
const GCTAInstDir& dir = retrieve_dir(G_IRF_ELLIPTICAL, event);
// Get pointer on spatial model
const GModelSpatial* model =
dynamic_cast<const GModelSpatial*>(source.model());
if (model == NULL) {
throw GCTAException::bad_model_type(G_IRF_DIFFUSE);
}
// Get event attributes
//const GSkyDir& obsDir = dir.dir();
const GEnergy& obsEng = event.energy();
// Get source attributes
const GEnergy& srcEng = source.energy();
const GTime& srcTime = source.time();
// Get pointing direction zenith angle and azimuth [radians]
double zenith = pnt.zenith();
double azimuth = pnt.azimuth();
// Determine angular distance between measured photon direction and
// pointing direction [radians]
double eta = pnt.dir().dist(dir.dir());
// Get log10(E/TeV) of true photon energy
double srcLogEng = srcEng.log10TeV();
// Assign the observed theta angle (eta) as the true theta angle
// between the source and the pointing directions. This is a (not
// too bad) approximation which helps to speed up computations.
// If we want to do this correctly, however, we would need to move
// the psf_dummy_sigma down to the integration kernel, and we would
// need to make sure that psf_delta_max really gives the absolute
// maximum (this is certainly less critical)
double theta = eta;
double phi = 0.0; //TODO: Implement Phi dependence
// Get maximum PSF radius in radians
double delta_max = psf_delta_max(theta, phi, zenith, azimuth, srcLogEng);
// Perform zenith angle integration if interval is valid
if (delta_max > 0.0) {
// Compute rotation matrix to convert from coordinates (theta,phi)
// in the reference frame of the observed arrival direction into
// celestial coordinates
GMatrix ry;
GMatrix rz;
ry.eulery(dir.dir().dec_deg() - 90.0);
rz.eulerz(-dir.dir().ra_deg());
GMatrix rot = (ry * rz).transpose();
// Setup integration kernel
cta_irf_diffuse_kern_theta integrand(this,
model,
&rot,
theta,
phi,
zenith,
azimuth,
srcEng,
srcTime,
srcLogEng,
obsEng,
eta,
iter_phi);
// Integrate over Psf delta angle
GIntegral integral(&integrand);
integral.fixed_iter(iter_rho);
irf = integral.romberg(0.0, delta_max);
// Compile option: Check for NaN/Inf
#if defined(G_NAN_CHECK)
if (gammalib::is_notanumber(irf) || gammalib::is_infinite(irf)) {
std::cout << "*** ERROR: GCTAResponseIrf::irf_diffuse:";
std::cout << " NaN/Inf encountered";
std::cout << " (irf=" << irf;
std::cout << ", delta_max=" << delta_max << ")";
std::cout << std::endl;
}
#endif
}
// Apply deadtime correction
irf *= obs.deadc(srcTime);
// Put IRF value in cache
#if defined(G_USE_IRF_CACHE)
if (list != NULL && atom != NULL) {
list->irf_cache(source.name(), atom->index(), irf);
}
#endif
// Compile option: Show integration results
#if defined(G_DEBUG_IRF_DIFFUSE)
std::cout << "GCTAResponseIrf::irf_diffuse:";
std::cout << " srcLogEng=" << srcLogEng;
std::cout << " obsLogEng=" << obsLogEng;
std::cout << " eta=" << eta;
std::cout << " delta_max=" << delta_max;
std::cout << " irf=" << irf << std::endl;
#endif
} // endif: has no IRF
// Return IRF value
return irf;
}
/***********************************************************************//**
* @brief Return spatial integral of point source model
*
* @param[in] model Sky Model.
* @param[in] srcEng True photon energy.
* @param[in] srcTime True photon arrival time.
* @param[in] obsEng Observed event energy.
* @param[in] obsTime Observed event arrival time.
* @param[in] obs Observation.
*
* Computes the integral
*
* \f[
* N_{\rm ROI}(E',t'|E,t) = \int_{\rm ROI} P(p',E',t'|E,t) dp'
* \f]
*
* of
*
* \f[
* P(p',E',t'|E,t) = \int
* S(p,E,t) \times R(p',E',t'|p,E,t) \, dp
* \f]
*
* over the Region of Interest (ROI) for a point source model \f$S(p,E,t)\f$
* and the response function \f$R(p',E',t'|p,E,t)\f$.
***************************************************************************/
double GCTAResponseIrf::nroi_ptsrc(const GModelSky& model,
const GEnergy& srcEng,
const GTime& srcTime,
const GEnergy& obsEng,
const GTime& obsTime,
const GObservation& obs) const
{
// Get point source spatial model
const GModelSpatialPointSource* src =
static_cast<const GModelSpatialPointSource*>(model.spatial());
// Set Photon
GPhoton photon(src->dir(), srcEng, srcTime);
// Compute Nroi
double nroi = nirf(photon, obsEng, obsTime, obs);
// Return Nroi
return nroi;
}
/***********************************************************************//**
* @brief Return spatial integral of radial source model
*
* @param[in] model Sky Model.
* @param[in] srcEng True photon energy.
* @param[in] srcTime True photon arrival time.
* @param[in] obsEng Observed event energy.
* @param[in] obsTime Observed event arrival time.
* @param[in] obs Observation.
*
* Computes the integral
*
* \f[
* N_{\rm ROI}(E',t'|E,t) = \int_{\rm ROI} P(p',E',t'|E,t) dp'
* \f]
*
* of
*
* \f[
* P(p',E',t'|E,t) = \int
* S(p,E,t) \times R(p',E',t'|p,E,t) \, dp
* \f]
*
* over the Region of Interest (ROI) for a radial source model \f$S(p,E,t)\f$
* and the response function \f$R(p',E',t'|p,E,t)\f$.
***************************************************************************/
double GCTAResponseIrf::nroi_radial(const GModelSky& model,
const GEnergy& srcEng,
const GTime& srcTime,
const GEnergy& obsEng,
const GTime& obsTime,
const GObservation& obs) const
{
// Set number of iterations for Romberg integration.
// These values have been determined after careful testing, see
// https://cta-redmine.irap.omp.eu/issues/1299
static const int iter_rho = 6;
static const int iter_phi = 6;
// Initialise Nroi value
double nroi = 0.0;
// Retrieve CTA observation, ROI and pointing
const GCTAObservation& cta = retrieve_obs(G_NROI_RADIAL, obs);
const GCTARoi& roi = retrieve_roi(G_NROI_RADIAL, obs);
const GCTAPointing& pnt = cta.pointing();
// Get pointer on radial model
const GModelSpatialRadial* spatial =
dynamic_cast<const GModelSpatialRadial*>(model.spatial());
if (spatial == NULL) {
throw GCTAException::bad_model_type(G_NROI_RADIAL);
}
// Get source attributes
const GSkyDir& centre = spatial->dir();
// Get pointing direction zenith angle and azimuth [radians]
double zenith = pnt.zenith();
double azimuth = pnt.azimuth();
// Get log10(E/TeV) of true photon energy
double srcLogEng = srcEng.log10TeV();
// Get maximum PSF radius (radians). We do this for the onaxis PSF only,
// as this allows us doing this computation in the outer loop. This
// should be sufficient here, unless the offaxis PSF becomes much worse
// than the onaxis PSF. In this case, we may add a safety factor here
// to make sure we encompass the entire PSF.
double psf_max_radius = psf_delta_max(0.0, 0.0, zenith, azimuth, srcLogEng);
// Extract ROI radius (radians)
double roi_radius = roi.radius() * gammalib::deg2rad;
// Compute distance between ROI and model centre (radians)
double roi_model_distance = roi.centre().dir().dist(centre);
// Compute the ROI radius plus maximum PSF radius (radians). Any photon
// coming from beyond this radius will not make it in the dataspace and
// thus can be neglected.
double roi_psf_radius = roi_radius + psf_max_radius;
// Set offset angle integration range. We take here the ROI+PSF into
// account to make no integrations beyond the point where the
// contribution drops to zero.
double rho_min = (roi_model_distance > roi_psf_radius)
? roi_model_distance - roi_psf_radius: 0.0;
double rho_max = spatial->theta_max();
// Perform offset angle integration only if interval is valid
if (rho_max > rho_min) {
// Compute rotation matrix to convert from native model coordinates,
// given by (rho,omega), into celestial coordinates.
GMatrix ry;
GMatrix rz;
ry.eulery(spatial->dec() - 90.0);
rz.eulerz(-spatial->ra());
GMatrix rot = (ry * rz).transpose();
// Compute position angle of ROI centre with respect to model
// centre (radians)
double omega0 = centre.posang(roi.centre().dir());
// Setup integration kernel
cta_nroi_radial_kern_rho integrand(this,
&cta,
spatial,
&rot,
srcEng,
srcTime,
obsEng,
obsTime,
roi_model_distance,
roi_psf_radius,
omega0,
iter_phi);
// Integrate over model's zenith angle
GIntegral integral(&integrand);
integral.fixed_iter(iter_rho);
// Setup integration boundaries
std::vector<double> bounds;
bounds.push_back(rho_min);
bounds.push_back(rho_max);
// If the integration range includes a transition between full
// containment of model within ROI and partial containment, then
// add a boundary at this location
double transition_point = roi_psf_radius - roi_model_distance;
if (transition_point > rho_min && transition_point < rho_max) {
bounds.push_back(transition_point);
}
// If the integration range includes a transition between full
// containment of ROI within model and partial containment, then
// add a boundary at this location
transition_point = roi_psf_radius + roi_model_distance;
if (transition_point > rho_min && transition_point < rho_max) {
bounds.push_back(transition_point);
}
// If we have a shell model then add an integration boundary for the
// shell radius as a function discontinuity will occur at this
// location
const GModelSpatialRadialShell* shell = dynamic_cast<const GModelSpatialRadialShell*>(spatial);
if (shell != NULL) {
double shell_radius = shell->radius() * gammalib::deg2rad;
if (shell_radius > rho_min && shell_radius < rho_max) {
bounds.push_back(shell_radius);
}
}
// Integrate kernel
nroi = integral.romberg(bounds, iter_rho);
// Compile option: Show integration results
#if defined(G_DEBUG_NROI_RADIAL)
std::cout << "GCTAResponseIrf::nroi_radial:";
std::cout << " rho_min=" << rho_min;
std::cout << " rho_max=" << rho_max;
std::cout << " nroi=" << nroi << std::endl;
#endif
} // endif: offset angle range was valid
// Debug: Check for NaN
#if defined(G_NAN_CHECK)
if (gammalib::is_notanumber(nroi) || gammalib::is_infinite(nroi)) {
std::cout << "*** ERROR: GCTAResponseIrf::nroi_radial:";
std::cout << " NaN/Inf encountered";
std::cout << " (nroi=" << nroi;
std::cout << ", rho_min=" << rho_min;
std::cout << ", rho_max=" << rho_max;
std::cout << ")" << std::endl;
}
#endif
// Return Nroi
return nroi;
}
/***********************************************************************//**
* @brief Return spatial integral of elliptical source model
*
* @param[in] model Sky Model.
* @param[in] srcEng True photon energy.
* @param[in] srcTime True photon arrival time.
* @param[in] obsEng Observed event energy.
* @param[in] obsTime Observed event arrival time.
* @param[in] obs Observation.
*
* Computes the integral
*
* \f[
* N_{\rm ROI}(E',t'|E,t) = \int_{\rm ROI} P(p',E',t'|E,t) dp'
* \f]
*
* of
*
* \f[
* P(p',E',t'|E,t) = \int
* S(p,E,t) \times R(p',E',t'|p,E,t) \, dp
* \f]
*
* over the Region of Interest (ROI) for an elliptical source model
* \f$S(p,E,t)\f$ and the response function \f$R(p',E',t'|p,E,t)\f$.
***************************************************************************/
double GCTAResponseIrf::nroi_elliptical(const GModelSky& model,
const GEnergy& srcEng,
const GTime& srcTime,
const GEnergy& obsEng,
const GTime& obsTime,
const GObservation& obs) const
{
// Set number of iterations for Romberg integration.
// These values have been determined after careful testing, see
// https://cta-redmine.irap.omp.eu/issues/1299
static const int iter_rho = 6;
static const int iter_phi = 6;
// Initialise Nroi value
double nroi = 0.0;
// Retrieve CTA observation, ROI and pointing
const GCTAObservation& cta = retrieve_obs(G_NROI_ELLIPTICAL, obs);
const GCTARoi& roi = retrieve_roi(G_NROI_ELLIPTICAL, obs);
const GCTAPointing& pnt = cta.pointing();
// Get pointer on elliptical model
const GModelSpatialElliptical* spatial =
dynamic_cast<const GModelSpatialElliptical*>(model.spatial());
if (spatial == NULL) {
throw GCTAException::bad_model_type(G_NROI_ELLIPTICAL);
}
// Get source attributes
const GSkyDir& centre = spatial->dir();
// Get pointing direction zenith angle and azimuth [radians]
double zenith = pnt.zenith();
double azimuth = pnt.azimuth();
// Get log10(E/TeV) of true photon energy
double srcLogEng = srcEng.log10TeV();
// Get maximum PSF radius (radians). We do this for the onaxis PSF only,
// as this allows us doing this computation in the outer loop. This
// should be sufficient here, unless the offaxis PSF becomes much worse
// than the onaxis PSF. In this case, we may add a safety factor here
// to make sure we encompass the entire PSF.
double psf_max_radius = psf_delta_max(0.0, 0.0, zenith, azimuth, srcLogEng);
// Extract ROI radius plus maximum PSF radius (radians). Any photon
// coming from beyond this radius will not make it in the dataspace and
// thus can be neglected.
double radius_roi = roi.radius() * gammalib::deg2rad + psf_max_radius;
// Compute distance between ROI and model centre (radians)
double rho_roi = roi.centre().dir().dist(centre);
// Get the ellipse boundary (radians). Note that these are NOT the
// parameters of the ellipse but of a boundary ellipse that is used
// for computing the relevant omega angle intervals for a given angle
// rho. The boundary ellipse takes care of the possibility that the
// semiminor axis is larger than the semimajor axis
double semimajor; // Will be the larger axis
double semiminor; // Will be the smaller axis
double posangle; // Will be the corrected position angle
double aspect_ratio; // Ratio between smaller/larger axis of model
if (spatial->semimajor() >= spatial->semiminor()) {
aspect_ratio = (spatial->semimajor() > 0.0) ?
spatial->semiminor() / spatial->semimajor() : 0.0;
posangle = spatial->posangle() * gammalib::deg2rad;
}
else {
aspect_ratio = (spatial->semiminor() > 0.0) ?
spatial->semimajor() / spatial->semiminor() : 0.0;
posangle = spatial->posangle() * gammalib::deg2rad + gammalib::pihalf;
}
semimajor = spatial->theta_max();
semiminor = semimajor * aspect_ratio;
// Set offset angle integration range. We take here the ROI+PSF into
// account to make no integrations beyond the point where the
// contribution drops to zero.
double rho_min = (rho_roi > radius_roi) ? rho_roi - radius_roi: 0.0;
double rho_max = rho_roi + radius_roi;
if (rho_max > semimajor) {
rho_max = semimajor;
}
// Perform offset angle integration only if interval is valid
if (rho_max > rho_min) {
// Compute rotation matrix to convert from native model coordinates,
// given by (rho,omega), into celestial coordinates.
GMatrix ry;
GMatrix rz;
ry.eulery(spatial->dec() - 90.0);
rz.eulerz(-spatial->ra());
GMatrix rot = (ry * rz).transpose();
// Compute position angle of ROI centre with respect to model
// centre (radians)
double posangle_roi = centre.posang(roi.centre().dir());
// Setup integration kernel
cta_nroi_elliptical_kern_rho integrand(this,
&cta,
spatial,
&rot,
semimajor,
semiminor,
posangle,
srcEng,
srcTime,
obsEng,
obsTime,
rho_roi,
posangle_roi,
radius_roi,
iter_phi);
// Integrate over model's zenith angle
GIntegral integral(&integrand);
integral.fixed_iter(iter_rho);
// Setup integration boundaries
std::vector<double> bounds;
bounds.push_back(rho_min);
bounds.push_back(rho_max);
// If the integration range includes the semiminor boundary, then
// add an integration boundary at that location
if (semiminor > rho_min && semiminor < rho_max) {
bounds.push_back(semiminor);
}
// Integrate kernel
nroi = integral.romberg(bounds, iter_rho);
// Compile option: Show integration results
#if defined(G_DEBUG_NROI_ELLIPTICAL)
std::cout << "GCTAResponseIrf::nroi_elliptical:";
std::cout << " rho_min=" << rho_min;
std::cout << " rho_max=" << rho_max;
std::cout << " nroi=" << nroi << std::endl;
#endif
} // endif: offset angle range was valid
// Debug: Check for NaN
#if defined(G_NAN_CHECK)
if (gammalib::is_notanumber(nroi) || gammalib::is_infinite(nroi)) {
std::cout << "*** ERROR: GCTAResponseIrf::nroi_elliptical:";
std::cout << " NaN/Inf encountered";
std::cout << " (nroi=" << nroi;
std::cout << ", rho_min=" << rho_min;
std::cout << ", rho_max=" << rho_max;
std::cout << ")" << std::endl;
}
#endif
// Return Nroi
return nroi;
}
/***********************************************************************//**
* @brief Return spatial integral of diffuse source model
*
* @param[in] model Sky Model.
* @param[in] srcEng True photon energy.
* @param[in] srcTime True photon arrival time.
* @param[in] obsEng Observed event energy.
* @param[in] obsTime Observed event arrival time.
* @param[in] obs Observation.
*
* Computes the integral
*
* \f[
* N_{\rm ROI}(E',t'|E,t) = \int_{\rm ROI} P(p',E',t'|E,t) dp'
* \f]
*
* of
*
* \f[
* P(p',E',t'|E,t) = \int
* S(p,E,t) \times R(p',E',t'|p,E,t) \, dp
* \f]
*
* over the Region of Interest (ROI) for a diffuse source model
* \f$S(p,E,t)\f$ and the response function \f$R(p',E',t'|p,E,t)\f$.
***************************************************************************/
double GCTAResponseIrf::nroi_diffuse(const GModelSky& model,
const GEnergy& srcEng,
const GTime& srcTime,
const GEnergy& obsEng,
const GTime& obsTime,
const GObservation& obs) const
{
// Set number of iterations for Romberg integration.
// These values have been determined after careful testing, see
// https://cta-redmine.irap.omp.eu/issues/1248
static const int iter_rho = 9;
static const int iter_phi = 9;
// Initialise Nroi value
double nroi = 0.0;
bool has_nroi = false;
// Build unique identifier
std::string id = model.name() + "::" + obs.id();
// Check if Nroi value is already in cache
#if defined(G_USE_NPRED_CACHE)
if (!m_npred_names.empty()) {
// Search for unique identifier, and if found, recover Npred value
// and break
for (int i = 0; i < m_npred_names.size(); ++i) {
if (m_npred_names[i] == id &&
m_npred_energies[i] == srcEng &&
m_npred_times[i] == srcTime) {
nroi = m_npred_values[i];
has_nroi = true;
#if defined(G_DEBUG_NROI_DIFFUSE)
std::cout << "GCTAResponseIrf::nroi_diffuse:";
std::cout << " cache=" << i;
std::cout << " nroi=" << nroi << std::endl;
#endif
break;
}
}
} // endif: there were values in the Npred cache
#endif
// Continue only if no Npred cache value was found
if (!has_nroi) {
// Retrieve CTA observation, ROI and pointing
const GCTAObservation& cta = retrieve_obs(G_NROI_DIFFUSE, obs);
const GCTARoi& roi = retrieve_roi(G_NROI_DIFFUSE, obs);
const GCTAPointing& pnt = cta.pointing();
// Get pointer on spatial model
const GModelSpatial* spatial =
dynamic_cast<const GModelSpatial*>(model.spatial());
if (spatial == NULL) {
throw GCTAException::bad_model_type(G_NROI_DIFFUSE);
}
// Get pointing direction zenith angle and azimuth [radians]
double zenith = pnt.zenith();
double azimuth = pnt.azimuth();
// Get log10(E/TeV) of true photon energy
double srcLogEng = srcEng.log10TeV();
// Get maximum PSF radius (radians). We do this for the onaxis PSF only,
// as this allows us doing this computation in the outer loop. This
// should be sufficient here, unless the offaxis PSF becomes much worse
// than the onaxis PSF. In this case, we may add a safety factor here
// to make sure we encompass the entire PSF.
double psf_max_radius = psf_delta_max(0.0, 0.0, zenith, azimuth, srcLogEng);
// Extract ROI radius (radians)
double roi_radius = roi.radius() * gammalib::deg2rad;
// Compute the ROI radius plus maximum PSF radius (radians). Any photon
// coming from beyond this radius will not make it in the dataspace and
// thus can be neglected.
double roi_psf_radius = roi_radius + psf_max_radius;
// Perform offset angle integration only if interval is valid
if (roi_psf_radius > 0.0) {
// Compute rotation matrix to convert from native ROI coordinates,
// given by (theta,phi), into celestial coordinates.
GMatrix ry;
GMatrix rz;
ry.eulery(roi.centre().dir().dec_deg() - 90.0);
rz.eulerz(-roi.centre().dir().ra_deg());
GMatrix rot = (ry * rz).transpose();
// Setup integration kernel
cta_nroi_diffuse_kern_theta integrand(this,
&cta,
spatial,
&rot,
srcEng,
srcTime,
obsEng,
obsTime,
iter_phi);
// Integrate over model's zenith angle
GIntegral integral(&integrand);
integral.fixed_iter(iter_rho);
nroi = integral.romberg(0.0, roi_psf_radius);
// Compile option: Show integration results
#if defined(G_DEBUG_NROI_DIFFUSE)
std::cout << "GCTAResponseIrf::nroi_diffuse:";
std::cout << " roi_psf_radius=" << roi_psf_radius;
std::cout << " nroi=" << npred;
std::cout << " id=" << id << std::endl;
#endif
} // endif: offset angle range was valid
// Store result in Npred cache
#if defined(G_USE_NPRED_CACHE)
m_npred_names.push_back(id);
m_npred_energies.push_back(srcEng);
m_npred_times.push_back(srcTime);
m_npred_values.push_back(nroi);
#endif
// Debug: Check for NaN
#if defined(G_NAN_CHECK)
if (gammalib::is_notanumber(nroi) || gammalib::is_infinite(nroi)) {
std::cout << "*** ERROR: GCTAResponseIrf::nroi_diffuse:";
std::cout << " NaN/Inf encountered";
std::cout << " (nroi=" << nroi;
std::cout << ", roi_psf_radius=" << roi_psf_radius;
std::cout << ")" << std::endl;
}
#endif
} // endif: Nroi computation required
// Return Nroi
return nroi;
}