GCTAResponseTable.cpp
61.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
/***************************************************************************
* GCTAResponseTable.cpp - CTA response table class *
* ----------------------------------------------------------------------- *
* copyright (C) 2012-2014 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 GCTAResponseTable.cpp
* @brief CTA response table class implementation
* @author Juergen Knoedlseder
*/
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <cmath>
#include "GTools.hpp"
#include "GMath.hpp"
#include "GException.hpp"
#include "GFitsTableFloatCol.hpp"
#include "GCTAException.hpp"
#include "GCTAResponseTable.hpp"
#include "GFitsBinTable.hpp"
#include "GFitsTableDoubleCol.hpp"
/* __ Method name definitions ____________________________________________ */
#define G_OPERATOR1 "GCTAResponseTable::operator()(double&)"
#define G_OPERATOR2 "GCTAResponseTable::operator()(double&, double&)"
#define G_OPERATOR3 "GCTAResponseTable::operator()(double&, double&,"\
" double&)"
#define G_ELEMENT_OPERATOR1 "GCTAResponseTable::operator()(int&)"
#define G_ELEMENT_OPERATOR2 "GCTAResponseTable::operator()(int&, int&)"
#define G_INX_OPERATOR1 "GCTAResponseTable::operator()(int&, double&)"
#define G_INX_OPERATOR2 "GCTAResponseTable::operator()(int&, double&,"\
" double&)"
#define G_INX_OPERATOR3 "GCTAResponseTable::operator()(int&, double&,"\
" double&, double&)"
#define G_AXIS "GCTAResponseTable::axis(int&)"
#define G_AXIS_LO_UNIT "GCTAResponseTable::axis_lo_unit(int&)"
#define G_AXIS_HI_UNIT "GCTAResponseTable::axis_hi_unit(int&)"
#define G_UNIT "GCTAResponseTable::unit(int&)"
#define G_AXIS_LO "GCTAResponseTable::axis_lo(int&, int&)"
#define G_AXIS_HI "GCTAResponseTable::axis_hi(int&, int&)"
#define G_AXIS_LINEAR "GCTAResponseTable::axis_linear(int&)"
#define G_AXIS_LOG10 "GCTAResponseTable::axis_log10(int&)"
#define G_AXIS_RADIANS "GCTAResponseTable::axis_radians(int&)"
#define G_SCALE "GCTAResponseTable::scale(int&, double&)"
#define G_READ "GCTAResponseTable::read(GFitsTable*)"
#define G_READ_COLNAMES "GCTAResponseTable::read_colnames(GFitsTable*)"
#define G_READ_AXES "GCTAResponseTable::read_axes(GFitsTable*)"
#define G_READ_PARS "GCTAResponseTable::read_pars(GFitsTable*)"
/* __ Macros _____________________________________________________________ */
/* __ Coding definitions _________________________________________________ */
/* __ Debug definitions __________________________________________________ */
/* __ Constants __________________________________________________________ */
/*==========================================================================
= =
= Constructors/destructors =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Void constructor
*
* Construct an empty CTA response table object.
***************************************************************************/
GCTAResponseTable::GCTAResponseTable(void)
{
// Initialise class members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Copy constructor
*
* @param[in] table Response table.
*
* Construct a CTA response table object by copying information from an
* existing object. A deep copy is performed for construction, so that the
* original object may be destroyed after construction the new object.
***************************************************************************/
GCTAResponseTable::GCTAResponseTable(const GCTAResponseTable& table)
{
// Initialise class members
init_members();
// Copy members
copy_members(table);
// Return
return;
}
/***********************************************************************//**
* @brief FITS table constructor
*
* @param[in] hdu FITS table HDU.
*
* Construct FITS table object from the information that is found in the FITS
* HDU. This method uses the GCTAResponseTable::read method to read the
* response table information from the FITS HDU. Please refer to this method
* for more details about what information is read from the HDU.
*
* If the FITS table HDU is not valid (i.e. NULL), the method initialises
* the object to a clean state (equivalent of GCTAResponseTable::clean
* method).
***************************************************************************/
GCTAResponseTable::GCTAResponseTable(const GFitsTable& hdu)
{
// Initialise class members
init_members();
// Read table information from HDU
read(hdu);
// Return
return;
}
/***********************************************************************//**
* @brief Destructor
*
* Destroys the CTA response table.
***************************************************************************/
GCTAResponseTable::~GCTAResponseTable(void)
{
// Free members
free_members();
// Return
return;
}
/*==========================================================================
= =
= Operators =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Assignment operator
*
* @param[in] table Response table.
* @return Response table.
*
* Assigns a CTA response table to another object. The method is performing
* a deep copy of the response table information, so that the original
* object can be destroyed after assignment without any loss of information.
***************************************************************************/
GCTAResponseTable& GCTAResponseTable::operator=(const GCTAResponseTable& table)
{
// Execute only if object is not identical
if (this != &table) {
// Free members
free_members();
// Initialise private members
init_members();
// Copy members
copy_members(table);
} // endif: object was not identical
// Return this object
return *this;
}
/***********************************************************************//**
* @brief Linear interpolation operator for 1D tables
*
* @param[in] arg Value.
* @return Linearly interpolated response parameter vector.
*
* @exception GCTAException::bad_rsp_table_dim
* Response table has less than one dimension.
*
* Evaluates all response parameters at a given value for a one-dimensional
* parameter vector. The evaluation is performed by a linear interpolation
* of the vector. If the specified value lies outside the range covered by
* the vector, the parameter is linearily extrapolated from using the first
* (or last) two vector elements.
*
* @todo Write down formula.
***************************************************************************/
std::vector<double> GCTAResponseTable::operator()(const double& arg) const
{
// Get parameter vector size
int num = m_colname_par.size();
// Optionally check that we have at least one dimension
#if defined(G_RANGE_CHECK)
if (num < 1) {
throw GCTAException::bad_rsp_table_dim(G_OPERATOR1, num, 1);
}
#endif
// Initialise result vector
std::vector<double> result(num);
// Set indices and weighting factors for interpolation
update(arg);
// Perform 1D interpolation
for (int i = 0; i < num; ++i) {
result[i] = m_wgt_left * m_pars[i][m_inx_left] +
m_wgt_right * m_pars[i][m_inx_right];
}
// Return result vector
return result;
}
/***********************************************************************//**
* @brief Bilinear interpolation operator for 2D tables
*
* @param[in] arg1 Value for first axis.
* @param[in] arg2 Value for second axis.
* @return Bilinearly interpolated response parameter vector.
*
* @exception GCTAException::bad_rsp_table_dim
* Response table has less than one dimension.
*
* Evaluates all response parameters at a given pair of values for a
* two-dimensional parameter vector. The evaluation is performed by a linear
* interpolation of the vector. If the specified value lies outside the range
* covered by the vector, the parameter is linearily extrapolated from using
* the first (or last) two vector elements.
*
* @todo Write down formula.
***************************************************************************/
std::vector<double> GCTAResponseTable::operator()(const double& arg1,
const double& arg2) const
{
// Get parameter vector size
int num = m_colname_par.size();
// Optionally check that we have at least two dimensions
#if defined(G_RANGE_CHECK)
if (num < 2) {
throw GCTAException::bad_rsp_table_dim(G_OPERATOR2, num, 2);
}
#endif
// Initialise result vector
std::vector<double> result(num);
// Set indices and weighting factors for interpolation
update(arg1, arg2);
// Perform 2D interpolation
for (int i = 0; i < num; ++i) {
result[i] = m_wgt1 * m_pars[i][m_inx1] +
m_wgt2 * m_pars[i][m_inx2] +
m_wgt3 * m_pars[i][m_inx3] +
m_wgt4 * m_pars[i][m_inx4];
}
// Return result vector
return result;
}
/***********************************************************************//**
* @brief Trilinear interpolation operator for 3D tables
*
* @param[in] arg1 Value for first axis.
* @param[in] arg2 Value for second axis.
* @param[in] arg3 Value for third axis.
* @return Trilinearly interpolated response parameter vector.
*
* @exception GCTAException::bad_rsp_table_dim
* Response table has less than one dimension.
*
* Evaluates all response parameters at a given triplet of values for a
* three-dimensional parameter vector. The evaluation is performed by a
* tri-linear interpolation of the vector. If the specified value lies
* outside the range covered by the vector, the parameter is linearily
* extrapolated from using the first (or last) two vector elements.
*
* @todo Write down formula.
***************************************************************************/
std::vector<double> GCTAResponseTable::operator()(const double& arg1,
const double& arg2,
const double& arg3) const
{
// Get parameter vector size
int num = m_colname_par.size();
// Optionally check that we have at least three dimensions
#if defined(G_RANGE_CHECK)
if (num < 3) {
throw GCTAException::bad_rsp_table_dim(G_OPERATOR3, num, 3);
}
#endif
// Initialise result vector
std::vector<double> result(num);
// Set indices and weighting factors for interpolation
update(arg1, arg2, arg3);
// Perform 3D interpolation
for (int i = 0; i < num; ++i) {
result[i] = m_wgt1 * m_pars[i][m_inx1] +
m_wgt2 * m_pars[i][m_inx2] +
m_wgt3 * m_pars[i][m_inx3] +
m_wgt4 * m_pars[i][m_inx4] +
m_wgt5 * m_pars[i][m_inx5] +
m_wgt6 * m_pars[i][m_inx6] +
m_wgt7 * m_pars[i][m_inx7] +
m_wgt8 * m_pars[i][m_inx8] ;
}
// Return result vector
return result;
}
/***********************************************************************//**
* @brief Element access operator
*
* @param[in] element Element index [0,...,elements()-1].
* @return Response table element.
*
* @exception GCTAException::out_of_range
* @p index or @p element are outside valid range
***************************************************************************/
double& GCTAResponseTable::operator()(const int& element)
{
// Optionally check if the index and element is valid
#if defined(G_RANGE_CHECK)
if (element < 0 || element >= elements()) {
throw GException::out_of_range(G_ELEMENT_OPERATOR1, element, elements()-1);
}
#endif
// Return elements
return (m_pars[0][element]);
}
/***********************************************************************//**
* @brief Element access operator (const version)
*
* @param[in] element Element index [0,...,elements()-1].
* @return Response table element.
*
* @exception GCTAException::out_of_range
* @p index or @p element are outside valid range
***************************************************************************/
const double& GCTAResponseTable::operator()(const int& element) const
{
// Optionally check if the index and element is valid
#if defined(G_RANGE_CHECK)
if (element < 0 || element >= elements()) {
throw GException::out_of_range(G_ELEMENT_OPERATOR1, element, elements()-1);
}
#endif
// Return elements
return (m_pars[0][element]);
}
/***********************************************************************//**
* @brief Element access operator
*
* @param[in] index Table index [0,...,size()-1].
* @param[in] element Element index [0,...,elements()-1].
* @return Response table element.
*
* @exception GCTAException::out_of_range
* @p index or @p element are outside valid range
***************************************************************************/
double& GCTAResponseTable::operator()(const int& index, const int& element)
{
// Optionally check if the index and element is valid
#if defined(G_RANGE_CHECK)
if (index < 0 || index >= size()) {
throw GException::out_of_range(G_ELEMENT_OPERATOR2, index, size()-1);
}
if (element < 0 || element >= elements()) {
throw GException::out_of_range(G_ELEMENT_OPERATOR2, element, elements()-1);
}
#endif
// Return elements
return (m_pars[index][element]);
}
/***********************************************************************//**
* @brief Element access operator (const version)
*
* @param[in] index Table index [0,...,size()-1].
* @param[in] element Element index [0,...,elements()-1].
* @return Response table element.
*
* @exception GCTAException::out_of_range
* @p index or @p element are outside valid range
***************************************************************************/
const double& GCTAResponseTable::operator()(const int& index, const int& element) const
{
// Optionally check if the index and element is valid
#if defined(G_RANGE_CHECK)
if (index < 0 || index >= size()) {
throw GException::out_of_range(G_ELEMENT_OPERATOR2, index, size()-1);
}
if (element < 0 || element >= elements()) {
throw GException::out_of_range(G_ELEMENT_OPERATOR2, element, elements()-1);
}
#endif
// Return elements
return (m_pars[index][element]);
}
/***********************************************************************//**
* @brief Linear interpolation operator for 1D tables
*
* @param[in] index Table index [0,...,size()-1].
* @param[in] arg Value.
* @return Linearly interpolated response parameter.
*
* @exception GCTAException::bad_rsp_table_dim
* Response table has less than one dimension.
*
* Evaluates one response parameter at a given value for a one-dimensional
* parameter vector. The evaluation is performed by a linear interpolation
* of the vector. If the specified value lies outside the range covered by
* the vector, the parameter is linearily extrapolated from using the first
* (or last) two vector elements.
*
* @todo Write down formula.
***************************************************************************/
double GCTAResponseTable::operator()(const int& index, const double& arg) const
{
// Optionally check if the index is valid
#if defined(G_RANGE_CHECK)
if (index < 0 || index >= size()) {
throw GException::out_of_range(G_INX_OPERATOR1, index, size()-1);
}
#endif
// Set indices and weighting factors for interpolation
update(arg);
// Perform 1D interpolation
double result = m_wgt_left * m_pars[index][m_inx_left] +
m_wgt_right * m_pars[index][m_inx_right];
// Return result
return result;
}
/***********************************************************************//**
* @brief Bilinear interpolation operator for 2D tables
*
* @param[in] index Table index [0,...,size()-1].
* @param[in] arg1 Value for first axis.
* @param[in] arg2 Value for second axis.
* @return Bilinearly interpolated response parameter vector.
*
* @exception GCTAException::bad_rsp_table_dim
* Response table has less than one dimension.
*
* Evaluates all response parameters at a given pair of values for a
* two-dimensional parameter vector. The evaluation is performed by a linear
* interpolation of the vector. If the specified value lies outside the range
* covered by the vector, the parameter is linearily extrapolated from using
* the first (or last) two vector elements.
*
* @todo Write down formula.
***************************************************************************/
double GCTAResponseTable::operator()(const int& index, const double& arg1,
const double& arg2) const
{
// Optionally check if the index is valid
#if defined(G_RANGE_CHECK)
if (index < 0 || index >= size()) {
throw GException::out_of_range(G_INX_OPERATOR2, index, size()-1);
}
#endif
// Set indices and weighting factors for interpolation
update(arg1, arg2);
// Perform 2D interpolation
double result = m_wgt1 * m_pars[index][m_inx1] +
m_wgt2 * m_pars[index][m_inx2] +
m_wgt3 * m_pars[index][m_inx3] +
m_wgt4 * m_pars[index][m_inx4];
// Return result
return result;
}
/***********************************************************************//**
* @brief Trilinear interpolation operator for 3D tables
*
* @param[in] index Table index [0,...,size()-1].
* @param[in] arg1 Value for first axis.
* @param[in] arg2 Value for second axis.
* @param[in] arg3 Value for second axis.
* @return Trilinearly interpolated response parameter vector.
*
* @exception GCTAException::bad_rsp_table_dim
* Response table has less than one dimension.
*
* Evaluates all response parameters at a given triplet of values for a
* three-dimensional parameter vector. The evaluation is performed by a
* trilinear interpolation of the vector. If the specified value lies outside
* the range covered by the vector, the parameter is linearily extrapolated
* from using the first (or last) two vector elements.
*
* @todo Write down formula.
***************************************************************************/
double GCTAResponseTable::operator()(const int& index,
const double& arg1,
const double& arg2,
const double& arg3) const
{
// Optionally check if the index is valid
#if defined(G_RANGE_CHECK)
if (index < 0 || index >= size()) {
throw GException::out_of_range(G_INX_OPERATOR3, index, size()-1);
}
#endif
// Set indices and weighting factors for interpolation
update(arg1, arg2, arg3);
// Perform 3D interpolation
double result = m_wgt1 * m_pars[index][m_inx1] +
m_wgt2 * m_pars[index][m_inx2] +
m_wgt3 * m_pars[index][m_inx3] +
m_wgt4 * m_pars[index][m_inx4] +
m_wgt5 * m_pars[index][m_inx5] +
m_wgt6 * m_pars[index][m_inx6] +
m_wgt7 * m_pars[index][m_inx7] +
m_wgt8 * m_pars[index][m_inx8];
// Return result
return result;
}
/*==========================================================================
= =
= Public methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Clear instance
*
* Resets the object to a proper initial state. Any information that resided
* before in the object will be lost.
***************************************************************************/
void GCTAResponseTable::clear(void)
{
// Free class members
free_members();
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Clone instance
*
* @return Deep copy of response table instance.
*
* Clones an instance of the CTA response table. The cloned object will be
* a deep copy of the original object, hence after cloning the original
* object can be destroyed without any loss of information.
***************************************************************************/
GCTAResponseTable* GCTAResponseTable::clone(void) const
{
return new GCTAResponseTable(*this);
}
/***********************************************************************//**
* @brief Return axis length
*
* @param[in] index Axis index [0,...,axes()-1].
* @return Number of bins along the specified axis.
*
* @exception GException::out_of_range
* Axis index out of range.
*
* Returns the number of bins along the specified axis.
***************************************************************************/
int GCTAResponseTable::axis(const int& index) const
{
// Optionally check if the index is valid
#if defined(G_RANGE_CHECK)
if (index < 0 || index >= axes()) {
throw GException::out_of_range(G_AXIS, index, axes()-1);
}
#endif
// Return axis length
return (m_axis_lo[index].size());
}
/***********************************************************************//**
* @brief Return lower bin boundary for bin in axis
*
* @param[in] index Axis index [0,...,axes()-1].
* @param[in] bin Bin index (starting from 0).
* @return Lower bin boundary.
*
* @exception GException::out_of_range
* Axis or bin index out of range.
*
* Returns the lower boundary for a given bin of a given axis.
***************************************************************************/
const double& GCTAResponseTable::axis_lo(const int& index, const int& bin) const
{
// Optionally check if the index is valid
#if defined(G_RANGE_CHECK)
if (index < 0 || index >= axes() ||
bin < 0 || bin >= m_axis_lo[index].size()) {
throw GException::out_of_range(G_AXIS_LO, index, bin,
axes()-1, m_axis_lo[index].size()-1);
}
#endif
// Return bin boundary
return (m_axis_lo[index][bin]);
}
/***********************************************************************//**
* @brief Return upper bin boundary for bin in axis
*
* @param[in] index Axis index [0,...,axes()-1].
* @param[in] bin Bin index (starting from 0).
* @return Uppser bin boundary.
*
* @exception GException::out_of_range
* Axis or bin index out of range.
*
* Returns the upper boundary for a given bin of a given axis.
***************************************************************************/
const double& GCTAResponseTable::axis_hi(const int& index, const int& bin) const
{
// Optionally check if the index is valid
#if defined(G_RANGE_CHECK)
if (index < 0 || index >= axes() ||
bin < 0 || bin >= m_axis_hi[index].size()) {
throw GException::out_of_range(G_AXIS_HI, index, bin,
axes()-1, m_axis_hi[index].size()-1);
}
#endif
// Return bin boundary
return (m_axis_hi[index][bin]);
}
/***********************************************************************//**
* @brief Return lower bin boundary name for axis
*
* @param[in] index Axis index [0,...,axes()-1].
* @return Name of lower bin boundary.
*
* @exception GException::out_of_range
* Axis index out of range.
*
* Returns the name of the lower boundary for the specified axis.
***************************************************************************/
const std::string& GCTAResponseTable::axis_lo_name(const int& index) const
{
// Optionally check if the index is valid
#if defined(G_RANGE_CHECK)
if (index < 0 || index >= axes()) {
throw GException::out_of_range(G_AXIS_LO_UNIT, index, axes()-1);
}
#endif
// Return units
return (m_colname_lo[index]);
}
/***********************************************************************//**
* @brief Return upper bin boundary name for axis
*
* @param[in] index Axis index [0,...,axes()-1].
* @return Name of upper bin boundary.
*
* @exception GException::out_of_range
* Axis index out of range.
*
* Returns the name of the upper boundary for the specified axis.
***************************************************************************/
const std::string& GCTAResponseTable::axis_hi_name(const int& index) const
{
// Optionally check if the index is valid
#if defined(G_RANGE_CHECK)
if (index < 0 || index >= axes()) {
throw GException::out_of_range(G_AXIS_HI_UNIT, index, axes()-1);
}
#endif
// Return units
return (m_colname_hi[index]);
}
/***********************************************************************//**
* @brief Return lower bin boundary unit for axis
*
* @param[in] index Axis index [0,...,axes()-1].
* @return Unit of lower bin boundary.
*
* @exception GException::out_of_range
* Axis index out of range.
*
* Returns the unit of the lower boundary for the specified axis.
***************************************************************************/
const std::string& GCTAResponseTable::axis_lo_unit(const int& index) const
{
// Optionally check if the index is valid
#if defined(G_RANGE_CHECK)
if (index < 0 || index >= axes()) {
throw GException::out_of_range(G_AXIS_LO_UNIT, index, axes()-1);
}
#endif
// Return units
return (m_units_lo[index]);
}
/***********************************************************************//**
* @brief Return upper bin boundary unit for axis
*
* @param[in] index Axis index [0,...,axes()-1].
* @return Unit of upper bin boundary.
*
* @exception GException::out_of_range
* Axis index out of range.
*
* Returns the unit of the upper boundary for the specified axis.
***************************************************************************/
const std::string& GCTAResponseTable::axis_hi_unit(const int& index) const
{
// Optionally check if the index is valid
#if defined(G_RANGE_CHECK)
if (index < 0 || index >= axes()) {
throw GException::out_of_range(G_AXIS_HI_UNIT, index, axes()-1);
}
#endif
// Return units
return (m_units_hi[index]);
}
/***********************************************************************//**
* @brief Set nodes for a linear axis
*
* @param[in] index Axis index [0,...,axes()-1].
*
* @exception GException::out_of_range
* Axis index out of range.
*
* Set axis nodes so that each node is the linear mean of the lower and upper
* bin boundary, i.e.
* \f[ n_i = 0.5 \times ({\rm LO}_i + {\rm HI}_i) \f]
* where
* \f$n_i\f$ is node \f$i\f$,
* \f${\rm LO}_i\f$ is the lower bin boundary for bin \f$i\f$, and
* \f${\rm HI}_i\f$ is the upper bin boundary for bin \f$i\f$.
***************************************************************************/
void GCTAResponseTable::axis_linear(const int& index)
{
// Optionally check if the index is valid
#if defined(G_RANGE_CHECK)
if (index < 0 || index >= axes()) {
throw GException::out_of_range(G_AXIS_LINEAR, index, axes()-1);
}
#endif
// Get number of bins
int bins = axis(index);
// Allocate node values
std::vector<double> axis_nodes(bins);
// Compute nodes
for (int i = 0; i < bins; ++i) {
axis_nodes[i] = 0.5*(m_axis_lo[index][i] + m_axis_hi[index][i]);
}
// Set node array
m_axis_nodes[index] = GNodeArray(axis_nodes);
// Return
return;
}
/***********************************************************************//**
* @brief Set nodes for a logarithmic (base 10) axis
*
* @param[in] index Axis index [0,...,axes()-1].
*
* @exception GException::out_of_range
* Axis index out of range.
*
* Set axis nodes so that each node is the logarithmic mean of the lower and
* upper bin boundary, i.e.
* \f[ n_i = \log \sqrt{{\rm LO}_i \times {\rm HI}_i} \f]
* where
* \f$n_i\f$ is node \f$i\f$,
* \f${\rm LO}_i\f$ is the lower bin boundary for bin \f$i\f$, and
* \f${\rm HI}_i\f$ is the upper bin boundary for bin \f$i\f$.
*
* @todo Check that none of the axis boundaries is non-positive.
***************************************************************************/
void GCTAResponseTable::axis_log10(const int& index)
{
// Optionally check if the index is valid
#if defined(G_RANGE_CHECK)
if (index < 0 || index >= axes()) {
throw GException::out_of_range(G_AXIS_LINEAR, index, axes()-1);
}
#endif
// Get number of bins
int bins = axis(index);
// Allocate node values
std::vector<double> axis_nodes(bins);
// Compute nodes
for (int i = 0; i < bins; ++i) {
axis_nodes[i] = std::log10(std::sqrt(m_axis_lo[index][i] *
m_axis_hi[index][i]));
}
// Set node array
m_axis_nodes[index] = GNodeArray(axis_nodes);
// Return
return;
}
/***********************************************************************//**
* @brief Set nodes for a radians axis
*
* @param[in] index Axis index [0,...,axes()-1].
*
* @exception GException::out_of_range
* Axis index out of range.
*
* Set axis nodes so that each node is the lo mean of the lower and upper
* bin boundary in radians, i.e.
* \f[ n_i = \frac{\pi}{360} \times ({\rm LO}_i + {\rm HI}_i) \f]
* where
* \f$n_i\f$ is node \f$i\f$,
* \f${\rm LO}_i\f$ is the lower bin boundary for bin \f$i\f$, and
* \f${\rm HI}_i\f$ is the upper bin boundary for bin \f$i\f$.
***************************************************************************/
void GCTAResponseTable::axis_radians(const int& index)
{
// Optionally check if the index is valid
#if defined(G_RANGE_CHECK)
if (index < 0 || index >= axes()) {
throw GException::out_of_range(G_AXIS_RADIANS, index, axes()-1);
}
#endif
// Get number of bins
int bins = axis(index);
// Allocate node values
std::vector<double> axis_nodes(bins);
// Compute nodes
for (int i = 0; i < bins; ++i) {
axis_nodes[i] = 0.5*(m_axis_lo[index][i] + m_axis_hi[index][i]) *
gammalib::deg2rad;
}
// Set node array
m_axis_nodes[index] = GNodeArray(axis_nodes);
// Return
return;
}
/***********************************************************************//**
* @brief Return parameter unit
*
* @param[in] index Parameter index [0,...,size()-1].
* @return Unit of parameter.
*
* @exception GException::out_of_range
* Axis index out of range.
*
* Returns the unit of the parameter for the specified index.
***************************************************************************/
const std::string& GCTAResponseTable::unit(const int& index) const
{
// Optionally check if the index is valid
#if defined(G_RANGE_CHECK)
if (index < 0 || index >= size()) {
throw GException::out_of_range(G_UNIT, index, size()-1);
}
#endif
// Return units
return (m_units_par[index]);
}
/***********************************************************************//**
* @brief Append an axis to the response table
*
* @param[in] axis_lo Lower axis boundaries.
* @param[in] axis_hi Upper axis boundaries.
* @param[in] name Axis name.
* @param[in] unit Axis unit.
*
* Append an axis to the response table.
*
* @todo Throw an exception when the length of axis_lo and axis_hi are
* different.
***************************************************************************/
void GCTAResponseTable::append_axis(const std::vector<double>& axis_lo,
const std::vector<double>& axis_hi,
const std::string& name,
const std::string& unit)
{
// Set axis names
std::string name_lo = name + "_LO";
std::string name_hi = name + "_HI";
// Append axis
m_colname_lo.push_back(name_lo);
m_colname_hi.push_back(name_hi);
m_axis_lo.push_back(axis_lo);
m_axis_hi.push_back(axis_hi);
m_units_lo.push_back(unit);
m_units_hi.push_back(unit);
// Increment number of axes
m_naxes++;
// Compute the cube size
m_nelements = axis(0);
for (int i = 1; i < axes(); ++i) {
m_nelements *= axis(i);
}
// Return
return;
}
/***********************************************************************//**
* @brief Append parameter to response table
*
* @param[in] name Parameter name.
* @param[in] unit Parameter unit.
*
* Append a parameter to the response table. The number of elements in the
* column is the product of the length of all axes. All elements are set to
* zero by default.
*
* @todo Throw an exception message when m_nelement is zero.
***************************************************************************/
void GCTAResponseTable::append_parameter(const std::string& name,
const std::string& unit)
{
// Append parameter column name and unit
m_colname_par.push_back(name);
m_units_par.push_back(unit);
// Initialise empty parameter column
std::vector<double> parameter(m_nelements, 0.0);
// Append column
m_pars.push_back(parameter);
// Increment number of parameter columns
m_npars++;
// Return
return;
}
/***********************************************************************//**
* @brief Return axis nodes
*
* @param[in] index Axis index [0,...,axes()-1].
* @return Node array for axis.
*
* @exception GException::out_of_range
* Axis index out of range.
*
* Returns the node array of the specified axis.
***************************************************************************/
const GNodeArray& GCTAResponseTable::nodes(const int& index) const
{
// Optionally check if the index is valid
#if defined(G_RANGE_CHECK)
if (index < 0 || index >= axes()) {
throw GException::out_of_range(G_AXIS, index, axes()-1);
}
#endif
// Return node array
return (m_axis_nodes[index]);
}
/***********************************************************************//**
* @brief Set nodes for a radians axis
*
* @param[in] index Parameter index [0,...,size()-1].
* @param[in] scale Scaling factor.
*
* @exception GException::out_of_range
* Axis index out of range.
*
* Multiplies all values in a parameter table by the specified scaling
* factor.
***************************************************************************/
void GCTAResponseTable::scale(const int& index, const double& scale)
{
// Optionally check if the index is valid
#if defined(G_RANGE_CHECK)
if (index < 0 || index >= size()) {
throw GException::out_of_range(G_SCALE, index, size()-1);
}
#endif
// Scale parameter values
for (int i = 0; i < m_nelements; ++i) {
m_pars[index][i] *= scale;
}
// Return
return;
}
/***********************************************************************//**
* @brief Read response table from FITS table HDU
*
* @param[in] table FITS table.
*
* Reads CTA response table information from a FITS table. The FITS table
* is expected to have a single row, and axes and parameter information are
* found in vector columns. Axes information is expected to be placed
* before parameter information.
*
* Each axis is defined by two vector columns of equal width, describing the
* lower and upper limits for each bin. The column names for this boundary
* information terminates by "_LO" and "HI", respectively (upper case). It
* is expected that the "_LO" column preceeds the "_HI" column.
*
* Following the axes columns are parameter columns of equal width. The width
* of each parameter column is given by the product of the lengths of all
* axes. It is furthermore expected that the first axis is the most rapidely
* varying index of the vector.
*
* In case that the HDU table pointer is not valid (i.e. NULL), this method
* clears the objects and does nothing else.
***************************************************************************/
void GCTAResponseTable::read(const GFitsTable& table)
{
// Clear instance
clear();
// Read column names
read_colnames(table);
// Read axes
read_axes(table);
// Read parameter cubes
read_pars(table);
// Return
return;
}
/***********************************************************************//**
* @brief Write response table into FITS table HDU
*
* @param[in] table FITS table.
***************************************************************************/
void GCTAResponseTable::write(GFitsTable& table) const
{
// Loop over all response table axes
for (int iaxis = 0; iaxis < m_naxes; ++iaxis) {
// Create axis columns
GFitsTableDoubleCol col_lo(m_colname_lo[iaxis], 1, m_axis_lo[iaxis].size());
GFitsTableDoubleCol col_hi(m_colname_hi[iaxis], 1, m_axis_hi[iaxis].size());
// Loop through all elements in this axis column
for (int i = 0; i < m_axis_lo[iaxis].size(); ++i) {
col_lo(0,i) = m_axis_lo[iaxis][i];
col_hi(0,i) = m_axis_hi[iaxis][i];
}
// Set column units
col_lo.unit(m_units_lo[iaxis]);
col_hi.unit(m_units_hi[iaxis]);
// Append column to FITS table
table.append(col_lo);
table.append(col_hi);
} // endif: looped over all axes in response table
// Loop over all parameters in the response table
for (int ipar = 0; ipar < m_npars; ++ipar) {
// Create parameter column
GFitsTableDoubleCol col_par(m_colname_par[ipar], 1, m_pars[ipar].size());
// Loop through elements in this parameter column
for (int i = 0; i < m_pars[ipar].size() ; ++i) {
col_par(0,i) = m_pars[ipar][i];
}
// Set column unit
col_par.unit(m_units_par[ipar]);
// Append column to table
table.append(col_par);
} // endfor: looped over all axes in response table
// Return
return;
}
/***********************************************************************//**
* @brief Print response table information
*
* @param[in] chatter Chattiness (defaults to NORMAL).
* @return String containing response table information.
*
* Puts CTA response table information into a std::string object for
* printing.
***************************************************************************/
std::string GCTAResponseTable::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("=== GCTAResponseTable ===");
// Append information
result.append("\n"+gammalib::parformat("Dimension") +
gammalib::str(axes()));
// Append axes information
for (int i = 0; i < axes(); ++i) {
result.append("\n"+gammalib::parformat("Axis " +
gammalib::str(i)));
result.append(gammalib::str(axis(i)));
result.append(" (");
result.append(m_colname_lo[i]);
if (!m_units_lo[i].empty()) {
result.append(" ["+m_units_lo[i]+"]");
}
result.append(", ");
result.append(m_colname_hi[i]);
if (!m_units_hi[i].empty()) {
result.append(" ["+m_units_hi[i]+"]");
}
result.append(")");
}
// Append parameter information
for (int i = 0; i < size(); ++i) {
result.append("\n"+gammalib::parformat("Parameter " +
gammalib::str(i)));
result.append(m_colname_par[i]);
if (!m_units_par[i].empty()) {
result.append(" ["+m_units_par[i]+"]");
}
}
} // endif: chatter was not silent
// Return result
return result;
}
/*==========================================================================
= =
= Private methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Initialise class members
*
* Initialises all members of the class.
***************************************************************************/
void GCTAResponseTable::init_members(void)
{
// Initialise members
m_naxes = 0;
m_npars = 0;
m_nelements = 0;
m_colname_lo.clear();
m_colname_hi.clear();
m_colname_par.clear();
m_axis_lo.clear();
m_axis_hi.clear();
m_units_lo.clear();
m_units_hi.clear();
m_units_par.clear();
m_axis_nodes.clear();
m_pars.clear();
// Initialise cache
m_inx_left = 0;
m_inx_right = 0;
m_wgt_left = 0.0;
m_wgt_right = 0.0;
m_inx1 = 0;
m_inx2 = 0;
m_inx3 = 0;
m_inx4 = 0;
m_inx5 = 0;
m_inx6 = 0;
m_inx7 = 0;
m_inx8 = 0;
m_wgt1 = 0.0;
m_wgt2 = 0.0;
m_wgt3 = 0.0;
m_wgt4 = 0.0;
m_wgt5 = 0.0;
m_wgt6 = 0.0;
m_wgt7 = 0.0;
m_wgt8 = 0.0;
// Return
return;
}
/***********************************************************************//**
* @brief Copy class members
*
* @param[in] table Response table.
*
* Copies all members of the class.
***************************************************************************/
void GCTAResponseTable::copy_members(const GCTAResponseTable& table)
{
// Copy number of bins
m_naxes = table.m_naxes;
m_npars = table.m_npars;
m_nelements = table.m_nelements;
m_colname_lo = table.m_colname_lo;
m_colname_hi = table.m_colname_hi;
m_colname_par = table.m_colname_par;
m_axis_lo = table.m_axis_lo;
m_axis_hi = table.m_axis_hi;
m_units_lo = table.m_units_lo;
m_units_hi = table.m_units_hi;
m_units_par = table.m_units_par;
m_axis_nodes = table.m_axis_nodes;
m_pars = table.m_pars;
// Copy cache
m_inx_left = table.m_inx_left;
m_inx_right = table.m_inx_right;
m_wgt_left = table.m_wgt_left;
m_wgt_right = table.m_wgt_right;
m_inx1 = table.m_inx1;
m_inx2 = table.m_inx2;
m_inx3 = table.m_inx3;
m_inx4 = table.m_inx4;
m_inx5 = table.m_inx5;
m_inx6 = table.m_inx6;
m_inx7 = table.m_inx7;
m_inx8 = table.m_inx8;
m_wgt1 = table.m_wgt1;
m_wgt2 = table.m_wgt2;
m_wgt3 = table.m_wgt3;
m_wgt4 = table.m_wgt4;
m_wgt5 = table.m_wgt5;
m_wgt6 = table.m_wgt6;
m_wgt7 = table.m_wgt7;
m_wgt8 = table.m_wgt8;
// Return
return;
}
/***********************************************************************//**
* @brief Delete class members
*
* Deallocates any memory that was allocated by the object.
***************************************************************************/
void GCTAResponseTable::free_members(void)
{
// Return
return;
}
/***********************************************************************//**
* @brief Read column names from FITS HDU
*
* @param[in] hdu Response table HDU.
*
* @exception GCTAException::bad_rsp_table_format
* Bad response table format encountered in FITS HDU.
*
* Read the response table column names from the HDU. Column names
* terminating with "_LO" and "_HI" define the parameter space axes, while
* all other column names define response parameter data cubes. It is
* assumed that parameter space axes are given in subsequent order, with
* the first column corresponding to the lower bin boundaries of the first
* axis. Lower bin boundaries are indicated by the "_LO" termination. Upper
* bin boundaries are assumed to follow immediately the lower bin boundaires
* and are designated by the "_HI" termination.
*
* This method sets the following members:
* m_colname_lo - Column names of lower boundaries
* m_colname_hi - Column names of upper boundaries
* m_colname_par - Column names of parameters
* m_naxes - Number of axes
* m_npars - Number of parameters
*
* In case that the HDU pointer is not valid (NULL), this method clears the
* column names and does nothing else.
*
* @todo Implement exceptions for invalid HDU format
***************************************************************************/
void GCTAResponseTable::read_colnames(const GFitsTable& hdu)
{
// Clear column name arrays
m_naxes = 0;
m_npars = 0;
m_colname_lo.clear();
m_colname_hi.clear();
m_colname_par.clear();
// Initialise search mode. There are three search modes:
// 0 - we're looking for the next axis by searching for a column
// terminating with "_LO"
// 1 - we're looking for the upper boundary of an axis, terminating
// with "_HI"
// 2 - we're looking for a parameter column
int mode = 0;
std::string lo_column;
std::string next_column;
// Extract column names for all axes
for (int i = 0; i < hdu.ncols(); ++i) {
// Get column name and unit
std::string colname = hdu[i]->name();
// If we search for a "_LO" column, check if we have one. If one
// is found, change the search mode to 1 and set the expected name
// for the "_HI" column. If none is found, change the search
// mode to 2 since from now on we should only have parameter
// columns.
if (mode == 0) {
size_t pos = colname.rfind("_LO");
if (pos != std::string::npos) {
mode = 1;
lo_column = colname;
next_column = colname.substr(0, pos) + "_HI";
}
else {
if (colname.rfind("_HI") != std::string::npos) {
std::string message = "Column '" +
colname +
"' encountered without"
" preceeding '_LO' column.";
throw GCTAException::bad_rsp_table_format(G_READ_COLNAMES,
message);
}
else {
mode = 2;
m_colname_par.push_back(colname);
}
}
}
// If we search for a "_HI" column, check if we have the
// expected column name. If this is the case, switch back to
// search mode 0 to get the next "_LO" column. Otherwise
// throw an exception.
else if (mode == 1) {
if (colname == next_column) {
mode = 0;
m_colname_lo.push_back(lo_column);
m_colname_hi.push_back(next_column);
}
else {
std::string message = "Expected column '" +
next_column +
"' not found. '_HI' columns have"
" to be placed immediately after"
" corresponding '_LO' columns.";
throw GCTAException::bad_rsp_table_format(G_READ_COLNAMES,
message);
}
}
// If we search for a parameter column, make sure that we have
// neither a "_LO" nor a "_HI" column.
else {
if (colname.rfind("_LO") != std::string::npos) {
std::string message = "Column '" +
colname +
"' found. All '_LO' columns have to"
" be placed before the parameter"
" columns.";
throw GCTAException::bad_rsp_table_format(G_READ_COLNAMES,
message);
}
else if (colname.rfind("_HI") != std::string::npos) {
std::string message = "Column '" +
colname +
"' found. All '_HI' columns have to"
" be placed before the parameter"
" columns.";
throw GCTAException::bad_rsp_table_format(G_READ_COLNAMES,
message);
}
else {
m_colname_par.push_back(colname);
}
}
} // endfor: looped over all columns
// Store number of axes
m_naxes = m_colname_lo.size();
// Store number of parameters
m_npars = m_colname_par.size();
// Return
return;
}
/***********************************************************************//**
* @brief Read axes definitions from FITS HDU
*
* @param[in] hdu Response table HDU.
*
* @exception GCTAException::bad_rsp_table_format
* Incompatible axes columns found.
*
* Reads the lower and upper boundaries for all response table axes from the
* FITS HDU. The method verifies if the lower and upper boundary axes have
* the same vector dimensions.
*
* The method also allocates the nodes for each axis, assuming that axis will
* be used linearily, where each node is given by the linear mean of the
* lower and upper boundary. In case that the axis should be used
* logarithmically, the method axis_log10() can be used to change to a
* logarithmic scale. The axis_linear() can be used to switch back to a
* linear scale.
*
* This method sets the following members:
* m_axis_lo - Axes lower boundaries
* m_axis_hi - Axes upper boundaries
* m_axis_nodes - Axes mean values
*
* In case that the HDU pointer is not valid (NULL), this method clears the
* axes boundaries and does nothing else.
***************************************************************************/
void GCTAResponseTable::read_axes(const GFitsTable& hdu)
{
// Clear axes arrays
m_axis_lo.clear();
m_axis_hi.clear();
m_axis_nodes.clear();
// Loop over all dimensions
for (int i = 0; i < axes(); ++i) {
// Get pointers to table columns
const GFitsTableCol* col_lo = hdu[m_colname_lo[i]];
const GFitsTableCol* col_hi = hdu[m_colname_hi[i]];
// Extract number of bins. Make sure that both columns have the
// same number of bins
int num = col_lo->number();
if (num != col_hi->number()) {
std::string message = "Incompatible number of bins found"
" for columns '"+m_colname_lo[i]+"'"+
" ("+gammalib::str(num)+") and '"+
m_colname_hi[i]+"' ("+
gammalib::str(col_hi->number())+".";
throw GCTAException::bad_rsp_table_format(G_READ_AXES,
message);
}
// Initialise axis and node arrays
std::vector<double> axis_lo(num);
std::vector<double> axis_hi(num);
std::vector<double> axis_nodes(num);
// Copy axis information into arrays
for (int k = 0; k < num; ++k) {
axis_lo[k] = col_lo->real(0,k);
axis_hi[k] = col_hi->real(0,k);
axis_nodes[k] = 0.5*(axis_lo[k] + axis_hi[k]);
}
// Push axis array on storage
m_axis_lo.push_back(axis_lo);
m_axis_hi.push_back(axis_hi);
// Push units on storage
m_units_lo.push_back(col_lo->unit());
m_units_hi.push_back(col_hi->unit());
// Create node array
m_axis_nodes.push_back(GNodeArray(axis_nodes));
} // endfor: looped over all dimensions
// Return
return;
}
/***********************************************************************//**
* @brief Read parameter cubes
*
* @param[in] hdu Response table HDU.
*
* @exception GCTAException::bad_rsp_table_format
* Parameter vector of bad size encountered.
*
* Reads the parameter cubes from the response table. The method also sets
* the data members m_npars (number of parameters) and m_nelements (number
* of elements per parameter).
*
* This method sets the following members:
* m_pars - Parameter values
* m_nelements - Number of elements per parameter
*
* In case that the HDU pointer is not valid (NULL), this method clears the
* axes boundaries and does nothing else.
***************************************************************************/
void GCTAResponseTable::read_pars(const GFitsTable& hdu)
{
// Clear parameter cubes
m_pars.clear();
// Compute expected cube size
m_nelements = axis(0);
for (int i = 1; i < axes(); ++i) {
m_nelements *= axis(i);
}
// Loop over all parameter cubes
for (int i = 0; i < size(); ++i) {
// Get pointer to table column
const GFitsTableCol* col = hdu[m_colname_par[i]];
// Extract number of bins. Verify that the number of bins
// corresponds to the expectation.
int num = col->number();
if (num != m_nelements) {
std::string message = "Parameter vector '"+m_colname_par[i]+
"' has wrong size "+gammalib::str(num)+
" (expected"+
gammalib::str(m_nelements)+").";
throw GCTAException::bad_rsp_table_format(G_READ_PARS,
message);
}
// Initialise parameter cube
std::vector<double> pars(num);
// Copy parameter values
for (int k = 0; k < num; ++k) {
pars[k] = col->real(0,k);
}
// Push cube into storage
m_pars.push_back(pars);
// Push units on storage
m_units_par.push_back(col->unit());
} // endfor: looped over all parameter cubes
// Return
return;
}
/***********************************************************************//**
* @brief Update 1D cache
*
* @param[in] arg Argument.
*
* Updates the 1D interpolation cache. The interpolation cache is composed
* of two indices and weights that define 2 data values of the 2D table
* that are used for linear interpolation.
*
* @todo Write down formula
*
* @todo Makes GNodeArray::set_value method const and use mutable members
***************************************************************************/
void GCTAResponseTable::update(const double& arg) const
{
// Get pointer to node array (circumvent const correctness)
GNodeArray* nodes = const_cast<GNodeArray*>(&(m_axis_nodes[0]));
// Set value for node array
nodes->set_value(arg);
// Set indices and weighting factors for interpolation
m_inx_left = nodes->inx_left();
m_inx_right = nodes->inx_right();
m_wgt_left = nodes->wgt_left();
m_wgt_right = nodes->wgt_right();
// Return
return;
}
/***********************************************************************//**
* @brief Update 2D cache
*
* @param[in] arg1 Argument for first axis.
* @param[in] arg2 Argument for second axis.
*
* Updates the 2D interpolation cache. The interpolation cache is composed
* of four indices and weights that define 4 data values of the 2D table
* that are used for bilinear interpolation.
*
* @todo Write down formula
*
* @todo Makes GNodeArray::set_value method const and use mutable members
***************************************************************************/
void GCTAResponseTable::update(const double& arg1, const double& arg2) const
{
// Get pointers to node arrays (circumvent const correctness)
GNodeArray* nodes1 = const_cast<GNodeArray*>(&(m_axis_nodes[0]));
GNodeArray* nodes2 = const_cast<GNodeArray*>(&(m_axis_nodes[1]));
// Set values for node arrays
nodes1->set_value(arg1);
nodes2->set_value(arg2);
// Compute offsets
int size1 = axis(0);
int offset_left = nodes2->inx_left() * size1;
int offset_right = nodes2->inx_right() * size1;
// Set indices for bi-linear interpolation
m_inx1 = nodes1->inx_left() + offset_left;
m_inx2 = nodes1->inx_left() + offset_right;
m_inx3 = nodes1->inx_right() + offset_left;
m_inx4 = nodes1->inx_right() + offset_right;
// Set weighting factors for bi-linear interpolation
m_wgt1 = nodes1->wgt_left() * nodes2->wgt_left();
m_wgt2 = nodes1->wgt_left() * nodes2->wgt_right();
m_wgt3 = nodes1->wgt_right() * nodes2->wgt_left();
m_wgt4 = nodes1->wgt_right() * nodes2->wgt_right();
// Return
return;
}
/***********************************************************************//**
* @brief Update 3D cache
*
* @param[in] arg1 Argument for first axis.
* @param[in] arg2 Argument for second axis.
* @param[in] arg3 Argument for third axis.
*
* Updates the 3D interpolation cache. The interpolation cache is composed
* of four indices and weights that define 4 data values of the 2D table
* that are used for bilinear interpolation.
*
* @todo Write down formula
*
* @todo Makes GNodeArray::set_value method const and use mutable members
***************************************************************************/
void GCTAResponseTable::update(const double& arg1, const double& arg2,
const double& arg3) const
{
// Get pointers to node arrays (circumvent const correctness)
GNodeArray* nodes1 = const_cast<GNodeArray*>(&(m_axis_nodes[0]));
GNodeArray* nodes2 = const_cast<GNodeArray*>(&(m_axis_nodes[1]));
GNodeArray* nodes3 = const_cast<GNodeArray*>(&(m_axis_nodes[2]));
// Set values for node arrays
nodes1->set_value(arg1);
nodes2->set_value(arg2);
nodes3->set_value(arg3);
// Compute offsets
int size1 = axis(0);
int size2 = axis(1);
int offset_left_2 = nodes2->inx_left() * size1;
int offset_right_2 = nodes2->inx_right() * size1;
int offset_left_3 = nodes3->inx_left() * size1 * size2;
int offset_right_3 = nodes3->inx_right() * size1 * size2;
// Set indices for tri-linear interpolation
m_inx1 = nodes1->inx_left() + offset_left_2 + offset_left_3 ;
m_inx2 = nodes1->inx_left() + offset_left_2 + offset_right_3;
m_inx3 = nodes1->inx_left() + offset_right_2 + offset_left_3 ;
m_inx4 = nodes1->inx_left() + offset_right_2 + offset_right_3;
m_inx5 = nodes1->inx_right() + offset_left_2 + offset_left_3 ;
m_inx6 = nodes1->inx_right() + offset_left_2 + offset_right_3;
m_inx7 = nodes1->inx_right() + offset_right_2 + offset_left_3 ;
m_inx8 = nodes1->inx_right() + offset_right_2 + offset_right_3;
// Set weighting factors for tri-linear interpolation
m_wgt1 = nodes1->wgt_left() * nodes2->wgt_left() * nodes3->wgt_left();
m_wgt2 = nodes1->wgt_left() * nodes2->wgt_left() * nodes3->wgt_right();
m_wgt3 = nodes1->wgt_left() * nodes2->wgt_right() * nodes3->wgt_left();
m_wgt4 = nodes1->wgt_left() * nodes2->wgt_right() * nodes3->wgt_right();
m_wgt5 = nodes1->wgt_right() * nodes2->wgt_left() * nodes3->wgt_left();
m_wgt6 = nodes1->wgt_right() * nodes2->wgt_left() * nodes3->wgt_right();
m_wgt7 = nodes1->wgt_right() * nodes2->wgt_right() * nodes3->wgt_left();
m_wgt8 = nodes1->wgt_right() * nodes2->wgt_right() * nodes3->wgt_right();
// Return
return;
}