GCTAObservation.cpp
57.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
/***************************************************************************
* GCTAObservation.cpp - CTA Observation class *
* ----------------------------------------------------------------------- *
* copyright (C) 2010-2016 by Juergen Knoedlseder *
* ----------------------------------------------------------------------- *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
* *
***************************************************************************/
/**
* @file GCTAObservation.cpp
* @brief CTA observation class implementation
* @author Juergen Knoedlseder
*/
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <typeinfo>
#include "GObservationRegistry.hpp"
#include "GException.hpp"
#include "GFits.hpp"
#include "GFilename.hpp"
#include "GGti.hpp"
#include "GTools.hpp"
#include "GIntegral.hpp"
#include "GCTASupport.hpp"
#include "GCTAObservation.hpp"
#include "GCTAResponseIrf.hpp"
#include "GCTAResponseCube.hpp"
#include "GCTAEventList.hpp"
#include "GCTAEventCube.hpp"
#include "GCTARoi.hpp"
/* __ Globals ____________________________________________________________ */
const GCTAObservation g_obs_cta_seed(true, "CTA");
const GCTAObservation g_obs_hess_seed(true, "HESS");
const GCTAObservation g_obs_magic_seed(true, "MAGIC");
const GCTAObservation g_obs_veritas_seed(true, "VERITAS");
const GObservationRegistry g_obs_cta_registry(&g_obs_cta_seed);
const GObservationRegistry g_obs_hess_registry(&g_obs_hess_seed);
const GObservationRegistry g_obs_magic_registry(&g_obs_magic_seed);
const GObservationRegistry g_obs_veritas_registry(&g_obs_veritas_seed);
/* __ Method name definitions ____________________________________________ */
#define G_RESPONSE_SET "GCTAObservation::response(GResponse&)"
#define G_RESPONSE_GET "GCTAObservation::response()"
#define G_ROI "GCTAObservation::roi()"
#define G_GTI "GCTAObservation::gti()"
#define G_EBOUNDS "GCTAObservation::ebounds()"
#define G_READ "GCTAObservation::read(GXmlElement&)"
#define G_WRITE "GCTAObservation::write(GXmlElement&)"
#define G_LOAD1 "GCTAObservation::load(GFilename&, GFilename&, "\
"GFilename&, GFilename&)"
#define G_LOAD2 "GCTAObservation::load(GFilename&, GFilename&, "\
"GFilename&, GFilename&, GFilename&)"
/* __ Macros _____________________________________________________________ */
/* __ Coding definitions _________________________________________________ */
/* __ Debug definitions __________________________________________________ */
/*==========================================================================
= =
= Constructors/destructors =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Void constructor
*
* Constructs an empty CTA observation.
***************************************************************************/
GCTAObservation::GCTAObservation(void) : GObservation()
{
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Instrument constructor
*
* @param[in] dummy Dummy flag.
* @param[in] instrument Instrument name.
*
* Constructs an empty CTA observation for a given instrument.
*
* This method is specifically used allocation of global class instances for
* observation registry. By specifying explicit instrument names it is
* possible to use the "CTA" module are for other Imaging Air Cherenkov
* Telescopes. So far, the following instrument codes are supported:
* "CTA", "HESS", "VERITAS", "MAGIC".
***************************************************************************/
GCTAObservation::GCTAObservation(const bool& dummy,
const std::string& instrument) :
GObservation()
{
// Initialise members
init_members();
// Set instrument
m_instrument = instrument;
// Return
return;
}
/***********************************************************************//**
* @brief Unbinned or binned analysis constructor
*
* @param[in] filename Event list or counts cube FITS file name.
*
* Constructs a CTA observation from either an event list of a counts cube.
***************************************************************************/
GCTAObservation::GCTAObservation(const GFilename& filename) : GObservation()
{
// Initialise members
init_members();
// Load data
load(filename);
// Return
return;
}
/***********************************************************************//**
* @brief Stacked analysis constructor
*
* @param[in] cntcube Counts cube file name.
* @param[in] expcube Exposure cube file name.
* @param[in] psfcube Point spread function cube file name.
* @param[in] bkgcube Background cube file name.
*
* Constructs a CTA observation from a counts cube, an exposure cube, a point
* spread function cube, and a background cube.
***************************************************************************/
GCTAObservation::GCTAObservation(const GFilename& cntcube,
const GFilename& expcube,
const GFilename& psfcube,
const GFilename& bkgcube) : GObservation()
{
// Initialise members
init_members();
// Load data
load(cntcube, expcube, psfcube, bkgcube);
// Return
return;
}
/***********************************************************************//**
* @brief Stacked analysis with energy dispersion constructor
*
* @param[in] cntcube Counts cube file name.
* @param[in] expcube Exposure cube file name.
* @param[in] psfcube Point spread function cube file name.
* @param[in] edispcube Energy dispersion cube file name.
* @param[in] bkgcube Background cube file name.
*
* Constructs a CTA observation from a counts cube, an exposure cube, a point
* spread function cube, an energy dispersion cube, and a background cube.
***************************************************************************/
GCTAObservation::GCTAObservation(const GFilename& cntcube,
const GFilename& expcube,
const GFilename& psfcube,
const GFilename& edispcube,
const GFilename& bkgcube) : GObservation()
{
// Initialise members
init_members();
// Load data
load(cntcube, expcube, psfcube, edispcube, bkgcube);
// Return
return;
}
/***********************************************************************//**
* @brief Copy constructor
*
* @param[in] obs CTA observation.
*
* Constructs a CTA observation by copying an existing CTA observation.
***************************************************************************/
GCTAObservation::GCTAObservation(const GCTAObservation& obs) : GObservation(obs)
{
// Initialise members
init_members();
// Copy members
copy_members(obs);
// Return
return;
}
/***********************************************************************//**
* @brief Destructor
*
* Destructs CTA observation.
***************************************************************************/
GCTAObservation::~GCTAObservation(void)
{
// Free members
free_members();
// Return
return;
}
/*==========================================================================
= =
= Operators =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Assignment operator
*
* @param[in] obs CTA observation.
*
* Assign CTA observation to this object.
***************************************************************************/
GCTAObservation& GCTAObservation::operator=(const GCTAObservation& obs)
{
// Execute only if object is not identical
if (this != &obs) {
// Copy base class members
this->GObservation::operator=(obs);
// Free members
free_members();
// Initialise members
init_members();
// Copy members
copy_members(obs);
} // endif: object was not identical
// Return this object
return *this;
}
/*==========================================================================
= =
= Public methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Clear CTA observation
*
* Clear CTA observation.
***************************************************************************/
void GCTAObservation::clear(void)
{
// Free members
free_members();
this->GObservation::free_members();
// Initialise members
this->GObservation::init_members();
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Clone CTA observation
*
* @return Pointer to deep copy of CTA observation.
*
* Returns a pointer to a deep copy of a CTA observation.
***************************************************************************/
GCTAObservation* GCTAObservation::clone(void) const
{
return new GCTAObservation(*this);
}
/***********************************************************************//**
* @brief Set response function
*
* @param[in] rsp Response function.
*
* @exception GException::invalid_argument
* Invalid response class specified.
*
* Sets the response function for the observation.
***************************************************************************/
void GCTAObservation::response(const GResponse& rsp)
{
// Cast response dynamically
const GCTAResponse* ptr = dynamic_cast<const GCTAResponse*>(&rsp);
// Throw exception if response is not of correct type
if (ptr == NULL) {
std::string cls = std::string(typeid(&rsp).name());
std::string msg = "Invalid response type \""+cls+"\" provided on "
"input. Please specify a \"GCTAResponse\" "
"object as argument.";
throw GException::invalid_argument(G_RESPONSE_SET, msg);
}
// Free response
if (m_response != NULL) delete m_response;
// Clone response function
m_response = ptr->clone();
// Return
return;
}
/***********************************************************************//**
* @brief Return pointer to CTA response function
*
* @return Pointer to CTA response function.
*
* @exception GException::invalid_value
* No valid response found in CTA observation.
*
* Returns a pointer to the CTA response function. An exception is thrown if
* the pointer is not valid, hence the user does not need to verify the
* validity of the pointer.
***************************************************************************/
const GCTAResponse* GCTAObservation::response(void) const
{
// Throw an exception if the response pointer is not valid
if (m_response == NULL) {
std::string msg = "No valid response function found in CTA "
"observation.\n";
throw GException::invalid_value(G_RESPONSE_GET, msg);
}
// Return pointer
return m_response;
}
/***********************************************************************//**
* @brief Set CTA response function
*
* @param[in] rspname Response name.
* @param[in] caldb Calibration database.
*
* Sets the CTA response function by specifying a response name and a
* calibration database. This method also loads the response function so that
* it is available for data analysis.
***************************************************************************/
void GCTAObservation::response(const std::string& rspname, const GCaldb& caldb)
{
// Free response
if (m_response != NULL) delete m_response;
m_response = NULL;
// Allocate fresh response function
GCTAResponseIrf* rsp = new GCTAResponseIrf;
// Set calibration database
rsp->caldb(caldb);
// Load instrument response function
rsp->load(rspname);
// Store pointer
m_response = rsp;
// Return
return;
}
/***********************************************************************//**
* @brief Set CTA response function
*
* @param[in] expcube Exposure cube.
* @param[in] psfcube Psf cube.
* @param[in] bkgcube Background cube.
*
* Sets the CTA response function fur cube analysis by specifying the
* exposure cube, the Psf cube and the background cube. The method also
* copies over the ontime, the livetime and the deadtime correction factor
* from the exposure cube.
***************************************************************************/
void GCTAObservation::response(const GCTACubeExposure& expcube,
const GCTACubePsf& psfcube,
const GCTACubeBackground& bkgcube)
{
// Free response
if (m_response != NULL) delete m_response;
m_response = NULL;
// Allocate fresh response function
GCTAResponseCube* rsp = new GCTAResponseCube(expcube, psfcube, bkgcube);
// Store pointer
m_response = rsp;
// Copy over time information from exposure cube
ontime(expcube.ontime());
livetime(expcube.livetime());
deadc(expcube.deadc());
// Return
return;
}
/***********************************************************************//**
* @brief Set CTA response function
*
* @param[in] expcube Exposure cube.
* @param[in] psfcube Psf cube.
* @param[in] edispcube Edisp cube.
* @param[in] bkgcube Background cube.
*
* Sets the CTA response function fur cube analysis by specifying the
* exposure cube, the Psf cube, the exposure cube and the background cube.
* The method also copies over the ontime, the livetime and the deadtime
* correction factor from the exposure cube.
***************************************************************************/
void GCTAObservation::response(const GCTACubeExposure& expcube,
const GCTACubePsf& psfcube,
const GCTACubeEdisp& edispcube,
const GCTACubeBackground& bkgcube)
{
// Free response
if (m_response != NULL) delete m_response;
m_response = NULL;
// Allocate fresh response function
GCTAResponseCube* rsp = new GCTAResponseCube(expcube,
psfcube,
edispcube,
bkgcube);
// Store pointer
m_response = rsp;
// Copy over time information from exposure cube
ontime(expcube.ontime());
livetime(expcube.livetime());
deadc(expcube.deadc());
// Return
return;
}
/***********************************************************************//**
* @brief Get Region of Interest
*
* @return Region of Interest.
*
* @exception GException::invalid_value
* Observation does not contain events.
* Observation does not contain an event list.
*
* Extracts the Region of Interest from the event list. An exception is
* thrown if the observation does not contain an event list.
***************************************************************************/
GCTARoi GCTAObservation::roi(void) const
{
// Throw an exception if no events exist
if (m_events == NULL) {
std::string msg = "Region of Interest is not defined since the "
"observation does not contain events.";
throw GException::invalid_value(G_ROI, msg);
}
// Get pointer to event list. Throw an exception if no event list is found
const GCTAEventList* list = dynamic_cast<const GCTAEventList*>(m_events);
if (list == NULL) {
std::string msg = "Region of Interest is not defined since the "
"observation does not contain an event list.";
throw GException::invalid_value(G_ROI, msg);
}
// Return ROI
return (list->roi());
}
/***********************************************************************//**
* @brief Get Good Time Intervals
*
* @return Good Time Intervals.
*
* @exception GException::invalid_value
* Observation does not contain events.
*
* Extracts the Good Time Intervals from the events. An exception is thrown
* if the observation does not contain events.
***************************************************************************/
GGti GCTAObservation::gti(void) const
{
// Throw an exception if no events exist
if (m_events == NULL) {
std::string msg = "Good Time Intervals are not defined since the "
"observation does not contain events.";
throw GException::invalid_value(G_GTI, msg);
}
// Return GTI
return (m_events->gti());
}
/***********************************************************************//**
* @brief Get energy boundaries
*
* @return Energy boundaries.
*
* @exception GException::invalid_value
* Observation does not contain events.
*
* Extract the energy boundaries from the events. An exception is thrown if
* the observation does not contain events.
***************************************************************************/
GEbounds GCTAObservation::ebounds(void) const
{
// Throw an exception if no events exist
if (m_events == NULL) {
std::string msg = "Energy boundaries are not defined since the "
"observation does not contain events.";
throw GException::invalid_value(G_EBOUNDS, msg);
}
// Return energy boundaries
return (m_events->ebounds());
}
/***********************************************************************//**
* @brief Read observation from XML element
*
* @param[in] xml XML element.
*
* @exception GException::xml_invalid_parnum
* Invalid number of parameters found in XML element.
* @exception GException::xml_invalid_parnames
* Invalid parameter names found in XML element.
*
* Reads information for a CTA observation from an XML element. This method
* handles two variants: a first where an event list of counts cube is
* given and a second where the observation definition information is
* provided by parameter tags.
*
* The XML format for an event list is
*
* <observation name="..." id="..." instrument="...">
* <parameter name="EventList" file="..."/>
* ...
* </observation>
*
* and for a counts cube is
*
* <observation name="..." id="..." instrument="...">
* <parameter name="CountsCube" file="..."/>
* ...
* </observation>
*
* The second variant without event information has the following format
*
* <observation name="..." id="..." instrument="...">
* <parameter name="Pointing" ra="..." dec="..."/>
* <parameter name="Deadtime" deadc="..."/>
* ...
* </observation>
*
* In addition, calibration information can be specified using the format
*
* <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>
*
* In case that a @a CountsCube is handled, the stacked response can also be
* provided in the format
*
* <observation name="..." id="..." instrument="...">
* ...
* <parameter name="ExposureCube" file="..."/>
* <parameter name="PsfCube" file="..."/>
* <parameter name="EdispCube" file="..."/>
* <parameter name="BkgCube" file="..."/>
* </observation>
*
* Note that the @p EdispCube is an optional parameter.
*
* Optional user energy thresholds can be specified by adding the @a emin
* and @a emax attributes to the @p observation tag:
*
* <observation name="..." id="..." instrument="..." emin="..." emax="...">
*
* The method does not load the events into memory but stores the file name
* of the event file. The events are only loaded when required. This reduces
* the memory needs for an CTA observation object and allows for loading
* of event information upon need.
***************************************************************************/
void GCTAObservation::read(const GXmlElement& xml)
{
// Clear observation
clear();
// Extract instrument name
m_instrument = xml.attribute("instrument");
// Read in user defined energy boundaries of this observation
if (xml.attribute("emin") != "") {
m_lo_user_thres = gammalib::todouble(xml.attribute("emin"));
}
if (xml.attribute("emax") != "") {
m_hi_user_thres = gammalib::todouble(xml.attribute("emax"));
}
// Determine number of parameter nodes in XML element
int npars = xml.elements("parameter");
// Verify that XML element has at least 1 parameter
if (xml.elements() < 1 || npars < 1) {
throw GException::xml_invalid_parnum(G_READ, xml,
"CTA observation requires at least 1 parameter.");
}
// First try to extract observation parameters for an event file
int n_evfile = 0;
for (int i = 0; i < npars; ++i) {
// Get parameter element
const GXmlElement* par = xml.element("parameter", i);
// Handle EventList or CountsCube
if ((par->attribute("name") == "EventList") ||
(par->attribute("name") == "CountsCube")) {
// Read eventlist file name
std::string filename = par->attribute("file");
// Load events
load(filename);
// Increment parameter counter
n_evfile++;
}
// Read Background filename (needed by GCTAModelCubeBackground)
else if (par->attribute("name") == "Background") {
// Read background file name
m_bgdfile = par->attribute("file");
}
} // endfor: looped over observation parameters
// Analyse parameters
bool has_evfile = (n_evfile > 0);
// If we have an event file then verify that all required parameters
// were found
if (has_evfile) {
gammalib::xml_check_par(G_READ, "EventList\" or \"CountsCube", n_evfile);
}
// ... otherwise extract information from observation definition parameters
else {
// Initialise event list definition
GEbounds ebounds;
GGti gti;
GCTARoi roi;
bool has_ebounds = false;
bool has_gti = false;
bool has_roi = false;
// Extract parameters (do nothing if parameter does not exist)
if (gammalib::xml_has_par(xml, "Pointing")) {
m_pointing.read(xml);
}
if (gammalib::xml_has_par(xml, "EnergyBoundaries")) {
ebounds.read(xml);
has_ebounds = true;
}
if (gammalib::xml_has_par(xml, "GoodTimeIntervals")) {
gti.read(xml);
has_gti = true;
}
if (gammalib::xml_has_par(xml, "RegionOfInterest")) {
roi.read(xml);
has_roi = true;
}
if (gammalib::xml_has_par(xml, "Deadtime")) {
const GXmlElement* par = gammalib::xml_get_par(G_READ, xml, "Deadtime");
m_deadc = gammalib::todouble(par->attribute("deadc"));
}
else {
m_deadc = 1.0;
}
// If we have at least one event list definition then create event
// list and attach it to the observation
if (has_ebounds || has_gti || has_roi) {
// Create an empty event list
GCTAEventList events;
// Handle energy boundaries
if (has_ebounds) {
events.ebounds(ebounds);
}
// Handle GTIs
if (has_gti) {
events.gti(gti);
ontime(gti.ontime());
livetime(gti.ontime() * m_deadc);
}
// Handle ROIs
if (has_roi) {
events.roi(roi);
}
// Attach event list
this->events(events);
} // endif: handled event list information
} // endelse: extracted information from observation definition
// Determine response type as function of the information that is
// provided in the XML file. The response type is determined from the
// parameter names. An exception is thrown if the response type cannot
// be unambigously determined
int response_type = 0;
for (int i = 0; i < npars; ++i) {
// Get parameter element
const GXmlElement* par = xml.element("parameter", i);
// Check for response type 1 (GCTAResponseIrf)
if ((par->attribute("name") == "EffectiveArea") ||
(par->attribute("name") == "ARF") ||
(par->attribute("name") == "PointSpreadFunction") ||
(par->attribute("name") == "PSF") ||
(par->attribute("name") == "EnergyDispersion") ||
(par->attribute("name") == "RMF") ||
(par->attribute("name") == "Background") ||
(par->attribute("name") == "Calibration")) {
if (response_type == 2) {
throw GException::xml_invalid_parnames(G_READ, xml,
"Incompatible parameter names encountered in the "
"response definition of a CTA observation.\n");
}
response_type = 1;
}
// Check for response type 2 (GCTAResponseCube)
else if ((par->attribute("name") == "ExposureCube") ||
(par->attribute("name") == "PsfCube") ||
(par->attribute("name") == "BkgCube")) {
if (response_type == 1) {
throw GException::xml_invalid_parnames(G_READ, xml,
"Incompatible parameter names encountered in the "
"response definition of a CTA observation.\n");
}
response_type = 2;
}
} // endfor: looped over all parameters
// Allocate response
switch (response_type) {
case 1:
m_response = new GCTAResponseIrf;
break;
case 2:
m_response = new GCTAResponseCube;
break;
default:
break;
}
// Extract response information
if (m_response != NULL) {
m_response->read(xml);
}
// Return
return;
}
/***********************************************************************//**
* @brief Write observation into XML element
*
* @param[in] xml XML element.
*
* @exception GException::invalid_value
* No valid events found in observation.
*
* Writes information for a CTA observation into an XML element.
*
* Dependent on the content of the CTA observation, different XML formats
* will be written. If the CTA observation contains an event list that
* has been loaded from disk, the method will write the file name of the
* event list using the format
*
* <observation name="..." id="..." instrument="...">
* <parameter name="EventList" file="..."/>
* ...
* </observation>
*
* If the CTA observation contains a counts cube that has been loaded from
* disk, the method will write the file name of the counts cube using the
* format
*
* <observation name="..." id="..." instrument="...">
* <parameter name="CountsCube" file="..."/>
* ...
* </observation>
*
* In all other cases the method will only write the metadata information
* for the CTA observation using the format
*
* <observation name="..." id="..." instrument="...">
* <parameter name="Pointing" ra="..." dec="..."/>
* <parameter name="Deadtime" deadc="..."/>
* ...
* </observation>
*
* In case that response information is available and that the response
* information has been either loaded or saved to disk, the method will
* write the reponse information into the XML file. If the response for
* an unbinned or binned observation has been loaded from the calibration
* database, the format
*
* <observation name="..." id="..." instrument="...">
* ...
* <parameter name="Calibration" database="..." response="..."/>
* </observation>
*
* will be written. If the response has been loaded from individual files,
* the format
*
* <observation name="..." id="..." instrument="...">
* ...
* <parameter name="EffectiveArea" file="..."/>
* <parameter name="PointSpreadFunction" file="..."/>
* <parameter name="EnergyDispersion" file="..."/>
* <parameter name="Background" file="..."/>
* </observation>
*
* will be written. If the observation contains information about the
* response to a stacked analysis, the format
*
* <observation name="..." id="..." instrument="...">
* ...
* <parameter name="ExposureCube" file="..."/>
* <parameter name="PsfCube" file="..."/>
* <parameter name="EdispCube" file="..."/>
* <parameter name="BkgCube" file="..."/>
* </observation>
*
* will be written. Note that the @p EdispCube parameter will only be
* written in case that an energy dispersion cube had been defined (energy
* dispersion is optional).
*
* If user energy thresholds are defined (i.e. threshold values are >0) the
* additional @a emin and @a emax attributes will be written to the
* @p observation tag:
*
* <observation name="..." id="..." instrument="..." emin="..." emax="...">
*
***************************************************************************/
void GCTAObservation::write(GXmlElement& xml) const
{
// Throw an exception if eventtype() is neither "EventList" nor
std::string evttype = eventtype();
if ((evttype != "EventList") && (evttype != "CountsCube")) {
std::string msg;
if (evttype.empty()) {
msg = "The observation does not contain any events, hence "
"it cannot be written into an XML file.";
}
else {
msg = "The observation contains an unknown event type \""+
evttype+"\". The event type needs to be either "
"\"EventList\" or \"CountsCube\".";
}
throw GException::invalid_value(G_WRITE, msg);
}
// Add user energy threshold attributes (if set)
if (m_lo_user_thres > 0.0) {
xml.attribute("emin", gammalib::str(m_lo_user_thres));
}
if (m_hi_user_thres > 0.0) {
xml.attribute("emax", gammalib::str(m_hi_user_thres));
}
// If there is an event filename then write the event information to the
// XML file ...
if (!m_eventfile.is_empty()) {
// Write event file name
GXmlElement* par = gammalib::xml_need_par(G_WRITE, xml, evttype);
par->attribute("file", m_eventfile.url());
}
// ... otherwise write the observation definition information
else {
// Write pointing, energy bounds, GTIs and ROI
m_pointing.write(xml);
events()->ebounds().write(xml);
events()->gti().write(xml);
// Write ROI
const GCTAEventList* list = dynamic_cast<const GCTAEventList*>(events());
if (list != NULL) {
list->roi().write(xml);
}
// Write deadtime correction factor
GXmlElement* par = gammalib::xml_need_par(G_WRITE, xml, "Deadtime");
par->attribute("deadc", gammalib::str(m_deadc));
}
// Write response information
if (m_response != NULL) {
m_response->write(xml);
}
// Return
return;
}
/***********************************************************************//**
* @brief Read data from FITS file
*
* @param[in] fits FITS file.
*
* Reads event data from a FITS file and sets the observation attributes.
*
* The method automatically switches between an event list and a counts cube,
* depending of the information provided in the FITS file. If an extension
* name is specified, the method checks whether the extension exists and
* loads the extension as event list. Otherwise, it checks whether the file
* contains an "EVENTS" extension and loads the extension as event list.
* If none of the above are satistified, the method loads a counts cube.
***************************************************************************/
void GCTAObservation::read(const GFits& fits)
{
// Delete any existing event container (do not call clear() as we do not
// want to delete the response function)
if (m_events != NULL) delete m_events;
m_events = NULL;
// Retrieve file name from FITS file
GFilename filename(fits.filename());
// Get extension name
std::string extname = filename.extname("EVENTS");
// If FITS file contains an EVENTS extension we have an unbinned
// observation ...
if (fits.contains(extname)) {
// Allocate event list
GCTAEventList* events = new GCTAEventList;
// Assign event list as the observation's event container
m_events = events;
// Read event list
events->read(fits);
// Read observation attributes from EVENTS extension
const GFitsHDU& hdu = *fits.at(extname);
read_attributes(hdu);
}
// ... otherwise we have a binned observation
else {
// Allocate event cube
GCTAEventCube* events = new GCTAEventCube;
// Assign event cube as the observation's event container
m_events = events;
// Read event cube
events->read(fits);
// Read observation attributes from primary extension
const GFitsHDU& hdu = *fits.at(0);
read_attributes(hdu);
}
// Return
return;
}
/***********************************************************************//**
* @brief Write observation into FITS file.
*
* @param[in] fits FITS file.
* @param[in] evtname Events FITS extension name (default: "EVENTS").
* @param[in] gtiname Good Time Intervals FITS extension name (default: "GTI").
*
* Writes the observation into a FITS file.
*
* If the observation contains an event list, the event list and Good Time
* Intervals will be written to the FITS file. The FITS extension name for
* the event list and the Good Time Intervals can be optionally specified
* thru the @p evtname and @p gtiname arguments.
*
* If the observation contains an event cube, the event cube will be written
* into the primary extension of the FITS file.
*
* This method does nothing if no events are in the CTA observation.
***************************************************************************/
void GCTAObservation::write(GFits& fits, const std::string& evtname,
const std::string& gtiname) const
{
// Get pointers on event list
const GCTAEventList* list = dynamic_cast<const GCTAEventList*>(events());
const GCTAEventCube* cube = dynamic_cast<const GCTAEventCube*>(events());
// Case A: Observation contains an event list
if (list != NULL) {
// Remove HDUs if they exist already
if (fits.contains(evtname)) {
fits.remove(evtname);
}
if (fits.contains(gtiname)) {
fits.remove(gtiname);
}
// Write event list and Good Time Intervals into FITS file
list->write(fits, evtname, gtiname);
// Get reference to events extension
GFitsHDU& hdu = *fits.at(evtname);
// Write observation attributes to events extension
write_attributes(hdu);
} // endif: observation contained an event list
// Case B: Observation contains an event cube
else if (cube != NULL) {
// Write events cube into FITS file. This method also writes
// the energy boundaries and the GTI as they are also part
// of the event cube.
cube->write(fits);
// Write observation attributes into primary header
GFitsHDU& hdu = *fits.at(0);
write_attributes(hdu);
} // endelse: observation contained an event cube
// Return
return;
}
/***********************************************************************//**
* @brief Load unbinned or binned analysis data
*
* @param[in] filename Event list or counts cube FITS file name.
*
* Loads either an event list or a counts cube from a FITS file.
***************************************************************************/
void GCTAObservation::load(const GFilename& filename)
{
// Store event filename
m_eventfile = filename;
// Open FITS file
GFits fits(filename);
// Read data
read(fits);
// Close FITS file
fits.close();
// Return
return;
}
/***********************************************************************//**
* @brief Load stacked analysis data
*
* @param[in] cntcube Counts cube file name.
* @param[in] expcube Exposure cube file name.
* @param[in] psfcube Point spread function cube file name.
* @param[in] bkgcube Background cube file name.
*
* Loads a counts cube, an exposure cube, a point spread function cube, and a
* background cube for stacked analysis.
***************************************************************************/
void GCTAObservation::load(const GFilename& cntcube,
const GFilename& expcube,
const GFilename& psfcube,
const GFilename& bkgcube) {
// Load counts cube FITS file
load(cntcube);
// Check whether we have an event cube
if (dynamic_cast<const GCTAEventCube*>(events()) == NULL) {
std::string msg = "Specified file \""+cntcube.url()+"\" is not a CTA "
"counts cube. Please provide a counts cube.";
throw GException::invalid_argument(G_LOAD1, msg);
}
// Load exposure cube
GCTACubeExposure exposure(expcube);
// Load point spread function cube
GCTACubePsf psf(psfcube);
// Load background cube
GCTACubeBackground background(bkgcube);
// Set exposure cube, point spread function cube, and background cube
// as response for this observation
response(exposure, psf, background);
// Return
return;
}
/***********************************************************************//**
* @brief Load stacked analysis data with energy dispersion
*
* @param[in] cntcube Counts cube file name.
* @param[in] expcube Exposure cube file name.
* @param[in] psfcube Point spread function cube file name.
* @param[in] edispcube Energy dispersion cube file name.
* @param[in] bkgcube Background cube file name.
*
* Loads a counts cube, an exposure cube, a point spread function cube, a
* energy dispersion cube and a background cube for stacked analysis.
***************************************************************************/
void GCTAObservation::load(const GFilename& cntcube,
const GFilename& expcube,
const GFilename& psfcube,
const GFilename& edispcube,
const GFilename& bkgcube) {
// Load counts cube FITS file
load(cntcube);
// Check whether we have an event cube
if (dynamic_cast<const GCTAEventCube*>(events()) == NULL) {
std::string msg = "Specified file \""+cntcube.url()+"\" is not a CTA "
"counts cube. Please provide a counts cube.";
throw GException::invalid_argument(G_LOAD2, msg);
}
// Load exposure cube
GCTACubeExposure exposure(expcube);
// Load point spread function cube
GCTACubePsf psf(psfcube);
// Load energy dispersion cube
GCTACubeEdisp edisp(edispcube);
// Load background cube
GCTACubeBackground background(bkgcube);
// Set exposure cube, point spread function cube, energy dispersion
// cube, and background cube as response for this observation
response(exposure, psf, edisp, background);
// Return
return;
}
/***********************************************************************//**
* @brief Save CTA observation into FITS file.
*
* @param[in] filename FITS filename.
* @param[in] clobber Overwrite existing FITS file? (default: false)
*
* Saves the CTA observation into a FITS file.
*
* If the CTA observation contains an event list, the method will write an
* events and a Good Time Intervals extension to the FITS file. The names
* for both extension can be optionally specified in the filename using
* the format
*
* filename[EVENTS;GTI]
*
* where the string in the squared bracket defines the extension names. The
* part before the semi-colon is the events extension name and the part after
* the semi-colon is the Good Time Intervals extension name.
*
* If the CTA observation contains an event cube, the method will write the
* cube into the primary image, followed by binary tables containing the
* energy boundaries and the Good Time Intervals. The extension names of
* these binary tables are "EBOUNDS" and "GTI", and cannot be modified.
***************************************************************************/
void GCTAObservation::save(const GFilename& filename,
const bool& clobber) const
{
// Set default events and Good Time Intervals extension name and extract
// a possible overwrite from the extension name argument of the filename.
// The specific format that is implemented is [events;gti], where the
// part before the semi-colon is the events extension name and the part
// after the semi-colon is the Good Time Intervals extension name.
std::string evtname = "EVENTS";
std::string gtiname = "GTI";
if (filename.has_extname()) {
std::vector<std::string> extnames = gammalib::split(filename.extname(), ";");
if (extnames.size() > 0) {
evtname = gammalib::strip_whitespace(extnames[0]);
}
if (extnames.size() > 1) {
gtiname = gammalib::strip_whitespace(extnames[1]);
}
}
// Open or create FITS file. Since we accept here a special structure
// for the extension that cfitsio does not understand we only pass
// the URL without extension name to the GFits constructor.
GFits fits(filename.url(), true);
// Write data into FITS file
write(fits, evtname, gtiname);
// Save FITS file
fits.save(clobber);
// Return
return;
}
/***********************************************************************//**
* @brief Return event type string
*
* @return Event type string.
*
* Returns "EventList" if the observation contains an event list,
* "CountsCube" if it contains a counts cube, "Events" if it container an
* unknown type of events (which should never occur), and an empty string if
* no events have been allocated.
***************************************************************************/
std::string GCTAObservation::eventtype(void) const
{
// Initialise empty event type string
std::string eventtype = "";
// Continue only if events are allocated
if (m_events != NULL) {
// Case A: we have a list
GCTAEventList* list = dynamic_cast<GCTAEventList*>(m_events);
if (list != NULL) {
eventtype = "EventList";
}
// Case B: we have a cube
else {
GCTAEventCube* cube = dynamic_cast<GCTAEventCube*>(m_events);
if (cube != NULL) {
eventtype = "CountsCube";
}
// Case C: we don't know what we have
else {
eventtype = "Events";
}
}
} // endif: events were allocated
// Return event type
return eventtype;
}
/***********************************************************************//**
* @brief Dispose events
*
* Disposes the events to save memory. The method only applies to event
* lists. If does nothing in case that the observation does not contain an
* event list.
***************************************************************************/
void GCTAObservation::dispose_events(void)
{
// Get pointer to event list
GCTAEventList* list = dynamic_cast<GCTAEventList*>(m_events);
// Dispose event list if pointer is valid
if (list != NULL) {
list->dispose();
}
// Return
return;
}
/***********************************************************************//**
* @brief Print CTA observation information
*
* @param[in] chatter Chattiness (defaults to NORMAL).
* @return String containing observation information.
***************************************************************************/
std::string GCTAObservation::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("=== GCTAObservation ===");
// Append information
result.append("\n"+gammalib::parformat("Name")+name());
result.append("\n"+gammalib::parformat("Identifier")+id());
result.append("\n"+gammalib::parformat("Instrument")+instrument());
result.append("\n"+gammalib::parformat("Event file")+eventfile().url());
result.append("\n"+gammalib::parformat("Event type")+eventtype());
result.append("\n"+gammalib::parformat("Statistics")+statistics());
result.append("\n"+gammalib::parformat("Ontime"));
result.append(gammalib::str(ontime())+" s");
result.append("\n"+gammalib::parformat("Livetime"));
result.append(gammalib::str(livetime())+" s");
result.append("\n"+gammalib::parformat("Deadtime correction"));
result.append(gammalib::str(m_deadc));
// Append user energy threshold information
result.append("\n"+gammalib::parformat("User energy range"));
if (m_lo_user_thres > 0.0 && m_hi_user_thres) {
result.append(gammalib::str(m_lo_user_thres));
result.append(" - ");
result.append(gammalib::str(m_hi_user_thres));
result.append(" TeV");
}
else if (m_lo_user_thres > 0.0) {
result.append("> ");
result.append(gammalib::str(m_lo_user_thres));
result.append(" TeV");
}
else if (m_hi_user_thres > 0.0) {
result.append("< ");
result.append(gammalib::str(m_hi_user_thres));
result.append(" TeV");
}
else {
result.append("undefined");
}
// Append detailed information
GChatter reduced_chatter = gammalib::reduce(chatter);
if (reduced_chatter > SILENT) {
// Append pointing
result.append("\n"+pointing().print(reduced_chatter));
// Append response
if (m_response != NULL) {
result.append("\n"+m_response->print(reduced_chatter));
}
else {
result.append("\n"+gammalib::parformat("Response function"));
result.append("undefined");
}
// Append events
if (m_events != NULL) {
result.append("\n"+m_events->print(reduced_chatter));
}
} // endif: appended detailed information
} // endif: chatter was not silent
// Return result
return result;
}
/*==========================================================================
= =
= Private methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Initialise class members
***************************************************************************/
void GCTAObservation::init_members(void)
{
// Initialise members
m_instrument = "CTA";
m_object.clear();
m_eventfile.clear();
m_bgdfile.clear();
m_response = NULL;
m_pointing.clear();
m_obs_id = 0;
m_ontime = 0.0;
m_livetime = 0.0;
m_deadc = 1.0;
m_ra_obj = 0.0;
m_dec_obj = 0.0;
m_lo_user_thres = 0.0;
m_hi_user_thres = 0.0;
m_n_tels = 0;
// Return
return;
}
/***********************************************************************//**
* @brief Copy class members
*
* @param[in] obs CTA observation.
***************************************************************************/
void GCTAObservation::copy_members(const GCTAObservation& obs)
{
// Copy members
m_instrument = obs.m_instrument;
m_object = obs.m_object;
m_eventfile = obs.m_eventfile;
m_bgdfile = obs.m_bgdfile;
m_pointing = obs.m_pointing;
m_obs_id = obs.m_obs_id;
m_ontime = obs.m_ontime;
m_livetime = obs.m_livetime;
m_deadc = obs.m_deadc;
m_ra_obj = obs.m_ra_obj;
m_dec_obj = obs.m_dec_obj;
m_lo_user_thres = obs.m_lo_user_thres;
m_hi_user_thres = obs.m_hi_user_thres;
m_n_tels = obs.m_n_tels;
// Clone members
m_response = (obs.m_response != NULL) ? obs.m_response->clone() : NULL;
// Return
return;
}
/***********************************************************************//**
* @brief Delete class members
***************************************************************************/
void GCTAObservation::free_members(void)
{
// Free memory
if (m_response != NULL) delete m_response;
// Initialise pointers
m_response = NULL;
// Return
return;
}
/***********************************************************************//**
* @brief Read observation attributes
*
* @param[in] hdu FITS HDU.
*
* Reads CTA observation attributes from HDU. Mandatory attributes are
*
* RA_PNT - Right Ascension of pointing
* DEC_PNT - Declination of pointing
* ONTIME - Exposure time
* LIVETIME - Livetime
*
* and optional attributes are
*
* OBJECT - Name of observed object
* DEADC - Deadtime correction
* RA_OBJ - Right Ascension of observed object,
* DEC_OBJ - Declination of observed object,
* OBS_ID - Observation identifier
* ALT_PNT - Altitude of pointing above horizon
* AZ_PNT - Azimuth of pointing
* TELESCOP - Telescope name
* N_TELS - Number of telescopes
*
* Based on RA_PNT and DEC_PNT, the CTA pointing direction is set. Note that
* DEADC is computed using DEADC=LIVETIME/ONTIME
*
* @todo The actual reader is a minimal reader to accomodate as many
* different datasets as possible. Once the CTA data format is fixed
* the reader should have more mandatory attributes.
***************************************************************************/
void GCTAObservation::read_attributes(const GFitsHDU& hdu)
{
// Read mandatory attributes
double ra_pnt = hdu.real("RA_PNT");
double dec_pnt = hdu.real("DEC_PNT");
m_ontime = (hdu.has_card("ONTIME")) ? hdu.real("ONTIME") : 0.0;
m_livetime = (hdu.has_card("LIVETIME")) ? hdu.real("LIVETIME") : 0.0;
// Read optional attributes
m_object = (hdu.has_card("OBJECT")) ? hdu.string("OBJECT") : "unknown";
m_deadc = (hdu.has_card("DEADC")) ? hdu.real("DEADC") : 0.0;
m_ra_obj = (hdu.has_card("RA_OBJ")) ? hdu.real("RA_OBJ") : 0.0;
m_dec_obj = (hdu.has_card("DEC_OBJ")) ? hdu.real("DEC_OBJ") : 0.0;
m_obs_id = (hdu.has_card("OBS_ID")) ? hdu.integer("OBS_ID") : 0;
double alt = (hdu.has_card("ALT_PNT")) ? hdu.real("ALT_PNT") : 0.0;
double az = (hdu.has_card("AZ_PNT")) ? hdu.real("AZ_PNT") : 0.0;
m_instrument = (hdu.has_card("TELESCOP")) ? hdu.string("TELESCOP") : "CTA";
m_n_tels = (hdu.has_card("N_TELS")) ? hdu.integer("N_TELS") : 0;
// Kluge: compute DEADC from livetime and ontime instead of using the
// keyword value as the original event lists had this values badly
// assigned
if (m_ontime > 0) {
m_deadc = m_livetime / m_ontime;
}
else {
m_deadc = 0.0;
}
// Set pointing information
GSkyDir pnt;
pnt.radec_deg(ra_pnt, dec_pnt);
m_pointing.dir(pnt);
m_pointing.zenith(90.0-alt);
m_pointing.azimuth(az);
// Return
return;
}
/***********************************************************************//**
* @brief Write observation attributes
*
* @param[in] hdu FITS HDU.
***************************************************************************/
void GCTAObservation::write_attributes(GFitsHDU& hdu) const
{
// Get time reference
GTimeReference timeref = events()->gti().reference();
// Compute some attributes
double ra_pnt = m_pointing.dir().ra_deg();
double dec_pnt = m_pointing.dir().dec_deg();
double alt = 90.0 - m_pointing.zenith();
double az = m_pointing.azimuth();
double tstart = events()->tstart().convert(timeref);
double tstop = events()->tstop().convert(timeref);
double telapse = events()->gti().telapse();
double ontime = events()->gti().ontime();
double deadc = (ontime > 0.0 && livetime() > 0.0) ?
livetime() / ontime : m_deadc;
std::string utc_obs = events()->tstart().utc();
std::string utc_end = events()->tstop().utc();
std::string date_obs = utc_obs.substr(0, 10);
std::string time_obs = utc_obs.substr(11, 8);
std::string date_end = utc_end.substr(0, 10);
std::string time_end = utc_end.substr(11, 8);
// Set observation information
hdu.card("CREATOR", "GammaLib", "Program which created the file");
hdu.card("TELESCOP", instrument(), "Telescope");
hdu.card("OBS_ID", obs_id(), "Observation identifier");
hdu.card("DATE_OBS", date_obs, "Observation start date");
hdu.card("TIME_OBS", time_obs, "Observation start time");
hdu.card("DATE_END", date_end, "Observation end date");
hdu.card("TIME_END", time_end, "Observation end time");
// Set observation time information
hdu.card("TSTART", tstart, "[s] Mission time of start of observation");
hdu.card("TSTOP", tstop, "[s] Mission time of end of observation");
timeref.write(hdu);
hdu.card("TELAPSE", telapse, "[s] Mission elapsed time");
hdu.card("ONTIME", ontime, "[s] Total good time including deadtime");
hdu.card("LIVETIME", livetime(), "[s] Total livetime");
hdu.card("DEADC", deadc, "Deadtime correction factor");
hdu.card("TIMEDEL", 1.0, "Time resolution");
// Set pointing information
hdu.card("OBJECT", object(), "Observed object");
hdu.card("RA_OBJ", ra_obj(), "[deg] Target Right Ascension");
hdu.card("DEC_OBJ", dec_obj(), "[deg] Target Declination");
hdu.card("RA_PNT", ra_pnt, "[deg] Pointing Right Ascension");
hdu.card("DEC_PNT", dec_pnt, "[deg] Pointing Declination");
hdu.card("ALT_PNT", alt, "[deg] Average altitude of pointing");
hdu.card("AZ_PNT", az, "[deg] Average azimuth of pointing");
hdu.card("RADECSYS", "FK5", "Coordinate system");
hdu.card("EQUINOX", 2000.0, "Epoch");
hdu.card("CONV_DEP", 0.0, "Convergence depth of telescopes");
hdu.card("CONV_RA", 0.0, "[deg] Convergence Right Ascension");
hdu.card("CONV_DEC", 0.0, "[deg] Convergence Declination");
hdu.card("OBSERVER", "string", "Observer");
// Telescope information
hdu.card("N_TELS", n_tels(), "Number of telescopes in event list");
hdu.card("TELLIST", "string", "Telescope IDs");
hdu.card("GEOLAT", 0.0, "[deg] Geographic latitude of array centre");
hdu.card("GEOLON", 0.0, "[deg] Geographic longitude of array centre");
hdu.card("ALTITUDE", 0.0, "[km] Altitude of array centre");
// Other information
hdu.card("EUNIT", "TeV", "Energy unit");
hdu.card("EVTVER", "draft1", "Event list version number");
// Return
return;
}