ctskymap.cpp
35.9 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
/***************************************************************************
* ctskymap - Sky mapping tool *
* ----------------------------------------------------------------------- *
* copyright (C) 2011-2018 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 ctskymap.cpp
* @brief Sky mapping tool implementation
* @author Juergen Knoedlseder
*/
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <cstdio>
#include "ctskymap.hpp"
/* __ Method name definitions ____________________________________________ */
#define G_GET_PARAMETERS "ctskymap::get_parameter()"
#define G_MAP_EVENTS "ctskymap::map_events(GCTAObservation*)"
#define G_MAP_BACKGROUND_IRF "ctskymap::map_background_irf(GCTAObservation*)"
/* __ Debug definitions __________________________________________________ */
/* __ Coding definitions _________________________________________________ */
/*==========================================================================
= =
= Constructors/destructors =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Void constructor
*
* Constructs an empty sky mapping tool.
***************************************************************************/
ctskymap::ctskymap(void) : ctobservation(CTSKYMAP_NAME, VERSION)
{
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Observations constructor
*
* param[in] obs Observation container.
*
* Constructs sky mapping tool from an observation container.
***************************************************************************/
ctskymap::ctskymap(const GObservations& obs) :
ctobservation(CTSKYMAP_NAME, VERSION, obs)
{
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Command line constructor
*
* @param[in] argc Number of arguments in command line.
* @param[in] argv Array of command line arguments.
*
* Constructs sky mapping tool using command line arguments for user
* parameter setting.
***************************************************************************/
ctskymap::ctskymap(int argc, char *argv[]) :
ctobservation(CTSKYMAP_NAME, VERSION, argc, argv)
{
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Copy constructor
*
* @param[in] app Sky mapping tool.
***************************************************************************/
ctskymap::ctskymap(const ctskymap& app) : ctobservation(app)
{
// Initialise members
init_members();
// Copy members
copy_members(app);
// Return
return;
}
/***********************************************************************//**
* @brief Destructor
***************************************************************************/
ctskymap::~ctskymap(void)
{
// Free members
free_members();
// Return
return;
}
/*==========================================================================
= =
= Operators =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Assignment operator
*
* @param[in] app Sky mapping tool.
* @return Sky mapping tool.
***************************************************************************/
ctskymap& ctskymap::operator=(const ctskymap& app)
{
// Execute only if object is not identical
if (this != &app) {
// Copy base class members
this->ctobservation::operator=(app);
// Free members
free_members();
// Initialise members
init_members();
// Copy members
copy_members(app);
} // endif: object was not identical
// Return this object
return *this;
}
/*==========================================================================
= =
= Public methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Clear sky mapping tool
*
* Clears sky mapping tool.
***************************************************************************/
void ctskymap::clear(void)
{
// Free members
free_members();
this->ctool::free_members();
this->ctobservation::free_members();
// Clear base class (needed to conserve tool name and version)
this->GApplication::clear();
// Initialise members
this->ctool::init_members();
this->ctobservation::init_members();
init_members();
// Write header into logger
log_header();
// Return
return;
}
/***********************************************************************//**
* @brief Run the sky mapping tool
*
* Generates a sky map from event list by looping over all unbinned CTA
* observation in the observation container and filling all events into
* a sky map.
***************************************************************************/
void ctskymap::run(void)
{
// Switch screen logging on in debug mode
if (logDebug()) {
log.cout(true);
}
// Get parameters
get_parameters();
// Setup maps
setup_maps();
// Write input observation container into logger
log_observations(NORMAL, m_obs, "Input observation");
// Write header into logger
log_header1(TERSE, gammalib::number("Find unbinned observation",
m_obs.size()));
// Find all unbinned CTA observations in m_obs
std::vector<GCTAObservation*> obs_list(0);
for (GCTAObservation* obs = first_unbinned_observation(); obs != NULL;
obs = next_unbinned_observation()) {
// Push observation into list
obs_list.push_back(obs);
// Write message
std::string msg = " Including unbinned "+obs->instrument()+
" observation";
log_string(NORMAL, msg);
}
// Write header into logger
log_header1(TERSE, gammalib::number("Map observation", m_obs.size()));
// Loop over all unbinned CTA observations in the container
#pragma omp parallel for
for (int i = 0; i < obs_list.size(); ++i) {
// Get pointer to observation
GCTAObservation* obs = obs_list[i];
// Map events into sky map
map_events(obs);
// Compute background sky map (only if m_bkgsubtract != "NONE")
map_background(obs);
// Dispose events to free memory
obs->dispose_events();
} // endfor: looped over observations
// If background subtraction is selected then compute significance map
if (m_bkgsubtract != "NONE") {
// Compute the significance map
map_significance();
// Subtract background map from counts map
m_skymap -= m_bkgmap;
} // endif: background subtraction is selected
// Optionally publish sky map
if (m_publish) {
publish();
}
// Return
return;
}
/***********************************************************************//**
* @brief Save sky map
*
* Saves the sky map into a FITS file. The FITS file name is specified by the
* @p outname parameter.
***************************************************************************/
void ctskymap::save(void)
{
// Write header
log_header1(TERSE, "Save sky map");
// Get sky map filename
m_outmap = (*this)["outmap"].filename();
// Save sky map if filename and the map are not empty
if (!m_outmap.is_empty() && !m_skymap.is_empty()) {
// Create empty FITS file
GFits fits;
// Write sky map into FITS file
GFitsHDU* hdu = m_skymap.write(fits);
// Write keywords into sky map extension
write_ogip_keywords(hdu);
write_hdu_keywords(hdu);
// If background subtraction is requested then write background map
// and significance map to FITS file
if (m_bkgsubtract != "NONE") {
// Write background map into FITS file
hdu = m_bkgmap.write(fits);
// Set background map extension name
if (hdu != NULL) {
hdu->extname("BACKGROUND");
}
// Write keywords into background extension
write_ogip_keywords(hdu);
write_hdu_keywords(hdu);
// Write significance map into FITS file
hdu = m_sigmap.write(fits);
// Set significance map extension name
if (hdu != NULL) {
hdu->extname("SIGNIFICANCE");
}
// Write keywords into significance extension
write_ogip_keywords(hdu);
write_hdu_keywords(hdu);
} // endif: background subtraction was requested
// Save FITS file to disk
fits.saveto(m_outmap, clobber());
} // endif: filename and map were not empty
// Write into logger what has been done
std::string fname = (m_outmap.is_empty()) ? "NONE" : m_outmap.url();
if (m_skymap.is_empty()) {
fname.append(" (map is empty, no file created)");
}
log_value(NORMAL, "Sky map file", fname);
// Return
return;
}
/***********************************************************************//**
* @brief Publish sky map
*
* @param[in] name Sky map name.
***************************************************************************/
void ctskymap::publish(const std::string& name)
{
// Write header into logger
log_header1(TERSE, "Publish sky map");
// Set default name if user name is empty
std::string user_name(name);
if (user_name.empty()) {
user_name = CTSKYMAP_NAME;
}
// Write sky map name into logger
log_value(NORMAL, "Sky map name", user_name);
// Publish sky map
m_skymap.publish(user_name);
// Return
return;
}
/*==========================================================================
= =
= Private methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Initialise class members
***************************************************************************/
void ctskymap::init_members(void)
{
// Initialise members
m_outmap.clear();
m_inexclusion.clear();
m_emin = 0.0;
m_emax = 0.0;
m_bkgsubtract = "NONE";
m_roiradius = 0.0;
m_inradius = 0.0;
m_outradius = 0.0;
m_publish = false;
m_chatter = static_cast<GChatter>(2);
// Initialise maps
m_skymap.clear();
m_bkgmap.clear();
m_sigmap.clear();
m_exclmap.clear();
// Initialise cache
m_solidangle.clear();
m_dirs.clear();
// Return
return;
}
/***********************************************************************//**
* @brief Copy class members
*
* @param[in] app Application.
***************************************************************************/
void ctskymap::copy_members(const ctskymap& app)
{
// Copy members
m_outmap = app.m_outmap;
m_inexclusion = app.m_inexclusion;
m_emin = app.m_emin;
m_emax = app.m_emax;
m_bkgsubtract = app.m_bkgsubtract;
m_roiradius = app.m_roiradius;
m_inradius = app.m_inradius;
m_outradius = app.m_outradius;
m_publish = app.m_publish;
m_chatter = app.m_chatter;
// Copy maps
m_skymap = app.m_skymap;
m_bkgmap = app.m_bkgmap;
m_sigmap = app.m_sigmap;
m_exclmap = app.m_exclmap;
// Copy cache
m_solidangle = app.m_solidangle;
m_dirs = app.m_dirs;
// Return
return;
}
/***********************************************************************//**
* @brief Delete class members
***************************************************************************/
void ctskymap::free_members(void)
{
// Return
return;
}
/***********************************************************************//**
* @brief Get application parameters
*
* Get all task parameters from parameter file or (if required) by querying
* the user. Most parameters are only required if no observation exists so
* far in the observation container. In this case, a single CTA observation
* will be added to the container, using the definition provided in the
* parameter file.
***************************************************************************/
void ctskymap::get_parameters(void)
{
// Setup observations from "inobs" parameter. Do not request response
// information and do not accept counts cubes.
setup_observations(m_obs, false, true, false);
// Create sky map. Note that the method reads the relevant User parameters.
m_skymap = create_map(m_obs);
// Get further parameters
m_emin = (*this)["emin"].real();
m_emax = (*this)["emax"].real();
m_bkgsubtract = (*this)["bkgsubtract"].string();
// Get RING background parameters
if (m_bkgsubtract == "RING") {
// Get parameters
m_roiradius = (*this)["roiradius"].real();
m_inradius = (*this)["inradius"].real();
m_outradius = (*this)["outradius"].real();
m_inexclusion = (*this)["inexclusion"].filename();
// Make sure that (roiradius < inradius < outradius)
if (m_roiradius > m_inradius) {
std::string msg("'roiradius' must be smaller than 'inradius'");
throw GException::invalid_value(G_GET_PARAMETERS, msg);
}
else if (m_inradius > m_outradius) {
std::string msg("'inradius' must be smaller than 'outradius'");
throw GException::invalid_value(G_GET_PARAMETERS, msg);
}
} // endif: read RING background parameters
// If background subtraction is requested then make sure that the CTA
// observations in the observation container have response information
if (m_bkgsubtract != "NONE") {
set_response(m_obs);
}
// Get remaining parameters
m_publish = (*this)["publish"].boolean();
m_chatter = static_cast<GChatter>((*this)["chatter"].integer());
// Read ahead parameters
if (read_ahead()) {
m_outmap = (*this)["outmap"].filename();
}
// Write parameters into logger
log_parameters(TERSE);
// Return
return;
}
/***********************************************************************//**
* @brief Setup maps
*
* Setup maps for sky map generation.
***************************************************************************/
void ctskymap::setup_maps(void)
{
// Clear cache
m_solidangle.clear();
m_dirs.clear();
// Create background map and significance map if background subtraction
// is requested
if (m_bkgsubtract != "NONE") {
// Create background and significance maps
m_bkgmap = create_map(m_obs);
m_sigmap = create_map(m_obs);
// Setup the exclusions map
map_exclusions(m_inexclusion);
// Cache the pixel solid angles and sky directions
m_solidangle.reserve(m_bkgmap.npix());
m_dirs.reserve(m_bkgmap.npix());
for (int i = 0; i < m_bkgmap.npix(); ++i) {
m_solidangle.push_back(m_bkgmap.solidangle(i));
m_dirs.push_back(m_bkgmap.inx2dir(i));
}
} // endif: background subtraction selected
// Return
return;
}
/***********************************************************************//**
* @brief Generates map of pixel exclusions
*
* @param[in] filename Exclusion file name.
*
* Generates a sky map of the pixels that are to be excluded from the
* background estimation. Pixels with values different from 0 will be
* excluded.
***************************************************************************/
void ctskymap::map_exclusions(const GFilename& filename)
{
// Create exlusion map
m_exclmap = create_map(m_obs);
// Set all pixels to 0 (no pixel excluded)
m_exclmap = 0.0;
// Make sure the exclusions filename is valid
if (is_valid_filename(filename)) {
// Fill the exclusions based on the regions supplied
if (filename.is_fits()) {
map_exclusions_fits(filename);
}
else {
map_exclusions_region(filename);
}
} // endif: filename was valid
// Return
return;
}
/***********************************************************************//**
* @brief Fills exclusions map from FITS image
*
* @param[in] filename FITS image file name.
*
* Sets all exclusion map pixels to 1 that correspond to non-zero pixels in
* the exclusion sky map FITS file.
***************************************************************************/
void ctskymap::map_exclusions_fits(const GFilename& filename)
{
// Load the fits image
GSkyMap inmap(filename);
// Loop through the individual pixels in the exclusion map
for (int i = 0; i < m_exclmap.npix(); ++i) {
// Get the pixel direction
GSkyDir dir = m_exclmap.pix2dir(i);
// Check this sky position in the fits map
if (inmap.contains(dir) && (inmap(inmap.dir2inx(dir)) != 0.0)) {
// Set the pixel to 1
m_exclmap(i) = 1.0;
} // endif: pixel,region overlap check
} // endfor: looped over exclusion map pixels
// Return
return;
}
/***********************************************************************//**
* @brief Fills exclusions map from DS9 region file
*
* @param[in] filename DS9 region file name.
*
* Sets all exclusion map pixels to 1 that are contained in any of the DS9
* regions.
***************************************************************************/
void ctskymap::map_exclusions_region(const GFilename& filename)
{
// Load the exclusion regions
GSkyRegions regions(filename);
// Loop through the individual pixels in the exclusion map
for (int i = 0; i < m_exclmap.npix(); ++i) {
// Get the pixel position
GSkyDir dir = m_exclmap.pix2dir(i);
// If pixel position overlaps with the regions
if (regions.contains(dir)) {
m_exclmap(i) = 1.0;
}
} // endfor: looped over exclusion map pixels
// Return
return;
}
/***********************************************************************//**
* @brief Map events into a sky map
*
* @param[in] obs CTA observation.
*
* @exception GException::no_list
* No event list found in observation.
*
* This method maps the events found in a CTA events list into a sky map.
***************************************************************************/
void ctskymap::map_events(GCTAObservation* obs)
{
// Get non-const pointer on a CTA event list
GCTAEventList* events = dynamic_cast<GCTAEventList*>
(const_cast<GEvents*>(obs->events()));
// Make sure that the observation holds a CTA event list. If this
// is not the case then throw an exception.
if (events == NULL) {
throw GException::no_list(G_MAP_EVENTS);
}
// Setup energy range covered by data
GEnergy emin;
GEnergy emax;
GEbounds ebds;
emin.TeV(m_emin);
emax.TeV(m_emax);
// Initialise binning statistics
int num_outside_roi = 0;
int num_outside_map = 0;
int num_outside_erange = 0;
int num_in_map = 0;
// Extract region of interest from observation
GCTARoi roi = obs->roi();
// Fill sky map
for (int i = 0; i < events->size(); ++i) {
// Get event
GCTAEventAtom* event = (*events)[i];
// Skip if energy is out of range
if (event->energy() < emin || event->energy() > emax) {
num_outside_erange++;
continue;
}
// Determine sky pixel
GCTAInstDir* inst = (GCTAInstDir*)&(event->dir());
GSkyDir dir = inst->dir();
GSkyPixel pixel = m_skymap.dir2pix(dir);
// Skip if pixel is out of range
if (pixel.x() < -0.5 || pixel.x() > (m_skymap.nx() - 0.5) ||
pixel.y() < -0.5 || pixel.y() > (m_skymap.ny() - 0.5)) {
num_outside_map++;
continue;
}
// If RoI is valid then skip if instrument direction is not within RoI
if (roi.is_valid() && !roi.contains(*inst)) {
num_outside_roi++;
continue;
}
// Fill event in skymap
#pragma omp critical(ctskymap_map_events)
m_skymap(pixel) += 1.0;
num_in_map++;
} // endfor: looped over all events
// Log binning results
#pragma omp critical(ctskymap_map_events)
{
log_header3(TERSE, get_obs_header(obs));
log_value(NORMAL, "Events in list", obs->events()->size());
log_value(NORMAL, "Events in map", num_in_map);
log_value(NORMAL, "Events outside RoI", num_outside_roi);
log_value(NORMAL, "Events outside map area", num_outside_map);
log_value(NORMAL, "Events outside energies", num_outside_erange);
// Write sky map into header
log_header1(EXPLICIT, "Sky map");
log_string(EXPLICIT, m_skymap.print(m_chatter));
}
// Return
return;
}
/***********************************************************************//**
* @brief Estimates the background in sky map for observation
*
* @param[in] obs CTA observation.
*
* Estimates the background in the sky map for a given observation and adds
* this estimate to the background sky map. The background estimation method
* is specified by the "bkgsubtract" parameter which can take the following
* values:
*
* NONE - No background estimation
* IRF - Background estimation based on IRF template
* RING - Ring background estimation
***************************************************************************/
void ctskymap::map_background(GCTAObservation* obs)
{
// Dispatch to appropriate background estimation method
if (m_bkgsubtract == "IRF") {
map_background_irf(obs);
}
else if (m_bkgsubtract == "RING") {
map_background_irf(obs);
}
// Return
return;
}
/***********************************************************************//**
* @brief Estimates the background in sky map based on IRF template
*
* @param[in] obs CTA observation.
*
* @exception GException::invalid_value
* No response information available for observation.
* No background template available in instrument response function.
*
* Estimates the background in the sky map using the IRF template for a given
* observation and adds this estimate to the background sky map. The IRF
* template is integrated numerically in energy.
***************************************************************************/
void ctskymap::map_background_irf(GCTAObservation* obs)
{
// Get IRF response
const GCTAResponseIrf* rsp = dynamic_cast<const GCTAResponseIrf*>
(obs->response());
// Throw an exception if observation has no instrument response function
if (rsp == NULL) {
std::string msg = "No response information available for "+
get_obs_header(obs)+" to compute IRF background. "
"Please specify response information or use "
"another background subtraction method.";
throw GException::invalid_value(G_MAP_BACKGROUND_IRF, msg);
}
// Get IRF background template
const GCTABackground* bkg = rsp->background();
// Throw an exception if observation has no IRF background template
if (bkg == NULL) {
std::string msg = "No IRF background template found in instrument "
"response function for "+
get_obs_header(obs)+". Please specify an instrument "
"response function containing a background template.";
throw GException::invalid_value(G_MAP_BACKGROUND_IRF, msg);
}
// Set minimum and maximum energy as GEnergy instances
GEnergy emin(m_emin, "TeV");
GEnergy emax(m_emax, "TeV");
// Extract region of interest center and radius from observation and
// compute the cosine of the RoI radius. This allows to mimimize as
// much as possible the trigonometric computations. Note that the cosine
// of an angle is maximal for an angle of zero. This explains later why
// we chose ">=" to test whether an angle is smaller than a given radius.
GSkyDir roi_centre = obs->roi().centre().dir();
double cos_roi_radius = std::cos(obs->roi().radius() * gammalib::deg2rad);
// Extract exposure
double exposure = obs->livetime();
// Initialise statistics
double total = 0.0;
// Loop over all background map pixels
for (int i = 0; i < m_bkgmap.npix(); ++i) {
// Get sky direction of pixel
GSkyDir& skydir = m_dirs[i];
// Skip pixel if it is not within the RoI
if (roi_centre.cos_dist(skydir) < cos_roi_radius) {
continue;
}
// Convert sky direction to instrument direction
GCTAInstDir instdir = obs->pointing().instdir(skydir);
// Compute background value
double value = bkg->rate_ebin(instdir, emin, emax);
// Multiply background rate with livetime and solid angle
value *= exposure * m_solidangle[i];
// Add number of background events to background map
#pragma omp critical(ctskymap_map_background_irf)
m_bkgmap(i) += value;
// Update total number of background events
total += value;
} // endfor: looped over background map pixels
// Log background subtraction results
#pragma omp critical(ctskymap_map_events)
{
log_value(NORMAL, "Events in background", int(total+0.5));
}
// Return
return;
}
/***********************************************************************//**
* @brief Computes the bin-by-bin significance if background subtraction
* requested
*
* Method computes the bin-by bin significance if a background subtraction
* method is specified. If method is "IRF", Poisson statistics (in the
* Gaussian limit) are assumed. If method is "RING" a Li & Ma significance
* is computed for each bin.
***************************************************************************/
void ctskymap::map_significance(void)
{
// Compute significance from "RING" method (Li & Ma eq. 17)
if (m_bkgsubtract == "RING") {
map_significance_ring();
}
// Compute significance using Poisson statistics in the Gaussian limit
else {
m_sigmap = (m_skymap - m_bkgmap) / sqrt(m_skymap);
}
// Return
return;
}
/***********************************************************************//**
* @brief Computes the bin-by-bin significance for RING background
*
* Computes the a Li & Ma significance for each sky map bin and replaces
* the sky and background maps by the On- and Off-count maps.
***************************************************************************/
void ctskymap::map_significance_ring(void)
{
// Log message about what is being done
log_header1(NORMAL, "Computing Ring background map");
log_value(NORMAL, "Total pixels to process", m_skymap.npix());
// Initialise On- and Off-count maps
GSkyMap onmap = m_skymap;
GSkyMap offmap = m_skymap;
onmap = 0.0;
offmap = 0.0;
// Initialise statistics
int num_bad_alpha = 0;
// Set progress logging frequency. By default the user is updated on the
// progress when another 10% of pixels is processed, however, if there
// are many pixels the user is updated each 100000 pixels.
int n_logpix = m_skymap.npix() / 10;
if (n_logpix > 100000) {
n_logpix = 100000;
}
// Loop over sky map pixels
#pragma omp parallel for
for (int i = 0; i < m_skymap.npix(); ++i) {
// Initialise the on/off counts and alpha for this bin
double n_on = 0.0;
double n_off = 0.0;
double alpha = 0.0;
// Update user about progress
if (i % n_logpix == 0) {
#pragma omp critical(ctskymap_map_significance_ring)
log_value(NORMAL, "Pixels remaining", m_skymap.npix()-i);
}
// Get bin coordinates
GSkyDir& skydir = m_dirs[i];
// Compute the alpha and counts for this bin
compute_ring_values(m_skymap, m_bkgmap, skydir, n_on, n_off, alpha);
// Store the On and alpha-weighted Off-counts
onmap(i) = n_on;
offmap(i) = alpha * n_off;
// If alpha is zero then increment the bad alpha counter
if (alpha == 0.0) {
num_bad_alpha++;
}
// ... otherwise store the results
else {
// Compute and store significance (Li & Ma eq. 17)
double sigma;
if (n_on == 0.0) {
sigma = -2.0 * n_off * std::log(1.0+alpha);
}
else {
sigma = (n_on < (alpha*n_off) ? -2.0 : 2.0) *
(n_on * std::log((1.0+alpha) * n_on / (alpha * (n_on+n_off))) +
n_off * std::log((1.0+alpha) * n_off / (n_on+n_off)));
}
#pragma omp critical(ctskymap_map_significance_ring)
m_sigmap(i) = sigma;
} // endelse: alpha was non-zero
} // endfor: looped over all pixels
// Log the number of bad-alpha bins
log_value(NORMAL, "Bins with alpha=0", num_bad_alpha);
// Now take the square root. Since some bins can be negative, first
// take the absolute value of the map, square root that, then multiply
// each bin by its sign to preserve the +/- significance.
m_sigmap = sign(m_sigmap) * sqrt(abs(m_sigmap));
// Terminate by storing the on-counts map as sky map and the off-counts
// map as background map
m_skymap = onmap;
m_bkgmap = offmap;
// Return
return;
}
/***********************************************************************//**
* @brief Computes Non, Noff and alpha for a counts map and sensitivity map
*
* @param[in] counts Counts map
* @param[in] background Background map
* @param[in] position Position of the ring & roi centers
* @param[out] non Returned estimate of ON counts
* @param[out] noff Returned estimate of OFF counts
* @param[out] alpha Returned estimate of alpha
*
* This method computes the Non counts Noff values at a given position. It
* also computes the alpha parameter from the passed sensitivity map.
***************************************************************************/
void ctskymap::compute_ring_values(const GSkyMap& counts,
const GSkyMap& background,
const GSkyDir& position,
double& non,
double& noff,
double& alpha)
{
// Reset Non and Noff
non = 0.0;
noff = 0.0;
// Initialise On and Off alpha
double alpha_on = 0.0;
double alpha_off = 0.0;
// Compute cosine of radii. We use the cosine of the radius here to
// mimimize as much as possible the trigonometric computations. Note that
// the cosine of an angle is maximal for an angle of zero. This explains
// later why we chose ">=" to test whether an angle is smaller than a
// given radius.
double cos_roiradius = std::cos(m_roiradius * gammalib::deg2rad);
double cos_inradius = std::cos(m_inradius * gammalib::deg2rad);
double cos_outradius = std::cos(m_outradius * gammalib::deg2rad);
// Loop over every pixel in the observation to compute Non, Noff
for (int j = 0; j < counts.npix(); ++j) {
// Get the index and sky direction of this pixel
GSkyDir& skydir = m_dirs[j];
// Only consider pixels within the outer radius of the background region
if (position.cos_dist(skydir) >= cos_outradius) {
// Check if pixel is inside the background region
if ((m_exclmap(j) == 0.0) && position.cos_dist(skydir) < cos_inradius) {
// Update n_off
noff += counts(j);
// Update alpha_off
alpha_off += background(j);
}
// ... otherwise check if pixel is inside source region
else if (position.cos_dist(skydir) >= cos_roiradius) {
// Update n_on for significance computation
non += counts(j);
// Update alpha_on
alpha_on += background(j);
} // endif: source and background region check
} // endif: pixel is within outer radius of background region
} // endfor: looped over pixels
// Compute alpha. If the off region does not have any sensitivity then
// set Non = Noff = 0
if (alpha_off == 0.0) {
alpha = 0.0;
non = 0.0;
noff = 0.0;
}
else {
alpha = alpha_on / alpha_off;
}
// Return
return;
}
/***********************************************************************//**
* @brief Write keywords in FITS HDU
*
* @param[in,out] hdu Pointer to FITS HDU.
*
* Writes keywords in FITS HDU.
***************************************************************************/
void ctskymap::write_hdu_keywords(GFitsHDU* hdu) const
{
// Continue only if pointer is valid
if (hdu != NULL) {
// Set keywords
hdu->card("BKGSUB", m_bkgsubtract, "Background substraction method");
hdu->card("E_MIN", m_emin, "[TeV] Lower energy boundary");
hdu->card("E_MAX", m_emax, "[TeV] Upper energy boundary");
hdu->card("EUNIT", "TeV", "Units for E_MIN and E_MAX");
// Write RING background keywords
if (m_bkgsubtract == "RING") {
hdu->card("ROIRAD", m_roiradius, "[deg] Source region radius");
hdu->card("INRAD", m_inradius, "[deg] Inner background ring radius");
hdu->card("OUTRAD", m_outradius, "[deg] Outer background ring radius");
}
} // endif: pointer was valid
// Return
return;
}