csroot2caldb.py
60.6 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
#! /usr/bin/env python
# ==========================================================================
# Generate IRFs in CALDB format from a ROOT offaxis performance file
#
# Copyright (C) 2016-2017 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/>.
#
# ==========================================================================
import os
import sys
import math
import copy
from datetime import datetime
import gammalib
import ctools
from cscripts import calutils
# Optional ROOT import
try:
from ROOT import TFile, TH2F, TH3F
_has_root = True
except ImportError:
_has_root = False
# ================== #
# csroot2caldb class #
# ================== #
class csroot2caldb(ctools.cscript):
"""
Generates IRFs in CALDB from a ROOT offaxis performance file
"""
# Constructor
def __init__(self, *argv):
"""
Constructor
"""
# Initialise application by calling the base class constructor
self._init_cscript(self.__class__.__name__, ctools.__version__, argv)
# Return
return
# Private methods
def _get_parameters(self):
"""
Get parameters from parfile
"""
# Query parameters
self['infile'].filename()
self['outdir'].string()
self['inst'].string()
self['id'].string()
self['analysis'].string()
self['zenith'].real()
self['azimuth'].real()
self['version'].string()
self['psftype'].string()
self['split'].boolean()
self['norm1d'].boolean()
self['rebin'].boolean()
self['eascale'].real()
self['bgdscale'].real()
self['bgdoversample'].integer()
self['bgdinfill'].boolean()
# Write input parameters into logger
self._log_parameters(gammalib.TERSE)
# Return
return
def _init_metadata(self):
"""
Initialise dictionary containing the IRF metadata
Returns
-------
irf : dict
IRF metadata dictionary
"""
# Initialise IRF metadata dictionary
irf = {}
# Set calibration information
cal_name = 'NAME('+self['id'].string()+')'
cal_version = 'VERSION('+self['version'].string()+')'
cal_cut = 'CLASS(BEST)'
cal_analysis = 'ANALYSIS('+self['analysis'].string()+')'
cal_zenith = 'ZENITH(%.3f)deg' % self['zenith'].real()
cal_azimuth = 'AZIMUTH(%.3f)deg' % self['azimuth'].real()
cal_bounds = [cal_name, cal_version, cal_cut, cal_analysis, \
cal_zenith, cal_azimuth]
# Set IRF information
irf['CAL_TEL'] = 'CTA'
irf['CAL_INST'] = self['inst'].string().upper()
irf['CAL_OBSID'] = self['id'].string()
irf['CAL_DET'] = 'NONE'
irf['CAL_FLT'] = 'NONE'
irf['CAL_CLASS'] = 'BCF'
irf['CAL_TYPE'] = 'DATA'
irf['CAL_QUAL'] = 0 # 0=good, 1=bad, 2=dubious, ...
irf['CAL_DATE'] = '14/01/30'
irf['VAL_DATE'] = '2014-01-30'
irf['VAL_TIME'] = '00:00:00'
irf['REF_TIME'] = 51544.0
irf['EA_NAME'] = 'EFF_AREA'
irf['EA_HDUCLAS3'] = 'FULL-ENCLOSURE'
irf['EA_HDUCLAS4'] = '2D'
irf['EA_DOC'] = 'CAL/GEN/92-019'
irf['EA_BOUNDS'] = copy.deepcopy(cal_bounds)
irf['EA_DESC'] = 'CTA effective area'
irf['PSF_NAME'] = 'RPSF'
irf['PSF_HDUCLAS3'] = 'FULL-ENCLOSURE'
irf['PSF_HDUCLAS4'] = '3GAUSS'
irf['PSF_DOC'] = 'CAL/GEN/92-020'
irf['PSF_BOUNDS'] = copy.deepcopy(cal_bounds)
irf['PSF_DESC'] = 'CTA point spread function'
irf['EDISP_NAME'] = 'EDISP'
irf['EDISP_HDUCLAS3'] = 'FULL-ENCLOSURE'
irf['EDISP_HDUCLAS4'] = '2D'
irf['EDISP_DOC'] = '???'
irf['EDISP_BOUNDS'] = copy.deepcopy(cal_bounds)
irf['EDISP_DESC'] = 'CTA energy dispersion'
irf['BGD_NAME'] = 'BKG'
irf['BGD_HDUCLAS3'] = 'FULL-ENCLOSURE'
irf['BGD_HDUCLAS4'] = '3D'
irf['BGD_DOC'] = '???'
irf['BGD_BOUNDS'] = copy.deepcopy(cal_bounds)
irf['BGD_DESC'] = 'CTA background'
# Set parameter dependent IRF information
if self['psftype'].string() == 'King':
irf['PSF_HDUCLAS4'] = 'KING'
else:
irf['PSF_HDUCLAS4'] = '3GAUSS'
# Return metadata
return irf
def _make_dirs(self, version, irf):
"""
Generate CALDB directory structure for one observation identifier
The structure is given by
data/<tel>/<inst>/bcf/<obsid>
where <tel> is "cta" and <inst> is the instrument specified in the
CALDB constructor (the instrument may be used for different array
configurations).
Parameters
----------
version : str
Version string
irf : dict
IRF metadata dictionary
Returns
-------
ds : dict
Directory structure information
"""
# Initialise directory structure dictionary
ds = {}
# Set base directory
base_dir = 'data'
base_dir += '/'+irf['CAL_TEL'].lower()
base_dir += '/'+irf['CAL_INST'].lower()
# Set directory names
obs_dir = base_dir+'/bcf/'+irf['CAL_OBSID']
ds['EA_DIR'] = obs_dir
ds['PSF_DIR'] = obs_dir
ds['EDISP_DIR'] = obs_dir
ds['BGD_DIR'] = obs_dir
# Set path to response components. If the "outdir" parameter is set
# then prefix the value to the path of the response components
outdir = self['outdir'].string()
if len(outdir) > 0:
ds['BASE_PATH'] = outdir+'/'+base_dir
ds['EA_PATH'] = outdir+'/'+ds['EA_DIR']
ds['PSF_PATH'] = outdir+'/'+ds['PSF_DIR']
ds['EDISP_PATH'] = outdir+'/'+ds['EDISP_DIR']
ds['BGD_PATH'] = outdir+'/'+ds['BGD_DIR']
else:
ds['BASE_PATH'] = base_dir
ds['EA_PATH'] = ds['EA_DIR']
ds['PSF_PATH'] = ds['PSF_DIR']
ds['EDISP_PATH'] = ds['EDISP_DIR']
ds['BGD_PATH'] = ds['BGD_DIR']
# Set IRF component file names. If the "split" parameter is "yes" then
# split the IRF components over several files.
if self['split'].boolean():
ds['EA_FILE'] = 'ea_'+version+'.fits'
ds['PSF_FILE'] = 'psf_'+version+'.fits'
ds['EDISP_FILE'] = 'edisp_'+version+'.fits'
ds['BGD_FILE'] = 'bgd_'+version+'.fits'
else:
ds['EA_FILE'] = 'irf_'+version+'.fits'
ds['PSF_FILE'] = 'irf_'+version+'.fits'
ds['EDISP_FILE'] = 'irf_'+version+'.fits'
ds['BGD_FILE'] = 'irf_'+version+'.fits'
# Create directory structure
if not os.path.isdir(ds['EA_PATH']):
os.makedirs(ds['EA_PATH'])
if not os.path.isdir(ds['PSF_PATH']):
os.makedirs(ds['PSF_PATH'])
if not os.path.isdir(ds['EDISP_PATH']):
os.makedirs(ds['EDISP_PATH'])
if not os.path.isdir(ds['BGD_PATH']):
os.makedirs(ds['BGD_PATH'])
# Return ds
return ds
def _open(self, irf, ds):
"""
Open existing or create new calibration
The actual version will put all calibrations in the same file, although
each part of the response function will have its own logical name. We
can thus easily modify the script to put each calibration information
in a separate file
Parameters
----------
irf : dict
IRF metadata dictionary
ds : dict
Directory structure dictionary
"""
# Open calibration database index
ds['CIF'] = gammalib.GFits(ds['BASE_PATH']+'/caldb.indx', True)
# If file has no CIF extension than create it now
if not ds['CIF'].contains('CIF'):
ds['CIF'].append(calutils.create_cif_table())
ds['HDU_CIF'] = ds['CIF'].table('CIF')
# Set IRF component filenames
ea_filename = ds['EA_PATH']+'/'+ds['EA_FILE']
psf_filename = ds['PSF_PATH']+'/'+ds['PSF_FILE']
edisp_filename = ds['EDISP_PATH']+'/'+ds['EDISP_FILE']
bgd_filename = ds['BGD_PATH']+'/'+ds['BGD_FILE']
# Open IRF component files
if self['split'].boolean():
ds['EA_FITS'] = gammalib.GFits(ea_filename, True)
ds['PSF_FITS'] = gammalib.GFits(psf_filename, True)
ds['EDISP_FITS'] = gammalib.GFits(edisp_filename, True)
ds['BGD_FITS'] = gammalib.GFits(bgd_filename, True)
else:
ds['EA_FITS'] = gammalib.GFits(ea_filename, True)
ds['PSF_FITS'] = ds['EA_FITS']
ds['EDISP_FITS'] = ds['EA_FITS']
ds['BGD_FITS'] = ds['EA_FITS']
# Open HDUs
ds['HDU_EA'] = self._open_hdu(ds['EA_FITS'], "EFFECTIVE AREA",
irf['EA_NAME'], irf['EA_HDUCLAS3'],
irf['EA_HDUCLAS4'], irf['EA_DOC'],
irf)
ds['HDU_PSF'] = self._open_hdu(ds['PSF_FITS'], "POINT SPREAD FUNCTION",
irf['PSF_NAME'], irf['PSF_HDUCLAS3'],
irf['PSF_HDUCLAS4'], irf['PSF_DOC'],
irf)
ds['HDU_EDISP'] = self._open_hdu(ds['EDISP_FITS'], "ENERGY DISPERSION",
irf['EDISP_NAME'], irf['EDISP_HDUCLAS3'],
irf['EDISP_HDUCLAS4'], irf['EDISP_DOC'],
irf)
ds['HDU_BGD'] = self._open_hdu(ds['BGD_FITS'], "BACKGROUND",
irf['BGD_NAME'], irf['BGD_HDUCLAS3'],
irf['BGD_HDUCLAS4'], irf['BGD_DOC'],
irf)
# Return
return
def _close(self, irf, ds):
"""
Close calibration FITS files
Parameters
----------
irf : dict
IRF metadata dictionary
ds : dict
Directory structure dictionary
"""
# Add information to CIF. We do this now as before we did not
# necessarily have all the information at hand (in particular about
# the boundaries)
self._add_cif_info(irf, ds)
# Save and close CIF
ds['CIF'].save(True)
ds['CIF'].close()
# Close all IRF components. If the files have been split all components
# need to be closed, otherwise only the effective area component needs
# to be closed as representative for all components.
ds['EA_FITS'].save(True)
ds['EA_FITS'].close()
if self['split'].boolean():
ds['PSF_FITS'].save(True)
ds['EDISP_FITS'].save(True)
ds['BGD_FITS'].save(True)
ds['PSF_FITS'].close()
ds['EDISP_FITS'].close()
ds['BGD_FITS'].close()
# Return
return
def _open_hdu(self, fits, extname, name, hduclas3, hduclas4, doc, irf):
"""
Open HDU
Opens a FITS binary table with given "extname". If HDU does not exist
in the FITS file it will be created and appended to the FITS file.
Parameters
----------
fits : `~gammalib.GFits`
FITS file
extname : str
Extension name
name : str
Name string
hduclas3 : str
HDU class 3 string
hduclas4 : str
HDU class 4 string
doc : str
Document string
irf : dict
IRF metadata dictionary
Returns
-------
table : `~gammalib.GFitsBinTable`
FITS binary table
"""
# Create table if it does not yet exist
if not fits.contains(extname):
# Create binary table
table = gammalib.GFitsBinTable()
# Set extension name
table.extname(extname)
# Set OGIP keywords
self._set_ogip_keywords(table, doc,
['RESPONSE', name, hduclas3, hduclas4],
irf)
# Append table to FITS file
fits.append(table)
# Return FITS table
return fits.table(extname)
def _set_ogip_keywords(self, hdu, hdudoc, hduclas, irf):
"""
Set standard OGIP keywords for extension
Parameters
----------
hdu : `~gammalig.GFitsHDU`
Header Data Unit
hdudoc : str
Documentation reference string
hduclas : list of str
List of HDUCLAS fields
irf : dict
IRF dictonary
"""
# Set UTC date of file creation
utc = datetime.utcnow().isoformat()[:19]
# Set keywords
hdu.card('ORIGIN', 'IRAP', 'Name of organization making this file')
hdu.card('DATE', utc, 'File creation date (YYYY-MM-DDThh:mm:ss UTC)')
hdu.card('TELESCOP', irf['CAL_TEL'], 'Name of telescope')
hdu.card('INSTRUME', irf['CAL_INST'], 'Name of instrument')
hdu.card('DETNAM', irf['CAL_DET'], 'Name of detector')
hdu.card('HDUCLASS', 'OGIP', 'HDU class')
hdu.card('HDUDOC', hdudoc, 'HDU documentation')
for i, item in enumerate(hduclas):
key = 'HDUCLAS%d' % (i+1)
hdu.card(key, item, 'HDU class')
hdu.card('HDUVERS', '0.2', 'HDU version')
# Return
return
def _add_cif_info(self, irf, ds):
"""
Add information to CIF extension
Parameters
----------
irf : dict
IRF metadata dictionary
ds : dict
Directory structure dictionary
"""
# Set list of IRF component names
names = ['EA', 'PSF', 'EDISP', 'BGD']
# Initialise CIF row index
row = ds['HDU_CIF'].nrows()
# Append rows for all components to CIF extension
ds['HDU_CIF'].append_rows(len(names))
# Add information for all components
for name in names:
# Set dictionary keys for this component
key_dir = '%s_DIR' % name
key_file = '%s_FILE' % name
key_name = '%s_NAME' % name
key_desc = '%s_DESC' % name
key_bounds = '%s_BOUNDS' % name
# Set generic information
ds['HDU_CIF']['TELESCOP'][row] = irf['CAL_TEL']
ds['HDU_CIF']['INSTRUME'][row] = irf['CAL_INST']
ds['HDU_CIF']['DETNAM'][row] = irf['CAL_DET']
ds['HDU_CIF']['FILTER'][row] = irf['CAL_FLT']
ds['HDU_CIF']['CAL_DEV'][row] = 'ONLINE'
ds['HDU_CIF']['CAL_CLAS'][row] = irf['CAL_CLASS']
ds['HDU_CIF']['CAL_DTYP'][row] = irf['CAL_TYPE']
ds['HDU_CIF']['CAL_VSD'][row] = irf['VAL_DATE']
ds['HDU_CIF']['CAL_VST'][row] = irf['VAL_TIME']
ds['HDU_CIF']['REF_TIME'][row] = irf['REF_TIME']
ds['HDU_CIF']['CAL_QUAL'][row] = irf['CAL_QUAL']
ds['HDU_CIF']['CAL_DATE'][row] = irf['CAL_DATE']
# Set component specific information
ds['HDU_CIF']['CAL_DIR'][row] = ds[key_dir]
ds['HDU_CIF']['CAL_FILE'][row] = ds[key_file]
ds['HDU_CIF']['CAL_CNAM'][row] = irf[key_name]
ds['HDU_CIF']['CAL_DESC'][row] = irf[key_desc]
ds['HDU_CIF']['CAL_XNO'][row] = 1
for i in range(9):
if i >= len(irf[key_bounds]):
ds['HDU_CIF']['CAL_CBD'][row,i] = 'NONE'
else:
ds['HDU_CIF']['CAL_CBD'][row,i] = irf[key_bounds][i]
# Increment row index
row += 1
# Return
return
def _set_cif_keywords(self, hdu, name, bounds, desc, irf):
"""
Set standard CIF keywords for extension
Parameters
----------
hdu : `~gammalib.GFitsHDU`
FITS HDU
name : str
Calibration name
bounds : list of str
Calibration boundaries
desc : str
Calibration description
irf : dict
IRF metadata dictionary
"""
# Set standard CIF keywords
hdu.card('CSYSNAME', 'XMA_POL', '')
hdu.card('CCLS0001', irf['CAL_CLASS'], 'Calibration class')
hdu.card('CDTP0001', irf['CAL_TYPE'], 'Calibration type')
hdu.card('CCNM0001', name, 'Calibration name')
# Set boundary keywords
for i in range(9):
keyname = 'CBD%d0001' % (i+1)
if i >= len(bounds):
value = 'NONE'
else:
value = bounds[i]
hdu.card(keyname, value, 'Calibration boundary')
# Set validity keywords
hdu.card('CVSD0001', irf['VAL_DATE'],
'Calibration validity start date (UTC)')
hdu.card('CVST0001', irf['VAL_TIME'],
'Calibration validity start time (UTC)')
hdu.card('CDEC0001', desc, 'Calibration description')
# Return
return
# ROOT specific private members
def _root2caldb(self, irf, ds):
"""
Translate ROOT to CALDB information
Parameters
----------
irf : dict
IRF metadata dictionary
ds : dict
Directory structure dictionary
"""
# Open ROOT performance file
tfile = TFile(self['infile'].filename().url())
# Create effective area
self._root2ea(tfile, irf, ds)
# Create point spread function
self._root2psf(tfile, irf, ds)
# Create energy dispersion
self._root2edisp(tfile, irf, ds)
# Create background
self._root2bgd(tfile, irf, ds)
# Return
return
def _root2ea(self, tfile, irf, ds):
"""
Translate ROOT to CALDB effective area extension
The following ROOT histograms are used:
- EffectiveAreaEtrueNoTheta2cut_offaxis -> EFFAREA
- EffectiveAreaEtrueNoTheta2cut (for normalization)
Parameters
----------
tfile : `~ROOT.TFile`
ROOT file
irf : dict
IRF metadata dictionary
ds : dict
Directory structure dictionary
"""
# Write header
self._log_header1(gammalib.TERSE, 'Generate effective area extension')
# Get relevant ROOT histograms
etrue = tfile.Get('EffectiveAreaEtrueNoTheta2cut_offaxis')
# If requested then normalize the 2D histogram on the on-axis 1D
# histogram. This assures that the 2D histogram has the same on-axis
# effective area dependence as the 1D histogram.
if self['norm1d'].boolean():
etrue_1D = tfile.Get('EffectiveAreaEtrueNoTheta2cut')
self._renorm_onaxis(etrue, etrue_1D)
# If requested then rebin the effective area Etrue histogram. This
# increases the number of bins by a factor 10.
if self['rebin'].boolean():
etrue.RebinX(10)
neng = etrue.GetXaxis().GetNbins()
noffset = etrue.GetYaxis().GetNbins()
for ioff in range(noffset):
for ieng in range(neng):
value = etrue.GetBinContent(ieng+1,ioff+1) / 10.0
etrue.SetBinContent(ieng+1,ioff+1,value)
# Get effective area multiplicator. This allows renormalising the
# effective area.
eascale = self['eascale'].real()
# If renormalisation has been requested then do it now
if eascale != 1.0:
neng = etrue.GetXaxis().GetNbins()
noffset = etrue.GetYaxis().GetNbins()
for ioff in range(noffset):
for ieng in range(neng):
value = etrue.GetBinContent(ieng+1,ioff+1) * eascale
etrue.SetBinContent(ieng+1,ioff+1,value)
# Write boundary keywords
self._set_cif_keywords(ds['HDU_EA'], irf['EA_NAME'],
irf['EA_BOUNDS'], irf['EA_DESC'], irf)
# Optionally write energy thresholds
if self['emin'].is_valid():
emin = self['emin'].real()
ds['HDU_EA'].card('LO_THRES', emin, '[TeV] Low energy threshold')
if self['emax'].is_valid():
emin = self['emax'].real()
ds['HDU_EA'].card('HI_THRES', emin, '[TeV] High energy threshold')
# Create "EFFAREA" data column
self._make_2D(etrue, ds['HDU_EA'], 'EFFAREA', 'm2')
# Return
return
def _root2psf(self, tfile, irf, ds):
"""
Translate ROOT to CALDB point spread function extension
Parameters
----------
tfile : `~ROOT.TFile`
ROOT file
irf : dict
IRF metadata dictionary
ds : dict
Directory structure dictionary
"""
# King profile PSF
if self['psftype'].string() == 'King':
self._root2psf_king(tfile, irf, ds)
# ... otherwise use Gaussian profile PSF
else:
self._root2psf_gauss(tfile, irf, ds)
# Return
return
def _root2psf_get_r68_and_r80(self, tfile):
"""
Generates 68% and 80% containment radii histograms from
AngularPSF2DEtrue_offaxis histogram
Parameters
----------
tfile : `~ROOT.TFile`
ROOT file
Returns
-------
r68, r80 : Tuple of `~ROOT.THF2`
68% and 80% containment radius ROOT histograms
"""
# Get relevant ROOT histograms
psf = tfile.Get('AngularPSF2DEtrue_offaxis')
# Extract axes
energies = psf.GetXaxis()
dists = psf.GetYaxis()
offsets = psf.GetZaxis()
# Extract number of bins in histogram
neng = energies.GetNbins()
ndist = dists.GetNbins()
noffset = offsets.GetNbins()
# Create r68 and r80 histograms
r68 = TH2F('AngRes68Etrue_offaxis',
'Angular resolution (68% containment)',
neng, energies.GetBinLowEdge(1), energies.GetBinUpEdge(neng),
noffset, offsets.GetBinLowEdge(1), offsets.GetBinUpEdge(noffset))
r80 = TH2F('AngRes80Etrue_offaxis',
'Angular resolution (80% containment)',
neng, energies.GetBinLowEdge(1), energies.GetBinUpEdge(neng),
noffset, offsets.GetBinLowEdge(1), offsets.GetBinUpEdge(noffset))
# Loop over all energy and offset angle bins
for ieng in range(neng):
for ioff in range(noffset):
# Compute PDF integral
pdf_integral = 0.0
for idist in range(ndist):
pdf_integral += psf.GetBinContent(ieng+1,idist+1,ioff+1)
# Compute 68% containment radius
pdf_68 = 0.0
r68_angle = 0.0
for idist in range(ndist):
pdf_68 += psf.GetBinContent(ieng+1,idist+1,ioff+1)
if pdf_68 > 0.68*pdf_integral:
r68_angle = dists.GetBinLowEdge(idist+1)
break
# Compute 80% containment radius
pdf_80 = 0.0
r80_angle = 0.0
for idist in range(ndist):
pdf_80 += psf.GetBinContent(ieng+1,idist+1,ioff+1)
if pdf_80 > 0.80*pdf_integral:
r80_angle = dists.GetBinLowEdge(idist+1)
break
# Set histogram values
r68.SetBinContent(ieng+1,ioff+1,r68_angle)
r80.SetBinContent(ieng+1,ioff+1,r80_angle)
# Return
return r68, r80
def _root2psf_gauss(self, tfile, irf, ds):
"""
Translate ROOT to CALDB point spread function extension
The following ROOT histograms are used:
- 1/(2*pi*SIGMA_1) -> SCALE
- AngRes_offaxis -> SIGMA_1 (scaling: 1/0.8)
- 0.0 -> AMPL_2
- 0.0 -> SIGMA_2
- 0.0 -> AMPL_3
- 0.0 -> SIGMA_3
Parameters
----------
tfile : `~ROOT.TFile`
ROOT file
irf : dict
IRF metadata dictionary
ds : dict
Directory structure dictionary
"""
# Write header
self._log_header1(gammalib.TERSE,
'Generate Gaussian point spread function extension')
# Get relevant ROOT histograms
#r68 = tfile.Get('AngRes_offaxis')
r68, _ = self._root2psf_get_r68_and_r80(tfile)
# Extract number of bins in histogram
neng = r68.GetXaxis().GetNbins()
noffset = r68.GetYaxis().GetNbins()
# Converts 68% -> 1 sigma
r68_to_sigma = 0.6624305
for ioff in range(noffset):
for ieng in range(neng):
sigma = r68.GetBinContent(ieng+1,ioff+1) * r68_to_sigma
r68.SetBinContent(ieng+1,ioff+1,sigma)
# Compute scale histogram
scale = r68.Clone()
for ioff in range(noffset):
for ieng in range(neng):
integral = 2.0 * math.pi * r68.GetBinContent(ieng+1,ioff+1)
if integral > 0.0:
value = 1.0 / integral
else:
value = 0.0
scale.SetBinContent(ieng+1,ioff+1,value)
# Set zero histogram
zero = r68.Clone()
for ioff in range(noffset):
for ieng in range(neng):
zero.SetBinContent(ieng+1,ioff+1,0.0)
# Set boundaries
irf['PSF_BOUNDS'].append('PSF(GAUSS)')
# Write boundary keywords
self._set_cif_keywords(ds['HDU_PSF'], irf['PSF_NAME'],
irf['PSF_BOUNDS'], irf['PSF_DESC'], irf)
# Create "SCALE" data column
self._make_2D(scale, ds['HDU_PSF'], 'SCALE', '')
# Create "SIGMA_1" data column
self._make_2D(r68, ds['HDU_PSF'], 'SIGMA_1', 'deg')
# Create "AMPL_2" data column
self._make_2D(zero, ds['HDU_PSF'], 'AMPL_2', '')
# Create "SIGMA_2" data column
self._make_2D(zero, ds['HDU_PSF'], 'SIGMA_2', 'deg')
# Create "AMPL_3" data column
self._make_2D(zero, ds['HDU_PSF'], 'AMPL_3', '')
# Create "SIGMA_3" data column
self._make_2D(zero, ds['HDU_PSF'], 'SIGMA_3', 'deg')
# Return
return
def _root2psf_king(self, tfile, irf, ds):
"""
Translate ROOT to CALDB point spread function extension
The following ROOT histograms are used:
- AngRes_offaxis
- AngRes80_offaxis
Parameters
----------
tfile : `~ROOT.TFile`
ROOT file
irf : dict
IRF metadata dictionary
ds : dict
Directory structure dictionary
"""
# Write header
self._log_header1(gammalib.TERSE,
'Generate King point spread function extension')
# Get relevant ROOT histograms
#r68 = tfile.Get('AngRes_offaxis')
#r80 = tfile.Get('AngRes80_offaxis')
r68, r80 = self._root2psf_get_r68_and_r80(tfile)
# Extract number of bins in histogram
neng = r68.GetXaxis().GetNbins()
noffset = r68.GetYaxis().GetNbins()
# Initialise parameter maps by cloning the r68 2D map
gamma2D = r68.Clone()
sigma2D = r68.Clone()
# Compute gamma and sigma values
for ioff in range(noffset):
# Initialise last results
last_gamma = 0.0
last_sigma = 0.0
# Loop over all energies
for ieng in range(neng):
# Extract radii
r_68 = r68.GetBinContent(ieng+1,ioff+1)
r_80 = r80.GetBinContent(ieng+1,ioff+1)
# Initialise results
gamma = 0.0
sigma = 0.0
# Continue only if both radii are positive
if r_68 > 0 and r_80 > 0:
# Derive constants for equation to solve
a = 1.0 - 0.68
b = 1.0 - 0.80
c = r_68*r_68/(r_80*r_80)
# Solve equation (a^x-1)/(b^x-1)=c for x using secant
# method. Stop when we are better than 1e-6.
x1 = -0.5
x2 = -1.0
f1 = (math.pow(a,x1) - 1.0)/(math.pow(b,x1) - 1.0) - c
f2 = (math.pow(a,x2) - 1.0)/(math.pow(b,x2) - 1.0) - c
while True:
x = x1 - f1 * (x1-x2)/(f1-f2)
f = (math.pow(a,x) - 1.0)/(math.pow(b,x) - 1.0) - c
if abs(f) < 1.0e-6:
break
else:
f2 = f1
x2 = x1
f1 = f
x1 = x
# Compute gamma.
if x < 0.0:
gamma = 1.0 - 1.0/x
else:
gamma = 1.0
# Compute sigma
denominator = 2.0 * gamma * (math.pow(a, x) - 1.0)
if denominator > 0.0:
sigma = r_68 * math.sqrt(1.0/denominator)
else:
denominator = 2.0 * gamma * (math.pow(b, x) - 1.0)
if denominator > 0.0:
sigma = r_80 * math.sqrt(1.0/denominator)
else:
gamma = 0.0
sigma = 0.0
# Handle special case that no results were found.
# This takes care of pixels that are ill defined
# in the MC file.
if gamma == 0.0 and sigma == 0.0:
gamma = last_gamma
sigma = last_sigma
status = ' (use last)'
else:
status = ''
# Log results
self._log_value(gammalib.EXPLICIT,
'ieng=%d ioff=%d%s' % (ieng,ioff,status),
'r68=%f r80=%f gamma=%f sigma=%f' %
(r_68, r_80, gamma, sigma))
# Store surrent result as last result
last_gamma = gamma
last_sigma = sigma
# Set bin contents
gamma2D.SetBinContent(ieng+1,ioff+1,gamma)
sigma2D.SetBinContent(ieng+1,ioff+1,sigma)
# Set boundaries
irf['PSF_BOUNDS'].append('PSF(KING)')
# Write boundary keywords
self._set_cif_keywords(ds['HDU_PSF'], irf['PSF_NAME'],
irf['PSF_BOUNDS'], irf['PSF_DESC'], irf)
# Create "GAMMA" data column
self._make_2D(gamma2D, ds['HDU_PSF'], 'GAMMA', '')
# Create "SIGMA" data column
self._make_2D(sigma2D, ds['HDU_PSF'], 'SIGMA', 'deg')
# Return
return
def _root2edisp_get_migra(self, tfile):
"""
Generates migration matrix histogram from AngularPSF2DEtrue_offaxis
histogram
Parameters
----------
tfile : `~ROOT.TFile`
ROOT file
Returns
-------
migra : `~ROOT.TH3F`
Migration matrix
"""
# Get relevant ROOT histograms
matrix = tfile.Get('MigMatrixNoTheta2cut_offaxis')
# Extract axes
ereco = matrix.GetXaxis()
etrue = matrix.GetYaxis()
offsets = matrix.GetZaxis()
# Extract number of bins in histogram
nereco = ereco.GetNbins()
netrue = etrue.GetNbins()
noffset = offsets.GetNbins()
# Set number of migration bins
nmigra = 300
# Create migra histograms
migra = TH3F('EestOverEtrue_offaxis',
'Migration',
netrue, etrue.GetBinLowEdge(1), etrue.GetBinUpEdge(netrue),
nmigra, 0.0, 3.0,
noffset, offsets.GetBinLowEdge(1), offsets.GetBinUpEdge(noffset))
# Loop over true energies
for ietrue in range(netrue):
# Get true energy in TeV
e_true = math.pow(10.0, migra.GetXaxis().GetBinCenter(ietrue+1))
# Loop over migration values
for imigra in range(nmigra):
# Get migration value
migration = migra.GetYaxis().GetBinCenter(imigra+1)
# Compute reconstructed energy in TeV
e_reco = e_true * migration
# Continue only if reconstructed energy is positive
if e_reco > 0.0:
# Get reconstructed bin
ireco = ereco.FindFixBin(math.log10(e_reco))
# Continue only if bin is valid
if ireco > 0 and ireco <= nereco:
# Loop over offset angles
for ioff in range(noffset):
# Get bin value
value = matrix.GetBinContent(ireco,ietrue+1,ioff+1)
# Set bin value
migra.SetBinContent(ietrue+1,imigra+1,ioff+1,value)
# Return
return migra
def _root2edisp(self, tfile, irf, ds):
"""
Translate ROOT to CALDB energy dispersion extension
The following ROOT histograms are used:
- EestOverEtrue_offaxis -> MATRIX
Parameters
----------
tfile : `~ROOT.TFile`
ROOT file
irf : dict
IRF metadata dictionary
ds : dict
Directory structure dictionary
"""
# Write header
self._log_header1(gammalib.TERSE, 'Generate energy dispersion extension')
# Get relevant ROOT histograms
matrix = self._root2edisp_get_migra(tfile)
#matrix = tfile.Get('EestOverEtrue_offaxis')
# Write boundary keywords
self._set_cif_keywords(ds['HDU_EDISP'], irf['EDISP_NAME'],
irf['EDISP_BOUNDS'], irf['EDISP_DESC'], irf)
# Create "MATRIX" data column
self._make_3D_migra(matrix, ds['HDU_EDISP'], 'MATRIX', '')
# Return
return
def _root2bgd(self, tfile, irf, ds):
"""
Translate ROOT to CALDB background extension.
The following ROOT histograms are used:
- BGRatePerSqDeg_offaxis -> BGD
Parameters
----------
tfile : `~ROOT.TFile`
ROOT file
irf : dict
IRF metadata dictionary
ds : dict
Directory structure dictionary
"""
# Write header
self._log_header1(gammalib.TERSE, 'Generate 3D background extension')
# Get relevant ROOT histograms
array = tfile.Get('BGRatePerSqDeg_offaxis')
# Replace 2D histogram values by power law extrapolation
self._plaw_replace(array, self['bgdethres'].real())
# If requested then fill-in empty values in 2D histogram
if self['bgdinfill'].boolean():
self._infill_bgd(array)
# If requested then normalize the 2D histogram on the on-axis 1D
# histogram. This assures that the 2D histogram has the same on-axis
# effective area dependence as the 1D histogram.
if self['norm1d'].boolean():
array_1D = tfile.Get('BGRatePerSqDeg')
self._renorm_onaxis(array, array_1D)
# Write boundary keywords
self._set_cif_keywords(ds['HDU_BGD'], irf['BGD_NAME'],
irf['BGD_BOUNDS'], irf['BGD_DESC'], irf)
# Create "BGD" data column
self._make_3D(array, ds['HDU_BGD'], 'BGD', '1/s/MeV/sr')
# Return
return
def _append_column_axis(self, hdu, name, unit, axis, log=False):
"""
Append column of ROOT axis values to HDU
Parameters
----------
hdu : `~gammalib.GFitsHDU`
FITS HDU
name : str
Column name
unit : str
Column unit
axis : `~ROOT.TAxis`
ROOT histogram axis
log : bool, optional
Axis is logarithmic
"""
# Continue only if columns does not yet exist
if not hdu.contains(name):
# Write header
self._log_header3(gammalib.TERSE, 'Append axis column "%s"' % name)
# Get number of axis bins
nbins = axis.GetNbins()
# Append column and set column unit
hdu.append(gammalib.GFitsTableFloatCol(name, 1, nbins))
hdu[name].unit(unit)
# Do we have a LO axis? If not we have a HI axis
if name[-2:] == 'LO':
low = True
else:
low = False
# Fill column
for i in range(nbins):
if low:
value = axis.GetBinLowEdge(i+1)
else:
value = axis.GetBinUpEdge(i+1)
if log:
value = pow(10.0, value)
hdu[name][0,i] = value
# Log values
self._log_value(gammalib.NORMAL, 'Number of axis bins', nbins)
self._log_value(gammalib.NORMAL, 'Unit', unit)
# Return
return
def _append_column_values(self, hdu, name, unit, values):
"""
Append column of values to HDU
Parameters
----------
hdu : `~gammalib.GFitsHDU`
FITS HDU
name : str
Column name
unit : str
Column unit
values : list of float
Axis values
"""
# Continue only if columns does not yet exist
if not hdu.contains(name):
# Write header
self._log_header3(gammalib.TERSE, 'Append value column "%s"' % name)
# Get number of values
nbins = len(values)
# Append column and set column unit
hdu.append(gammalib.GFitsTableFloatCol(name, 1, nbins))
hdu[name].unit(unit)
# Fill column
for i in range(nbins):
hdu[name][0,i] = values[i]
# Log values
self._log_value(gammalib.NORMAL, 'Number of values', nbins)
self._log_value(gammalib.NORMAL, 'Unit', unit)
# Return
return
def _renorm_onaxis(self, hist2D, hist1D):
"""
Renormalise 2D histogram (energy,offset) on 1D histogram (energy)
This method makes sure that a 2D histogram has the same onaxis values
as the corresponding 1D histogram.
Parameters
----------
hist2D : `~ROOT.TH2F`
ROOT 2D histogram
hist1D : `~ROOT.TH1F`
ROOT 1D histogram
"""
# Get 2D dimensions
neng = hist2D.GetXaxis().GetNbins()
noffset = hist2D.GetYaxis().GetNbins()
# Continue only if the 1D and 2D histograms have the same number
# of energy bins
if neng != hist1D.GetXaxis().GetNbins():
# Log if energy binning differs
self._log_value(gammalib.TERSE, 'On-axis normalisation',
'Impossible since energy binning of 1D histogram '
'"%s" does not match that of 2D histogram "%s".' %
(hist1D.GetName(), hist2D.GetName()))
else:
# Log on-axis normalisation
self._log_value(gammalib.TERSE, 'On-axis normalisation',
'On-axis values of 1D histogram "%s" imposed on '
'2D histogram "%s".' %
(hist1D.GetName(), hist2D.GetName()))
# Get a copy of 2D histogram
hist2D_copy = hist2D.Clone()
# Divide 2D histogram by onaxis values to remove the energy
# dependence
for ieng in range(neng):
onaxis = hist1D.GetBinContent(ieng+1)
if onaxis > 0.0:
for ioff in range(noffset):
value = hist2D.GetBinContent(ieng+1,ioff+1) / onaxis
hist2D.SetBinContent(ieng+1,ioff+1,value)
# Smooth in energy direction to reduce statistical fluctuations
for ieng in range(neng):
for ioff in range(noffset):
if ieng == 0:
value = (2.0 * hist2D.GetBinContent(ieng+1,ioff+1) +
1.0 * hist2D.GetBinContent(ieng+2,ioff+1)) / 3.0
elif ieng == neng-1:
value = (2.0 * hist2D.GetBinContent(ieng+1,ioff+1) +
1.0 * hist2D.GetBinContent(ieng+0,ioff+1)) / 3.0
else:
value = (2.0 * hist2D.GetBinContent(ieng+1,ioff+1) +
1.0 * hist2D.GetBinContent(ieng+0,ioff+1) +
1.0 * hist2D.GetBinContent(ieng+2,ioff+1)) / 4.0
hist2D_copy.SetBinContent(ieng+1,ioff+1,value)
# Normalize now for an onaxis value of 1
for ieng in range(neng):
onaxis = hist2D_copy.GetBinContent(ieng+1,1)
if onaxis > 0.0:
for ioff in range(noffset):
value = hist2D_copy.GetBinContent(ieng+1,ioff+1) / onaxis
hist2D_copy.SetBinContent(ieng+1,ioff+1,value)
# Put back the energy dependence
for ieng in range(neng):
onaxis = hist1D.GetBinContent(ieng+1)
for ioff in range(noffset):
value = hist2D_copy.GetBinContent(ieng+1,ioff+1) * onaxis
hist2D.SetBinContent(ieng+1,ioff+1,value)
# Return
return
def _plaw_replace(self, hist2D, ethres):
"""
Replace background rate values by power law values
Parameters
----------
hist2D : `~ROOT.TH2F`
ROOT 2D histogram
ethres : float
Energy threshold
"""
# Extract energy and offset angle vectors
energies = hist2D.GetXaxis()
neng = energies.GetNbins()
offsets = hist2D.GetYaxis()
noffset = offsets.GetNbins()
# Continue only if threshold is low enough
if ethres < math.pow(10.0, energies.GetBinUpEdge(neng)):
# Determine mean energy values
engs = []
for ieng in range(neng):
energy = 0.5 * (math.pow(10.0, energies.GetBinLowEdge(ieng+1)) +
math.pow(10.0, energies.GetBinUpEdge(ieng+1)))
engs.append(energy)
# Loop over all offaxis angles
for ioff in range(noffset):
# Determine offset angle (for logging)
offset = 0.5 * (offsets.GetBinLowEdge(ioff+1) +
offsets.GetBinUpEdge(ioff+1))
# Initialise vectors
axis = []
rates = []
# Extract values
for ieng in range(neng):
energy = engs[ieng]
rate = hist2D.GetBinContent(ieng+1,ioff+1)
axis.append(energy)
rates.append(rate)
# Determine minimum energy (ignoring the maximum energy as
# we do not need it)
emin = self._plaw_energy_range(axis, rates)[0]
# Get power law coefficients
coeff = self._plaw_coefficients(axis, rates, emin, ethres)
# Replace histogram values by power law values if coefficients
# are valid
if coeff['m'] != 0.0 and coeff['t'] != 0.0:
for ieng in range(neng):
energy = engs[ieng]
if energy > ethres:
value = self._plaw_value(coeff, energy)
hist2D.SetBinContent(ieng+1,ioff+1,value)
# Log power law replacement
self._log_value(gammalib.NORMAL,
'Power law replacement',
'%e cts/s/deg2 (E=%8.4f TeV (%d) '
'Off=%.2f deg (%d)' %
(value,engs[ieng],ieng,offset,ioff))
# Return
return
def _plaw_energy_range(self, energies, rates):
"""
Determine the energy range over which the power law is valid
Parameters
----------
energies : list of float
Energy values (TeV)
rates : list of float
Background rate values
"""
# Find energy at which background rate takes a maximum
min_energy = 0.0
max_rate = 0.0
for ieng, energy in enumerate(energies):
if rates[ieng] > max_rate:
max_rate = rates[ieng]
min_energy = energy
# Find last data point
max_energy = 0.0
for ieng in range(len(energies)-1,-1,-1):
if rates[ieng] > 0.0:
max_energy = energies[ieng]
break
# Return
return (min_energy, max_energy)
def _plaw_coefficients(self, energies, rates, emin, emax):
"""
Determines the power law coefficients
Parameters
----------
energies : list of float
Energy values (TeV)
rates : list of float
Background rate values
emin : float
Minimum energy (TeV)
emax : float
Maximum energy (TeV)
"""
# Determine nearest energy indices
i_emin = 0
i_emax = 0
delta_emin = 1.0e30
delta_emax = 1.0e30
for ieng, energy in enumerate(energies):
if abs(energy-emin) < delta_emin:
delta_emin = abs(energy-emin)
i_emin = ieng
if abs(energy-emax) < delta_emax:
delta_emax = abs(energy-emax)
i_emax = ieng
# Determine coefficients of power law
while rates[i_emax] == 0.0 and i_emax > i_emin:
i_emax -= 1
if rates[i_emax] > 0.0:
x1 = math.log10(energies[i_emin])
x2 = math.log10(energies[i_emax])
y1 = math.log10(rates[i_emin])
y2 = math.log10(rates[i_emax])
m = (y2-y1)/(x2-x1)
t = y1 - m * x1
else:
m = 0.0
t = 0.0
# Return coefficients
return {'m': m, 't': t}
def _plaw_value(self, coeff, energy):
"""
Determine the power law value
Parameters
----------
coeff : dict
Dictionary of coefficients
energy : float
Energy value (TeV)
"""
# Compute value
value = math.pow(10.0, coeff['m'] * math.log10(energy) + coeff['t'])
# Return value
return value
def _infill_bgd(self, hist2D):
"""
Fill all empty bins in 2D histogram by preceeding values in energy
Parameters
----------
hist2D : `~ROOT.TH2F`
ROOT 2D histogram
"""
# Extract energy and offset angle vectors
energies = hist2D.GetXaxis()
neng = energies.GetNbins()
offsets = hist2D.GetYaxis()
noffset = offsets.GetNbins()
# Determine mean energy values (for logging)
engs = []
for ieng in range(neng):
energy = 0.5 * (math.pow(10.0, energies.GetBinLowEdge(ieng+1)) +
math.pow(10.0, energies.GetBinUpEdge(ieng+1)))
engs.append(energy)
# Loop over all offaxis angles
for ioff in range(noffset):
# Determine offset angle (for logging)
offset = 0.5 * (offsets.GetBinLowEdge(ioff+1) +
offsets.GetBinUpEdge(ioff+1))
# Initialise indices and value
i_start = -1
i_stop = -1
value = 0.0
# First start and stop indices for infill
for ieng in range(neng):
if hist2D.GetBinContent(ieng+1,ioff+1) > 0.0:
i_start = ieng
value = hist2D.GetBinContent(ieng+1,ioff+1)
break
for ieng in range(neng-1, -1, -1):
if hist2D.GetBinContent(ieng+1,ioff+1) > 0.0:
i_stop = ieng
break
# If indices are valid then fill in background rates
if i_start > -1 and i_stop > -1:
for ieng in range(i_start, i_stop+1):
if hist2D.GetBinContent(ieng+1,ioff+1) == 0.0:
hist2D.SetBinContent(ieng+1,ioff+1,value)
# Log background infill
self._log_value(gammalib.NORMAL,
'Background infill',
'%e cts/s/deg2 (E=%8.4f TeV (%d) '
'Off=%.2f deg (%d)' %
(value,engs[ieng],ieng,offset,ioff))
else:
value = hist2D.GetBinContent(ieng+1,ioff+1)
# Return
return
def _make_2D(self, array, hdu, name, unit, scale=1.0):
"""
Make 2D data column as function of energy and offset angle
If the HDU has already the energy and offset angle columns, this method
will simply add another data column. If name==None, the method will not
append any data column.
Parameters
----------
array : `~ROOT.TH2F`
ROOT 2D histogram
hdu : `~gammalib.GFitsHDU`
FITS HDU
name : str
Data column name
unit : str
Data unit
scale : float, optional
Scaling factor for histogram values
"""
# Write header
self._log_header3(gammalib.TERSE, 'Make 2D data column "%s"' % name)
# Extract energy and offset angle vectors
energies = array.GetXaxis()
offsets = array.GetYaxis()
neng = energies.GetNbins()
noffset = offsets.GetNbins()
# Log parameters
self._log_value(gammalib.NORMAL, 'Number of energies', neng)
self._log_value(gammalib.NORMAL, 'Number of offsets', noffset)
# Append axis columns to HDU
self._append_column_axis(hdu, 'ENERG_LO', 'TeV', energies, log=True)
self._append_column_axis(hdu, 'ENERG_HI', 'TeV', energies, log=True)
self._append_column_axis(hdu, 'THETA_LO', 'deg', offsets)
self._append_column_axis(hdu, 'THETA_HI', 'deg', offsets)
# Append array column
if name != None and not hdu.contains(name):
hdu.append(gammalib.GFitsTableFloatCol(name, 1, neng*noffset))
hdu[name].unit(unit)
hdu[name].dim([neng, noffset])
for ioff in range(noffset):
for ieng in range(neng):
index = ieng + ioff * neng
value = array.GetBinContent(ieng+1,ioff+1)
hdu[name][0,index] = value * scale
# Collect boundary information
bd_eng = 'ENERG(%.4f-%.2f)TeV' % \
(pow(10.0, energies.GetBinLowEdge(1)), \
pow(10.0, energies.GetBinUpEdge(neng)))
bd_off = 'THETA(%.2f-%.2f)deg' % \
(offsets.GetBinLowEdge(1), \
offsets.GetBinUpEdge(noffset))
bd_phi = 'PHI(0-360)deg'
bounds = [bd_eng, bd_off, bd_phi]
# Return boundary information
return bounds
def _make_3D(self, array, hdu, name, unit):
"""
Make 3D data column as function of DETX, DETY and energy
If the HDU has already the energy and offset angle columns, this method
will simply add another data column. If name==None, the method will not
append any data column.
Parameters
----------
array : `~ROOT.TH2F`
ROOT 2D histogram
hdu : `~gammalib.GFitsHDU`
FITS HDU
name : str
Data column name
unit : str
Data unit
"""
# Write header
self._log_header3(gammalib.TERSE, 'Make 3D data column "%s"' % name)
# Get User parameters
scale = self['bgdscale'].real()
oversample = self['bgdoversample'].integer()
# Set constants
deg2sr = 0.01745329*0.01745329
# Extract energy and offset angle vectors
energies = array.GetXaxis()
neng = energies.GetNbins()
offsets = array.GetYaxis()
noffset = offsets.GetNbins()
theta_max = offsets.GetBinUpEdge(noffset) # Maximum theta
ewidth = [] # in MeV
for ieng in range(neng):
ewidth.append(pow(10.0, energies.GetBinUpEdge(ieng+1) +6.0) -
pow(10.0, energies.GetBinLowEdge(ieng+1)+6.0))
# Log parameters
self._log_value(gammalib.NORMAL, 'Scale', scale)
self._log_value(gammalib.NORMAL, 'Oversample', oversample)
self._log_value(gammalib.NORMAL, 'Number of energies', neng)
self._log_value(gammalib.NORMAL, 'Number of offsets', noffset)
self._log_value(gammalib.NORMAL, 'Maximum offset', theta_max)
# Build DETX and DETY axes
ndet = array.GetYaxis().GetNbins()
ndets = 2*ndet*oversample
det_max = array.GetYaxis().GetBinUpEdge(ndet)
det_bin = det_max/float(ndet*oversample)
dets_lo = []
dets_hi = []
dets2 = []
for i in range(ndets):
det_lo = -det_max + i*det_bin
det_hi = det_lo + det_bin
det_val = 0.5*(det_lo + det_hi)
dets_lo.append(det_lo)
dets_hi.append(det_hi)
dets2.append(det_val*det_val)
# Log parameters
self._log_value(gammalib.NORMAL, 'Number of DETXY bins', ndets)
self._log_value(gammalib.NORMAL, 'Maximum DETXY', det_max)
self._log_value(gammalib.NORMAL, 'DETXY binsize', det_bin)
# Append DETX_LO, DETX_HI, DETY_LO and DETY_HI columns
self._append_column_values(hdu, 'DETX_LO', 'deg', dets_lo)
self._append_column_values(hdu, 'DETX_HI', 'deg', dets_hi)
self._append_column_values(hdu, 'DETY_LO', 'deg', dets_lo)
self._append_column_values(hdu, 'DETY_HI', 'deg', dets_hi)
# Append ENERG_LO and ENERG_HI columns
self._append_column_axis(hdu, 'ENERG_LO', 'TeV', energies, log=True)
self._append_column_axis(hdu, 'ENERG_HI', 'TeV', energies, log=True)
# Append array column
if name != None and not hdu.contains(name):
hdu.append(gammalib.GFitsTableFloatCol(name, 1, ndets*ndets*neng))
hdu[name].unit(unit)
hdu[name].dim([ndets,ndets,neng])
for ix in range(ndets):
for iy in range(ndets):
for ieng in range(neng):
index = ix + (iy + ieng * ndets) * ndets
theta = math.sqrt(dets2[ix] + dets2[iy])
if theta < theta_max:
binsq = array.Interpolate(energies.GetBinCenter(ieng+1),
theta)
value = binsq / deg2sr / (ewidth[ieng])
hdu[name][0,index] = value * scale
# Collect boundary information
bd_detx = 'DETX(%.2f-%.2f)deg' % (-det_max, det_max)
bd_dety = 'DETY(%.2f-%.2f)deg' % (-det_max, det_max)
bd_eng = 'ENERG(%.4f-%.2f)TeV' % \
(pow(10.0, energies.GetBinLowEdge(1)),
pow(10.0, energies.GetBinUpEdge(neng)))
bounds = [bd_detx, bd_dety, bd_eng]
# Return boundary information
return bounds
def _make_3D_migra(self, array, hdu, name, unit, scale=1.0):
"""
Make 3D data column as function of ETRUE, MIGRA and THETA
If the HDU has already the energy and offset angle columns, this method
will simply add another data column. If name==None, the method will not
append any data column.
Parameters
----------
array : `~ROOT.TH3F`
ROOT 2D histogram
hdu : `~gammalib.GFitsHDU`
FITS HDU
name : str
Data column name
unit : str
Data unit
scale : float, optional
Scaling factor for histogram values
"""
# Write header
self._log_header3(gammalib.TERSE,
'Make 3D migration matrix data column "%s"' % name)
# Extract Etrue, Eobs/Etrue and offset angle vectors
etrue = array.GetXaxis()
netrue = etrue.GetNbins()
migra = array.GetYaxis()
nmigra = migra.GetNbins()
offsets = array.GetZaxis()
noffset = offsets.GetNbins()
ewidth = [] # in MeV
for ieng in range(netrue):
ewidth.append(pow(10.0, etrue.GetBinUpEdge(ieng+1) +6.0) - \
pow(10.0, etrue.GetBinLowEdge(ieng+1)+6.0))
# Log parameters
self._log_value(gammalib.NORMAL, 'Number of energies', netrue)
self._log_value(gammalib.NORMAL, 'Number of migrations', nmigra)
self._log_value(gammalib.NORMAL, 'Number of offsets', noffset)
# Append axis columns to HDU
self._append_column_axis(hdu, 'ETRUE_LO', 'TeV', etrue, log=True)
self._append_column_axis(hdu, 'ETRUE_HI', 'TeV', etrue, log=True)
self._append_column_axis(hdu, 'MIGRA_LO', '', migra)
self._append_column_axis(hdu, 'MIGRA_HI', '', migra)
self._append_column_axis(hdu, 'THETA_LO', 'deg', offsets)
self._append_column_axis(hdu, 'THETA_HI', 'deg', offsets)
# Append migration matrix to HDU
if name != None and not hdu.contains(name):
hdu.append(gammalib.GFitsTableFloatCol(name, 1, netrue*nmigra*noffset))
hdu[name].unit(unit)
hdu[name].dim([netrue, nmigra, noffset])
for ioff in range(noffset):
for imigra in range(nmigra):
for ieng in range(netrue):
index = ieng + (imigra + ioff * nmigra) * netrue
value = array.GetBinContent(ieng+1,imigra+1,ioff+1)
hdu[name][0,index] = value * scale
# Collect boundary information
bd_eng = 'ETRUE(%.4f-%.2f)TeV' % \
(pow(10.0, etrue.GetBinLowEdge(1)),
pow(10.0, etrue.GetBinUpEdge(netrue)))
bd_migra = 'MIGRA(%.3f-%.3f)' % \
(migra.GetBinLowEdge(1),
migra.GetBinUpEdge(nmigra))
bd_off = 'THETA(%.2f-%.2f)deg' % \
(offsets.GetBinLowEdge(1),
offsets.GetBinUpEdge(noffset))
bd_phi = 'PHI(0-360)deg'
bounds = [bd_eng, bd_migra, bd_off, bd_phi]
# Return boundary information
return bounds
# Public methods
def run(self):
"""
Run the script
"""
# Warn if ROOT module is missing
if not _has_root:
gammalib.warning('csroot2caldb', 'ROOT Python module not present, '
'script will create empty IRF.')
# Switch screen logging on in debug mode
if self._logDebug():
self._log.cout(True)
# Get parameters
self._get_parameters()
# Initialise IRF metadata
irf = self._init_metadata()
# Create directory structure
ds = self._make_dirs('file', irf)
# Open calibration files
self._open(irf, ds)
# Translate ROOT to CALDB information
if _has_root:
self._root2caldb(irf, ds)
# Close calibration files
self._close(irf, ds)
# Return
return
# ======================== #
# Main routine entry point #
# ======================== #
if __name__ == '__main__':
# Create instance of application
app = csroot2caldb(sys.argv)
# Execute application
app.execute()