GCTAObservation.cpp
33.7 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
/***************************************************************************
* GCTAObservation.cpp - CTA Observation class *
* ----------------------------------------------------------------------- *
* copyright (C) 2010-2012 by Juergen Knoedlseder *
* ----------------------------------------------------------------------- *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
* *
***************************************************************************/
/**
* @file GCTAObservation.cpp
* @brief CTA observation class implementation
* @author J. Knoedlseder
*/
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include "GObservationRegistry.hpp"
#include "GCTAException.hpp"
#include "GCTAObservation.hpp"
#include "GCTAEventList.hpp"
#include "GCTAEventCube.hpp"
#include "GCTARoi.hpp"
#include "GException.hpp"
#include "GFits.hpp"
#include "GTools.hpp"
#include "GModelSpatialPtsrc.hpp"
#include "GIntegral.hpp"
#include "GIntegrand.hpp"
/* __ Globals ____________________________________________________________ */
const GCTAObservation g_obs_cta_seed;
const GObservationRegistry g_obs_cta_registry(&g_obs_cta_seed);
/* __ Method name definitions ____________________________________________ */
#define G_RESPONSE "GCTAObservation::response(GResponse&)"
#define G_READ "GCTAObservation::read(GXmlElement&)"
#define G_WRITE "GCTAObservation::write(GXmlElement&)"
#define G_READ_DS_EBOUNDS "GCTAObservation::read_ds_ebounds(GFitsHDU*)"
#define G_READ_DS_ROI "GCTAObservation::read_ds_roi(GFitsHDU*)"
/* __ Macros _____________________________________________________________ */
/* __ Coding definitions _________________________________________________ */
/* __ Debug definitions __________________________________________________ */
/*==========================================================================
= =
= Constructors/destructors =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Void constructor
*
* Creates empty class instance.
***************************************************************************/
GCTAObservation::GCTAObservation(void) : GObservation()
{
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Copy constructor
*
* @param[in] obs CTA observation.
*
* Creates class instance by copying an existing CTA observation.
***************************************************************************/
GCTAObservation::GCTAObservation(const GCTAObservation& obs) : GObservation(obs)
{
// Initialise members
init_members();
// Copy members
copy_members(obs);
// Return
return;
}
/***********************************************************************//**
* @brief Destructor
***************************************************************************/
GCTAObservation::~GCTAObservation(void)
{
// Free members
free_members();
// Return
return;
}
/*==========================================================================
= =
= Operators =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Assignment operator
*
* @param[in] obs CTA observation.
*
* Assign CTA observation to this object.
***************************************************************************/
GCTAObservation& GCTAObservation::operator= (const GCTAObservation& obs)
{
// Execute only if object is not identical
if (this != &obs) {
// Copy base class members
this->GObservation::operator=(obs);
// Free members
free_members();
// Initialise members
init_members();
// Copy members
copy_members(obs);
} // endif: object was not identical
// Return this object
return *this;
}
/*==========================================================================
= =
= Public methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Clear instance
***************************************************************************/
void GCTAObservation::clear(void)
{
// Free members
free_members();
this->GObservation::free_members();
// Initialise members
this->GObservation::init_members();
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Clone instance
***************************************************************************/
GCTAObservation* GCTAObservation::clone(void) const
{
return new GCTAObservation(*this);
}
/***********************************************************************//**
* @brief Set response function
*
* @param[in] rsp Response function.
*
* @exception GCTAException::bad_response_type
* Specified response in not of type GCTAResponse.
*
* Sets the response function for the observation. The argument has to be of
* type GCTAResponse, otherwise an exception is thrown.
***************************************************************************/
void GCTAObservation::response(const GResponse& rsp)
{
// Get pointer on CTA response
const GCTAResponse* ctarsp = dynamic_cast<const GCTAResponse*>(&rsp);
if (ctarsp == NULL)
throw GCTAException::bad_response_type(G_RESPONSE);
// Delete old response function
if (m_response != NULL) delete m_response;
// Clone response function
m_response = ctarsp->clone();
// Return
return;
}
/***********************************************************************//**
* @brief Set CTA response function
*
* @param[in] irfname Name of CTA response function.
* @param[in] caldb Optional name of calibration database.
***************************************************************************/
void GCTAObservation::response(const std::string& irfname, std::string caldb)
{
// Delete old response function
if (m_response != NULL) delete m_response;
// Allocate new CTA response function
m_response = new GCTAResponse;
// Set calibration database
m_response->caldb(caldb);
// Load instrument response function
m_response->load(irfname);
// Return
return;
}
/***********************************************************************//**
* @brief Returns pointer to CTA response function
***************************************************************************/
GCTAResponse* GCTAObservation::response(void) const
{
// Return response pointer
return m_response;
}
/***********************************************************************//**
* @brief Returns pointer to CTA pointing direction
*
* Returns pointer to pointing direction.
***************************************************************************/
GCTAPointing* GCTAObservation::pointing(void) const
{
// Return pointing pointer
return m_pointing;
}
/***********************************************************************//**
* @brief Set CTA pointing direction
*
* @param[in] pointing Pointing.
***************************************************************************/
void GCTAObservation::pointing(const GCTAPointing& pointing)
{
// Free any existing pointing
if (m_pointing != NULL) delete m_pointing;
m_pointing = NULL;
// Clone pointing
m_pointing = pointing.clone();
// Return
return;
}
/***********************************************************************//**
* @brief Returns instrument name
***************************************************************************/
std::string GCTAObservation::instrument(void) const
{
// Return instument name
return ("CTA");
}
/***********************************************************************//**
* @brief Read observation from XML element
*
* @param[in] xml XML element.
*
* @exception GException::xml_invalid_parnum
* Invalid number of parameters found in XML element.
* @exception GException::xml_invalid_parnames
* Invalid parameter names found in XML element.
*
* Reads information for a CTA observation from an XML element.
* The expected format of the XML element is
*
* <observation name="..." id="..." instrument="CTA">
* <parameter name="EventList" file="..."/>
* <parameter name="ARF" file="..."/>
* <parameter name="RMF" file="..."/>
* <parameter name="PSF" file="..."/>
* </observation>
*
* for an unbinned observation and
*
* <observation name="..." id="..." instrument="CTA">
* <parameter name="CountsMap" file="..."/>
* <parameter name="ARF" file="..."/>
* <parameter name="RMF" file="..."/>
* <parameter name="PSF" file="..."/>
* </observation>
*
* for a binned observation.
***************************************************************************/
void GCTAObservation::read(const GXmlElement& xml)
{
// Clear observation
clear();
// Initialise response parameters
std::string arf = "";
std::string rmf = "";
std::string psf = "";
double thetacut = 0.0;
double scale = 1.0;
// Determine number of parameter nodes in XML element
int npars = xml.elements("parameter");
// Verify that XML element has exactly 4 parameters
if (xml.elements() != 4 || npars != 4) {
throw GException::xml_invalid_parnum(G_READ, xml,
"CTA observation requires exactly 4 parameters.");
}
// Extract parameters
int npar[] = {0, 0, 0, 0};
for (int i = 0; i < npars; ++i) {
// Get parameter element
GXmlElement* par = (GXmlElement*)xml.element("parameter", i);
// Handle EventList
if (par->attribute("name") == "EventList") {
// Read eventlist file name
std::string filename = par->attribute("file");
// Load unbinned observation (sets also m_evenfile member)
load_unbinned(filename);
// Increment parameter counter
npar[0]++;
}
// Handle CountsMap
else if (par->attribute("name") == "CountsMap") {
// Read countsmap file name
std::string filename = par->attribute("file");
// Load binned observation (sets also m_evenfile member)
load_binned(filename);
// Increment parameter counter
npar[0]++;
}
// Handle ARF
else if (par->attribute("name") == "ARF") {
// Store filename
arf = par->attribute("file");
// Optionally extract thetacut (0.0 if no thetacut)
std::string s_thetacut = par->attribute("thetacut");
if (s_thetacut.length() > 0) {
thetacut = todouble(s_thetacut);
}
// Optionally extract scale factor (1.0 if no scale)
std::string s_scale = par->attribute("scale");
if (s_scale.length() > 0) {
scale = todouble(s_scale);
}
// Increase number of parameters
npar[1]++;
}
// Handle RMF
else if (par->attribute("name") == "RMF") {
rmf = par->attribute("file");
npar[2]++;
}
// Handle PSF
else if (par->attribute("name") == "PSF") {
psf = par->attribute("file");
npar[3]++;
}
} // endfor: looped over all parameters
// Verify that all parameters were found
if (npar[0] != 1 || npar[1] != 1 || npar[2] != 1 || npar[3] != 1) {
throw GException::xml_invalid_parnames(G_READ, xml,
"Require \"EventList\" or \"CountsMap\" and \"ARF\", \"RMF\""
" \"PSF\" parameters.");
}
// Delete old response function
if (m_response != NULL) delete m_response;
// Allocate new CTA response function
m_response = new GCTAResponse;
// Load PSF (need this before ARF to handle thetacut)
if (strip_whitespace(psf).length() > 0) {
m_response->load_psf(psf);
}
// Load ARF
if (strip_whitespace(arf).length() > 0) {
m_response->arf_thetacut(thetacut);
m_response->arf_scale(scale);
m_response->load_arf(arf);
}
// Return
return;
}
/***********************************************************************//**
* @brief Write observation into XML element
*
* @param[in] xml XML element.
*
* @exception GException::no_list
* No valid CTA event list or event cube found.
* @exception GException::xml_invalid_parnum
* Invalid number of parameters found in XML element.
* @exception GException::xml_invalid_parnames
* Invalid parameter names found in XML element.
*
* Writes information for a CTA observation into an XML element. The expected
* format of the XML element is
*
* <observation name="..." id="..." instrument="CTA">
* <parameter name="EventList" file="..."/>
* <parameter name="ARF" file="..."/>
* <parameter name="RMF" file="..."/>
* <parameter name="PSF" file="..."/>
* </observation>
*
* for an unbinned observation and
*
* <observation name="..." id="..." instrument="CTA">
* <parameter name="CountsMap" file="..."/>
* <parameter name="ARF" file="..."/>
* <parameter name="RMF" file="..."/>
* <parameter name="PSF" file="..."/>
* </observation>
*
* for a binned observation.
*
* @todo We should create a special exception that informs that there is
* neither a valid CTA event list nor a valid CTA counts map in this
* observations.
***************************************************************************/
void GCTAObservation::write(GXmlElement& xml) const
{
// Determine if we deal with a binned or unbinned observation
const GCTAEventList* list = dynamic_cast<const GCTAEventList*>(m_events);
const GCTAEventCube* cube = dynamic_cast<const GCTAEventCube*>(m_events);
if (list == NULL && cube == NULL) {
throw GException::no_list(G_WRITE);
}
// Set event list flag
bool is_list = (list != NULL);
// If XML element has 0 nodes then append 4 parameter nodes
if (xml.elements() == 0) {
if (is_list) {
xml.append(new GXmlElement("parameter name=\"EventList\""));
}
else {
xml.append(new GXmlElement("parameter name=\"CountsMap\""));
}
xml.append(new GXmlElement("parameter name=\"ARF\""));
xml.append(new GXmlElement("parameter name=\"RMF\""));
xml.append(new GXmlElement("parameter name=\"PSF\""));
}
// Verify that XML element has exactly 4 parameters
if (xml.elements() != 4 || xml.elements("parameter") != 4) {
throw GException::xml_invalid_parnum(G_WRITE, xml,
"CTA observation requires exactly 4 parameters.");
}
// Set or update parameter attributes
int npar[] = {0, 0, 0, 0};
for (int i = 0; i < 4; ++i) {
// Get parameter element
GXmlElement* par = (GXmlElement*)xml.element("parameter", i);
// Handle Eventlist
if (par->attribute("name") == "EventList") {
par->attribute("file", m_eventfile);
npar[0]++;
}
// Handle Countsmap
else if (par->attribute("name") == "CountsMap") {
par->attribute("file", m_eventfile);
npar[0]++;
}
// Handle ARF
else if (par->attribute("name") == "ARF") {
std::string arf = "";
double thetacut = 0.0;
double scale = 1.0;
if (m_response != NULL) {
arf = m_response->arffile();
thetacut = m_response->arf_thetacut();
scale = m_response->arf_scale();
}
par->attribute("file", arf);
if (thetacut > 0.0) {
par->attribute("thetacut", str(thetacut));
}
if (scale != 1.0) {
par->attribute("scale", str(scale));
}
npar[1]++;
}
// Handle RMF
else if (par->attribute("name") == "RMF") {
std::string rmf = "";
if (m_response != NULL) {
rmf = m_response->rmffile();
}
par->attribute("file", rmf);
npar[2]++;
}
// Handle PSF
else if (par->attribute("name") == "PSF") {
std::string psf = "";
if (m_response != NULL) {
psf = m_response->psffile();
}
par->attribute("file", psf);
npar[3]++;
}
} // endfor: looped over all parameters
// Verify that all required parameters are present
if (npar[0] != 1 || npar[1] != 1 || npar[2] != 1 || npar[3] != 1) {
throw GException::xml_invalid_parnames(G_WRITE, xml,
"Require \"EventList\" or \"CountsMap\" and \"ARF\", \"RMF\""
" \"PSF\" parameters.");
}
// Return
return;
}
/***********************************************************************//**
* @brief Print CTA observation information
***************************************************************************/
std::string GCTAObservation::print(void) const
{
// Initialise result string
std::string result;
// Append header
result.append("=== GCTAObservation ===");
result.append("\n"+parformat("Name")+name());
result.append("\n"+parformat("Identifier")+id());
result.append("\n"+parformat("Instrument")+instrument());
result.append("\n"+parformat("Statistics")+statistics());
result.append("\n"+parformat("Ontime")+str(ontime()));
result.append("\n"+parformat("Livetime")+str(livetime()));
result.append("\n"+parformat("Deadtime correction")+str(m_deadc));
// Append pointing
if (m_pointing != NULL) {
result.append("\n"+m_pointing->print());
}
else {
result.append("\n"+parformat("CTA pointing")+"undefined");
}
// Append response
if (m_response != NULL) {
result.append("\n"+response()->print());
}
else {
result.append("\n"+parformat("CTA response")+"undefined");
}
// Append events
if (m_events != NULL) {
result.append("\n"+m_events->print());
}
// Return result
return result;
}
/***********************************************************************//**
* @brief Load data for unbinned analysis
*
* @param[in] filename Event FITS file name.
***************************************************************************/
void GCTAObservation::load_unbinned(const std::string& filename)
{
// Delete any existing event container (do not call clear() as we do not
// want to delete the response function)
if (m_events != NULL) delete m_events;
m_events = NULL;
// Allocate event list
GCTAEventList* events = new GCTAEventList;
// Assign event list as the observation's event container
m_events = events;
// Open FITS file
GFits file(filename);
// Read event list
events->read(file);
// Read observation attributes from EVENTS extension
GFitsHDU* hdu = file.hdu("EVENTS");
read_attributes(hdu);
// Close FITS file
file.close();
// Store event filename
m_eventfile = filename;
// Return
return;
}
/***********************************************************************//**
* @brief Load data for binned analysis
*
* @param[in] filename Counts map FITS file name.
***************************************************************************/
void GCTAObservation::load_binned(const std::string& filename)
{
// Delete any existing event container (do not call clear() as we do not
// want to delete the response function)
if (m_events != NULL) delete m_events;
m_events = NULL;
// Allocate event cube
GCTAEventCube* events = new GCTAEventCube;
// Assign event cube as the observation's event container
m_events = events;
// Open FITS file
GFits file(filename);
// Read event cube
events->read(file);
// Read observation attributes from primary extension
GFitsHDU* hdu = file.hdu(0);
read_attributes(hdu);
// Close FITS file
file.close();
// Store event filename
m_eventfile = filename;
// Return
return;
}
/***********************************************************************//**
* @brief Save CTA observation into FITS file.
*
* @param[in] filename FITS filename.
* @param[in] clobber Overwrite existing FITS file (default=false).
***************************************************************************/
void GCTAObservation::save(const std::string& filename, bool clobber) const
{
// Create FITS file
GFits fits;
// Get pointers on event list
GCTAEventList* list = dynamic_cast<GCTAEventList*>(m_events);
GCTAEventCube* cube = dynamic_cast<GCTAEventCube*>(m_events);
// Case A: Observation contains an event list
if (list != NULL) {
// Write event list into FITS file. This method also writes
// the GTI as they are part of the event list.
list->write(fits);
// Write observation attributes into EVENTS header
GFitsHDU* hdu = fits.hdu("EVENTS");
write_attributes(hdu);
} // endif: observation contained an event list
// Case B: Observation contains an event cube
else if (cube != NULL) {
// Write events cube into FITS file. This method also writes
// the energy boundaries and the GTI as they are also part
// of the event cube.
cube->write(fits);
// Write observation attributes into primary header
GFitsHDU* hdu = fits.hdu(0);
write_attributes(hdu);
} // endelse: observation contained an event cube
// Save FITS file
fits.saveto(filename, clobber);
// Return
return;
}
/*==========================================================================
= =
= Private methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Initialise class members
***************************************************************************/
void GCTAObservation::init_members(void)
{
// Initialise members
m_eventfile.clear();
m_response = NULL;
m_pointing = NULL;
m_obs_id = 0;
m_ontime = 0.0;
m_livetime = 0.0;
m_deadc = 0.0;
m_ra_obj = 0.0;
m_dec_obj = 0.0;
// Return
return;
}
/***********************************************************************//**
* @brief Copy class members
*
* @param[in] obs CTA observation.
***************************************************************************/
void GCTAObservation::copy_members(const GCTAObservation& obs)
{
// Clone members
if (obs.m_response != NULL) m_response = obs.m_response->clone();
if (obs.m_pointing != NULL) m_pointing = obs.m_pointing->clone();
// Copy members
m_eventfile = obs.m_eventfile;
m_obs_id = obs.m_obs_id;
m_ontime = obs.m_ontime;
m_livetime = obs.m_livetime;
m_deadc = obs.m_deadc;
m_ra_obj = obs.m_ra_obj;
m_dec_obj = obs.m_dec_obj;
// Return
return;
}
/***********************************************************************//**
* @brief Delete class members
***************************************************************************/
void GCTAObservation::free_members(void)
{
// Free memory
if (m_response != NULL) delete m_response;
if (m_pointing != NULL) delete m_pointing;
// Mark memory as free
m_response = NULL;
m_pointing = NULL;
// Return
return;
}
/***********************************************************************//**
* @brief Read observation attributes
*
* @param[in] hdu FITS HDU pointer
*
* Reads CTA observation attributes from HDU. Mandatory attributes are
*
* RA_PNT - Right Ascension of pointing
* DEC_PNT - Declination of pointing
* ONTIME - Exposure time
* LIVETIME - Livetime
*
* and optional attributes are
*
* OBJECT - Name of observed object
* DEADC - Deadtime correction
* RA_OBJ - Right Ascension of observed object,
* DEC_OBJ - Declination of observed object,
* OBS_ID - Observation identifier
* ALT_PNT - Altitude of pointing above horizon
* AZ_PNT - Azimuth of pointing
*
* Based on RA_PNT and DEC_PNT, the CTA pointing direction is set. Note that
* DEADC is computed using DEADC=LIVETIME/ONTIME
*
* Nothing is done if the HDU pointer is NULL.
*
* @todo The actual reader is a minimal reader to accomodate as many
* different datasets as possible. Once the CTA data format is fixed
* the reader should have more mandatory attributes.
***************************************************************************/
void GCTAObservation::read_attributes(const GFitsHDU* hdu)
{
// Continue only if HDU is valid
if (hdu != NULL) {
// Read mandatory attributes
double ra_pnt = hdu->real("RA_PNT");
double dec_pnt = hdu->real("DEC_PNT");
m_ontime = (hdu->hascard("ONTIME")) ? hdu->real("ONTIME") : 0.0;
m_livetime = (hdu->hascard("LIVETIME")) ? hdu->real("LIVETIME") : 0.0;
// Read optional attributes
m_name = (hdu->hascard("OBJECT")) ? hdu->string("OBJECT") : "unknown";
m_deadc = (hdu->hascard("DEADC")) ? hdu->real("DEADC") : 0.0;
m_ra_obj = (hdu->hascard("RA_OBJ")) ? hdu->real("RA_OBJ") : 0.0;
m_dec_obj = (hdu->hascard("DEC_OBJ")) ? hdu->real("DEC_OBJ") : 0.0;
m_obs_id = (hdu->hascard("OBS_ID")) ? hdu->integer("OBS_ID") : 0;
double alt = (hdu->hascard("ALT_PNT")) ? hdu->real("ALT_PNT") : 0.0;
double az = (hdu->hascard("AZ_PNT")) ? hdu->real("AZ_PNT") : 0.0;
// Kluge: compute DEADC from livetime and ontime instead of using the
// keyword value as the original event lists had this values badly
// assigned
if (m_ontime > 0) {
m_deadc = m_livetime / m_ontime;
}
else {
m_deadc = 0.0;
}
// Set pointing information
GSkyDir pnt;
pnt.radec_deg(ra_pnt, dec_pnt);
if (m_pointing != NULL) delete m_pointing;
m_pointing = new GCTAPointing;
m_pointing->dir(pnt);
} // endif: HDU was valid
// Return
return;
}
/***********************************************************************//**
* @brief Write observation attributes
*
* @param[in] hdu FITS HDU pointer
*
* Nothing is done if the HDU pointer is NULL.
***************************************************************************/
void GCTAObservation::write_attributes(GFitsHDU* hdu) const
{
// Continue only if HDU is valid
if (hdu != NULL) {
// Compute some attributes
double ra_pnt = (m_pointing != NULL) ? m_pointing->dir().ra_deg() : 0.0;
double dec_pnt = (m_pointing != NULL) ? m_pointing->dir().dec_deg() : 0.0;
double tstart = events()->tstart().met();
double tstop = events()->tstop().met();
double telapse = events()->gti().telapse();
double ontime = events()->gti().ontime();
double deadc = (ontime > 0.0) ? livetime() / ontime : 0.0;
// Set observation information
hdu->card("CREATOR", "GammaLib", "Program which created the file");
hdu->card("TELESCOP", "CTA", "Telescope");
hdu->card("OBS_ID", obs_id(), "Observation identifier");
hdu->card("DATE_OBS", "string", "Observation start date");
hdu->card("TIME_OBS", "string", "Observation start time");
hdu->card("DATE_END", "string", "Observation end date");
hdu->card("TIME_END", "string", "Observation end time");
// Set observation time information
hdu->card("TSTART", tstart, "[s] Mission time of start of observation");
hdu->card("TSTOP", tstop, "[s] Mission time of end of observation");
hdu->card("MJDREFI", 51910, "[days] Integer part of mission time reference MJD");
hdu->card("MJDREFF", 7.428703703703703e-14, "[days] Fractional part of mission time reference MJD");
hdu->card("TIMEUNIT", "s", "Time unit");
hdu->card("TIMESYS", "TT", "Time system");
hdu->card("TIMEREF", "LOCAL", "Time reference");
hdu->card("TELAPSE", telapse, "[s] Mission elapsed time");
hdu->card("ONTIME", ontime, "[s] Total good time including deadtime");
hdu->card("LIVETIME", livetime(), "[s] Total livetime");
hdu->card("DEADC", deadc, "Deadtime correction factor");
hdu->card("TIMEDEL", 1.0, "Time resolution");
// Set pointing information
hdu->card("OBJECT", name(), "Observed object");
hdu->card("RA_OBJ", ra_obj(), "[deg] Target Right Ascension");
hdu->card("DEC_OBJ", dec_obj(), "[deg] Target Declination");
hdu->card("RA_PNT", ra_pnt, "[deg] Pointing Right Ascension");
hdu->card("DEC_PNT", dec_pnt, "[deg] Pointing Declination");
hdu->card("ALT_PNT", 0.0, "[deg] Average altitude of pointing");
hdu->card("AZ_PNT", 0.0, "[deg] Average azimuth of pointing");
hdu->card("RADECSYS", "FK5", "Coordinate system");
hdu->card("EQUINOX", 2000.0, "Epoch");
hdu->card("CONV_DEP", 0.0, "Convergence depth of telescopes");
hdu->card("CONV_RA", 0.0, "[deg] Convergence Right Ascension");
hdu->card("CONV_DEC", 0.0, "[deg] Convergence Declination");
hdu->card("OBSERVER", "string", "Observer");
// Telescope information
hdu->card("N_TELS", 100, "Number of telescopes in event list");
hdu->card("TELLIST", "string", "Telescope IDs");
hdu->card("GEOLAT", 0.0, "[deg] Geographic latitude of array centre");
hdu->card("GEOLON", 0.0, "[deg] Geographic longitude of array centre");
hdu->card("ALTITUDE", 0.0, "[km] Altitude of array centre");
// Other information
hdu->card("EUNIT", "TeV", "Energy unit");
hdu->card("EVTVER", "draft1", "Event list version number");
} // endif: HDU was valid
// Return
return;
}
/*==========================================================================
= =
= Npred integration methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Temporally integrate spatially & spectrally integrated Npred kernel
*
* @param[in] model Gamma-ray source model.
*
* Implement the temporal integration as a simple multiplication by the
* ontime. This assumes that the source is non-variable during the
* observation and that the CTA pointing is stable.
*
* Note that we use here the ontime as the GResponse::irf method returns
* already deadtime corrected response values.
***************************************************************************/
double GCTAObservation::npred_temp(const GModel& model) const
{
// Initialise result
double result = 0.0;
// Determine ontime
double ontime = events()->gti().ontime();
// Integrate only if ontime is positive
if (ontime > 0.0) {
// Integration is a simple multiplication by the time
result = npred_spec(model, events()->gti().tstart()) * ontime;
}
// Return result
return result;
}
/*==========================================================================
= =
= Friends =
= =
==========================================================================*/