-
Notifications
You must be signed in to change notification settings - Fork 0
/
Source.py
1033 lines (722 loc) · 33.2 KB
/
Source.py
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
# $Id: Source.py,v 1.1.1.1 2008/04/20 15:03:22 elwinter Exp $
#******************************************************************************
# Import external modules.
# Standard modules.
from copy import deepcopy
import xml.dom.minidom
# Third-party modules.
# Project modules.
from Element import Element
from Spectrum import Spectrum
from SpatialModel import SpatialModel
#******************************************************************************
class Source(Element):
"""Source class to represent <source> elements in ModelEditor.
Data attributes:
_name: (string) Name for the Source. Corresponds to the 'name'
attribute of the <source> element.
_type: (string) Type string for the Source. Corresponds to the
'type' attribute of the <source> element.
_spectrum: (Spectrum) Object containing the spectral model for the
Source. Corresponds to the child <spectrum> element of the
<source> element.
_spatialModel: (SpatialModel) Object containing the spatial model
for the Source. Corresponds to the child <spatialModel> element of
the <source> element.
"""
#--------------------------------------------------------------------------
# Class constants
# Define the tag name.
_tagName = 'source'
# Define attribute defaults.
_defaultName = 'source'
_defaultType = 'PointSource'
_defaultSpectrumType = 'PowerLaw'
_defaultSpectrum = None
_defaultSpatialModelType = 'SkyDirFunction'
_defaultSpatialModel = None
# Define the valid source types.
_validTypes = ['PointSource', 'DiffuseSource']
# Tag name for output grobssim-format source elements.
_gtobssimSourceElementTagName = 'source'
# Minimum and maximum energies (MeV) for conversion form
# ModelEditor to gtobssim source formats.
_Emin = 30.0
_Emax = 2.0e5
#--------------------------------------------------------------------------
def __init__(self,
name = _defaultName,
type = _defaultType,
spectrum = _defaultSpectrum,
spatialModel = _defaultSpatialModel,
dom = None,
*args, **kwargs):
"""Initialize this Source.
Parameters:
self: This object.
name: (string) Name for this Source.
type: (string) Type string for this Source.
spectrum: (Spectrum) Object containing the spectral model for
this Source.
spatialModel: (SpatialModel) Object containing the spatial
model for this Source.
dom: (xml.dom.minidom.Element) Object representing a <source>
element to use when creating this Source. If this parameter is
provided, the other parameters are ignored.
"""
# Initialize the parent class. Do not pass the dom argument,
# since it will be used if needed when fromDom is called
# below.
Element.__init__(self, Source._tagName, *args, **kwargs)
# Set attributes.
if dom:
if isinstance(dom, xml.dom.minidom.Element):
self.fromDom(dom)
else:
raise TypeError('Not a DOM element (%s)!' % dom)
else:
self.setName(name)
self.setType(type)
if spectrum is None:
spectrum = Spectrum(type = Source._defaultSpectrumType)
self.setSpectrum(spectrum)
if spatialModel is None:
spatialModel = SpatialModel(type = \
Source._defaultSpatialModelType)
self.setSpatialModel(spatialModel)
#--------------------------------------------------------------------------
def toDom(self, domDocument):
"""Convert this Source to a xml.dom.minidom.Element.
Parameters:
self: This object.
domDocument (xml.dom.minidom.Document): DOM document to use
when converting this Source (required).
Return value:
xml.dom.minidom.Element for this Source.
Description:
Convert this Source to an equivalent xml.dom.minidom.Element
in the specified DOM document. After the DOM element is
created by the inherited toDom() method, the attribute and
element nodes are set using the data attributes of this
Source.
"""
# Call the inherited method.
dom = Element.toDom(self, domDocument)
# Name
dom.setAttribute('name', self.getName())
# Type
dom.setAttribute('type', self.getType())
# Create and append a DOM element for the child Spectrum.
spectrum = self.getSpectrum()
domSpectrum = spectrum.toDom(domDocument)
dom.appendChild(domSpectrum)
# Create and append a DOM element for the child SpatialModel.
spatialModel = self.getSpatialModel()
domSpatialModel = spatialModel.toDom(domDocument)
dom.appendChild(domSpatialModel)
# Return the new DOM element.
return dom
def fromDom(self, dom):
"""Initialize this Source from a xml.dom.minidom.Element.
Parameters:
self: This object.
dom (xml.dom.minidom.Element): DOM element to use as the
source of this Source.
Return value:
None.
Description:
Use the specified DOM element as the source of the content of
this Source. Set all data attributes using the corresponding
attribute and element nodes of the DOM element.
"""
# Call the inherited method.
Element.fromDom(self, dom)
# name
self.setName(dom.getAttribute('name'))
# type
self.setType(dom.getAttribute('type'))
# <spectrum> element
domSpectrum = dom.getElementsByTagName('spectrum').item(0)
spectrum = Spectrum(dom = domSpectrum)
self.setSpectrum(spectrum)
# <spatialModel> element
domSpatialModel = dom.getElementsByTagName('spatialModel').item(0)
spatialModel = SpatialModel(dom = domSpatialModel)
self.setSpatialModel(spatialModel)
#--------------------------------------------------------------------------
def toObssimDom(self, domDocument):
"""Convert this object to a gtobssim.xsd-compliant XML <source>.
Parameters:
self: This object.
domDocument (xml.dom.minidom.Document): DOM document to use
when converting this Source (required).
Return value:
xml.dom.minidom.Element of gtobssim.xsd-compliant XML.
Description:
Use this Source to create a new xml.dom.minidom.Element for a
<source> element, using the specified xml.dom.minidom.Document
object as the owner document. The new element will conform to
the gtobssim input schema. Return the new DOM element.
"""
# Fetch the spectrum.
spectrum = self.getSpectrum()
# Make sure this is a supported Source type.
spectrumType = spectrum.getType()
if spectrumType == 'PowerLaw':
gtobssimSource = self._powerLaw2Gtobssim(domDocument)
elif spectrumType == 'BrokenPowerLaw':
gtobssimSource = self._brokenPowerLaw2Gtobssim(domDocument)
elif spectrumType == 'PowerLaw2':
gtobssimSource = self._powerLaw22Gtobssim(domDocument)
elif spectrumType == 'BrokenPowerLaw2':
gtobssimSource = self._brokenPowerLaw22Gtobssim(domDocument)
else:
raise TypeError('Not a supported spectrum type (%s)!' % \
spectrumType)
# Return the new DOM element.
return gtobssimSource
#--------------------------------------------------------------------------
def getName(self):
"""Return the name for this Source.
Parameters:
self: This object.
Return value:
String containing the name for this Source.
Description:
Return the name of this Source as a string.
"""
return self._name
def setName(self, name):
"""Set the name for this Source.
Parameters:
self: This object.
name (string): New name for this Source.
Return value:
None.
Description:
Set the name of this Source to the specified string. If the
new name is invalid, raise a TypeError exception.
"""
if not self.validName(name):
raise TypeError('Invalid Source name (%s)!' % name)
self._name = str(name)
def validName(self, name):
"""Check a Source name for validity.
Parameters:
self: This object.
name (string): Proposed name for this Source.
Return value:
True if the name is valid, otherwise False.
Description:
Check if the proposed new name is valid. A name is valid if
evaluates to a non-empty string.
"""
if name is None:
return False # str(None) = 'None'
name = str(name)
if name == '':
return False
return True
#--------------------------------------------------------------------------
def getType(self):
"""Return the type for this Source.
Parameters:
self: This object.
Return value:
String containing the type for this Source.
Description:
Return the type for this Source as a string.
"""
return self._type
def setType(self, type):
"""Set the type for this Source.
Parameters:
self: This object.
type (string): New type for this Source.
Return value:
None.
Description:
Set the type of this Source to the specified string. If an
invalid type is specified, raise a TypeError exception.
"""
if not self.validType(type):
raise TypeError('Invalid Source type (%s)!' % type)
self._type = type
def validType(self, type):
"""
Synopsis:
Check a type for validity.
Parameters:
self: This object.
type (string): Proposed type for this Source.
Return value:
True if the type is valid, otherwise False.
Description:
Check if the proposed new type is valid. A type is valid if it
is found in the list of valid type strings.
"""
if type in self.getValidTypes():
return True
return False
def getValidTypes(self):
"""Return the the list of valid Source types.
Parameters:
self: This object.
Return value:
List of strings containing the valid Source types.
Description:
Return the valid types for a Source as a list of strings.
"""
return Source._validTypes
#--------------------------------------------------------------------------
def getSpectrum(self):
"""Return the Spectrum for this Source.
Parameters:
self: This object.
Return value:
Copy of the Spectrum for this Source.
Description:
Return a copy of the Spectrum for this Source.
"""
return deepcopy(self._spectrum)
def setSpectrum(self, spectrum):
"""Set the Spectrum for this Source.
Parameters:
self: This object.
spectrum (Spectrum): New Spectrum for this Source.
Return value:
None.
Description:
Set the Spectrum of this Source to a copy of the specified
Spectrum. If an invalid Source is specified, raise a TypeError
exception.
"""
if not self.validSpectrum(spectrum):
raise TypeError('Invalid Source Spectrum (%s)!' % spectrum)
self._spectrum = deepcopy(spectrum)
def validSpectrum(self, spectrum):
"""Check a Spectrum for validity.
Parameters:
self: This object.
spectrum (Spectrum): Proposed Spectrum for this Source.
Return value:
True if the Spectrum is valid, otherwise False.
Description:
Check if the proposed new Spectrum is valid. A Spectrum is
valid if it is not None. Make this more specific later.
"""
if spectrum is None:
return False
return True
#--------------------------------------------------------------------------
def getSpatialModel(self):
"""Return the SpatialModel for this Source.
Parameters:
self: This object.
Return value:
Copy of the SpatialModel for this Source.
Description:
Return a copy of the SpatialModel for this Source.
"""
return deepcopy(self._spatialModel)
def setSpatialModel(self, spatialModel):
"""Set the SpatialModel for this Source.
Parameters:
self: This object.
spatialModel (SpatialModel): New SpatialModel for this Source.
Return value:
None.
Description:
Set the SpatialModel of this Source to a copy of the specified
SpatialModel. If an invalid Source is specified, raise a TypeError
exception.
"""
if not self.validSpatialModel(spatialModel):
raise TypeError('Invalid Source SpatialModel (%s)!' % spatialModel)
self._spatialModel = deepcopy(spatialModel)
def validSpatialModel(self, spatialModel):
"""Check a SpatialModel for validity.
Parameters:
self: This object.
spatialModel (SpatialModel): Proposed SpatialModel for this Source.
Return value:
True if the SpatialModel is valid, otherwise False.
Description:
Check if the proposed new SpatialModel is valid. A SpatialModel is
valid if it is not None. Make this more specific later.
"""
if spatialModel is None:
return False
return True
#--------------------------------------------------------------------------
def _powerLaw2Gtobssim(self, gtobssimDocument):
"""Convert a ModelEditor PowerLaw to a gtobssim power law
Parameters:
self: This object.
gtobssimDocument (xml.dom.minidom.Document): DOM document to
use when converting this Source.
Return value:
xml.dom.minidom.Element object for gtobssim.xsd-compliant
power law source element.
Description:
Convert this Source to a gtobssim-format power law source
element.
"""
# Save locals.
Emin = Source._Emin
Emax = Source._Emax
# Fetch the spectrum.
spectrum = self.getSpectrum()
# Fetch the ModelEditor-format PowerLaw parameters.
parameter = spectrum.getParameterByName('Prefactor')
N0 = parameter.getValue() * parameter.getScale()
parameter = spectrum.getParameterByName('Scale')
E0 = parameter.getValue() * parameter.getScale()
parameter = spectrum.getParameterByName('Index')
g = parameter.getValue() * parameter.getScale()
# Compute the total flux between Emin and Emax by integrating
# the distribution between those limits.
flux = N0 * E0 / (g + 1) * \
((Emax / E0)**(g + 1) - (Emin / E0)**(g + 1))
# Convert the integrated flux from photons/cm^2/s to
# photons/m^2/s.
flux *= 1.0e4
# Create the output DOM element.
gtobssimSource = \
gtobssimDocument.createElement(Source.\
_gtobssimSourceElementTagName)
# Set the source name attribute from the input source name.
gtobssimSource.setAttribute('name', self.getName())
# Set the output flux attribute.
gtobssimSource.setAttribute('flux', str(flux))
# Create and append the child <spectrum>.
gtobssimSpectrum = gtobssimDocument.createElement('spectrum')
gtobssimSource.appendChild(gtobssimSpectrum)
# Set the escale attribute of the child <spectrum>.
gtobssimSpectrum.setAttribute('escale', 'MeV')
# Create and append the <particle> child of the <spectrum>.
gtobssimParticle = gtobssimDocument.createElement('particle')
gtobssimSpectrum.appendChild(gtobssimParticle)
# Set the <particle> name attribute.
gtobssimParticle.setAttribute('name', 'gamma')
# Create and append the child <power_law>.
gtobssimPowerLaw = gtobssimDocument.createElement('power_law')
gtobssimParticle.appendChild(gtobssimPowerLaw)
# Set the <power_law> emin attribute.
gtobssimPowerLaw.setAttribute('emin', str(Emin))
# Set the <power_law> gamma attribute.
gamma = -g
gtobssimPowerLaw.setAttribute('gamma', str(gamma))
# Set the <power_law> emax attribute.
gtobssimPowerLaw.setAttribute('emax', str(Emax))
# Create and append the <celestial_dir> child of the
# <spectrum>.
gtobssimCelestialDir = gtobssimDocument.createElement('celestial_dir')
gtobssimSpectrum.appendChild(gtobssimCelestialDir)
# Fetch the current spatial model.
spatialModel = self.getSpatialModel()
# Make sure the spatial model is supported.
spatialModelType = spatialModel.getType()
if spatialModelType not in ('SkyDirFunction'):
raise TypeError('Not a supported spatial model type (%s)!' \
% spatialModelType)
# Set the coordinates of the source.
parameter = spatialModel.getParameterByName('RA')
ra = parameter.getValue() * parameter.getScale()
gtobssimCelestialDir.setAttribute('ra', str(ra))
parameter = spatialModel.getParameterByName('DEC')
dec = parameter.getValue() * parameter.getScale()
gtobssimCelestialDir.setAttribute('dec', str(dec))
# Return the new DOM element.
return gtobssimSource
#--------------------------------------------------------------------------
def _brokenPowerLaw2Gtobssim(self, gtobssimDocument):
"""Convert a BrokenPowerLaw to a gtobssim (broken) power law
Parameters:
self: This object.
gtobssimDocument (xml.dom.minidom.Document): DOM document to
use when converting this Source.
Return value:
xml.dom.minidom.Element object for gtobssim.xsd-compliant
power law source element.
Description:
Convert this Source to a gtobssim-format power law source
element.
"""
# Save locals.
Emin = Source._Emin
Emax = Source._Emax
# Fetch the spectrum.
spectrum = self.getSpectrum()
# Fetch the ModelEditor-format PowerLaw parameters.
parameter = spectrum.getParameterByName('Prefactor')
N0 = parameter.getValue() * parameter.getScale()
parameter = spectrum.getParameterByName('BreakValue')
Eb = parameter.getValue() * parameter.getScale()
parameter = spectrum.getParameterByName('Index1')
g1 = parameter.getValue() * parameter.getScale()
parameter = spectrum.getParameterByName('Index2')
g2 = parameter.getValue() * parameter.getScale()
# Compute the total flux between Emin and Emax by integrating
# the distribution between those limits.
f1 = (1 - (Emin / Eb)**(g1 + 1)) / (g1 + 1)
f2 = ((Emax / Eb)**(g2 + 1) - 1) / (g2 + 1)
flux = N0 * Eb * (f1 + f2)
# Convert the integrated flux from photons/cm^2/s to
# photons/m^2/s.
flux *= 1.0e4
# Create the output DOM element.
gtobssimSource = \
gtobssimDocument.createElement(Source.\
_gtobssimSourceElementTagName)
# Set the source name attribute from the input source name.
gtobssimSource.setAttribute('name', self.getName())
# Set the output flux attribute.
gtobssimSource.setAttribute('flux', str(flux))
# Create and append the child <spectrum>.
gtobssimSpectrum = gtobssimDocument.createElement('spectrum')
gtobssimSource.appendChild(gtobssimSpectrum)
# Set the escale attribute of the child <spectrum>.
gtobssimSpectrum.setAttribute('escale', 'MeV')
# Create and append the <particle> child of the <spectrum>.
gtobssimParticle = gtobssimDocument.createElement('particle')
gtobssimSpectrum.appendChild(gtobssimParticle)
# Set the <particle> name attribute.
gtobssimParticle.setAttribute('name', 'gamma')
# Create and append the child <power_law>.
gtobssimPowerLaw = gtobssimDocument.createElement('power_law')
gtobssimParticle.appendChild(gtobssimPowerLaw)
# Set the <power_law> emin attribute.
gtobssimPowerLaw.setAttribute('emin', str(Emin))
# Set the <power_law> gamma attribute.
gamma = -g1
gtobssimPowerLaw.setAttribute('gamma', str(gamma))
# Set the <power_law> emax attribute.
gtobssimPowerLaw.setAttribute('emax', str(Emax))
# Set the <power_law> ebreak attribute.
gtobssimPowerLaw.setAttribute('ebreak', str(Eb))
# Set the <power_law> gamma2 attribute.
gamma2 = -g2
gtobssimPowerLaw.setAttribute('gamma2', str(gamma2))
# Create and append the <celestial_dir> child of the
# <spectrum>.
gtobssimCelestialDir = gtobssimDocument.createElement('celestial_dir')
gtobssimSpectrum.appendChild(gtobssimCelestialDir)
# Fetch the current spatial model.
spatialModel = self.getSpatialModel()
# Make sure the spatial model is supported.
spatialModelType = spatialModel.getType()
if spatialModelType not in ('SkyDirFunction'):
raise TypeError ('Not a supported spatial model type (%s)!' \
% spatialModelType)
# Set the coordinates of the source.
parameter = spatialModel.getParameterByName('RA')
ra = parameter.getValue() * parameter.getScale()
gtobssimCelestialDir.setAttribute('ra', str(ra))
parameter = spatialModel.getParameterByName('DEC')
dec = parameter.getValue() * parameter.getScale()
gtobssimCelestialDir.setAttribute('dec', str(dec))
# Return the new DOM element.
return gtobssimSource
#--------------------------------------------------------------------------
def _powerLaw22Gtobssim(self, gtobssimDocument):
"""Convert a PowerLaw2 to a gtobssim power law
Parameters:
self: This object.
gtobssimDocument (xml.dom.minidom.Document): DOM document to
use when converting this Source.
Return value:
xml.dom.minidom.Element object for gtobssim.xsd-compliant
power law source element.
Description:
Convert this Source to a gtobssim-format power law 2 source
element.
"""
# Fetch the spectrum.
spectrum = self.getSpectrum()
# Fetch the ModelEditor-format PowerLaw parameters.
parameter = spectrum.getParameterByName('Integral')
N = parameter.getValue() * parameter.getScale()
parameter = spectrum.getParameterByName('Index')
g = parameter.getValue() * parameter.getScale()
parameter = spectrum.getParameterByName('LowerLimit')
Emin = parameter.getValue() * parameter.getScale()
parameter = spectrum.getParameterByName('UpperLimit')
Emax = parameter.getValue() * parameter.getScale()
# Compute the total flux between Emin and Emax by integrating
# the distribution between those limits.
flux = N
# Convert the integrated flux from photons/cm^2/s to
# photons/m^2/s.
flux *= 1.0e4
# Create the output DOM element.
gtobssimSource = \
gtobssimDocument.\
createElement(Source._gtobssimSourceElementTagName)
# Set the source name attribute from the input source name.
gtobssimSource.setAttribute('name', self.getName())
# Set the output flux attribute.
gtobssimSource.setAttribute('flux', str(flux))
# Create and append the child <spectrum>.
gtobssimSpectrum = gtobssimDocument.createElement('spectrum')
gtobssimSource.appendChild(gtobssimSpectrum)
# Set the escale attribute of the child <spectrum>.
gtobssimSpectrum.setAttribute('escale', 'MeV')
# Create and append the <particle> child of the <spectrum>.
gtobssimParticle = gtobssimDocument.createElement('particle')
gtobssimSpectrum.appendChild(gtobssimParticle)
# Set the <particle> name attribute.
gtobssimParticle.setAttribute('name', 'gamma')
# Create and append the child <power_law>.
gtobssimPowerLaw = gtobssimDocument.createElement('power_law')
gtobssimParticle.appendChild(gtobssimPowerLaw)
# Set the <power_law> emin attribute.
gtobssimPowerLaw.setAttribute('emin', str(Emin))
# Set the <power_law> gamma attribute.
gamma = -g
gtobssimPowerLaw.setAttribute('gamma', str(gamma))
# Set the <power_law> emax attribute.
gtobssimPowerLaw.setAttribute('emax', str(Emax))
# Create and append the <celestial_dir> child of the
# <spectrum>.
gtobssimCelestialDir = gtobssimDocument.createElement('celestial_dir')
gtobssimSpectrum.appendChild(gtobssimCelestialDir)
# Fetch the current spatial model.
spatialModel = self.getSpatialModel()
# Make sure the spatial model is supported.
spatialModelType = spatialModel.getType()
if spatialModelType not in ('SkyDirFunction'):
raise TypeError('Not a supported spatial model type (%s)!' \
% spatialModelType)
# Set the coordinates of the source.
parameter = spatialModel.getParameterByName('RA')
ra = parameter.getValue() * parameter.getScale()
gtobssimCelestialDir.setAttribute('ra', str(ra))
parameter = spatialModel.getParameterByName('DEC')
dec = parameter.getValue() * parameter.getScale()
gtobssimCelestialDir.setAttribute('dec', str(dec))
# Return the new DOM element.
return gtobssimSource
#--------------------------------------------------------------------------
def _brokenPowerLaw22Gtobssim(self, gtobssimDocument):
"""Convert a BrokenPowerLaww to a gtobssim (broken) power law
Parameters:
self: This object.
gtobssimDocument (xml.dom.minidom.Document): DOM document to
use when converting this Source.
Return value:
xml.dom.minidom.Element object for gtobssim.xsd-compliant
power law source element.
Description:
Convert this Source to a gtobssim-format power law source
element.
"""
# Fetch the spectrum.
spectrum = self.getSpectrum()
# Fetch the ModelEditor-format PowerLaw parameters.
parameter = spectrum.getParameterByName('Integral')
N = parameter.getValue() * parameter.getScale()
parameter = spectrum.getParameterByName('Index1')
g1 = parameter.getValue() * parameter.getScale()
parameter = spectrum.getParameterByName('Index2')
g2 = parameter.getValue() * parameter.getScale()
parameter = spectrum.getParameterByName('BreakValue')
Eb = parameter.getValue() * parameter.getScale()
parameter = spectrum.getParameterByName('LowerLimit')
Emin = parameter.getValue() * parameter.getScale()
parameter = spectrum.getParameterByName('UpperLimit')
Emax = parameter.getValue() * parameter.getScale()
# Compute the total flux between Emin and Emax by integrating
# the distribution between those limits.
flux = N
# Convert the integrated flux from photons/cm^2/s to
# photons/m^2/s.
flux *= 1.0e4
# Create the output DOM element.
gtobssimSource = \
gtobssimDocument.\
createElement(Source._gtobssimSourceElementTagName)
# Set the source name attribute from the input source name.
gtobssimSource.setAttribute('name', self.getName())
# Set the output flux attribute.
gtobssimSource.setAttribute('flux', str(flux))
# Create and append the child <spectrum>.
gtobssimSpectrum = gtobssimDocument.createElement('spectrum')
gtobssimSource.appendChild(gtobssimSpectrum)
# Set the escale attribute of the child <spectrum>.
gtobssimSpectrum.setAttribute('escale', 'MeV')
# Create and append the <particle> child of the <spectrum>.
gtobssimParticle = gtobssimDocument.createElement('particle')
gtobssimSpectrum.appendChild(gtobssimParticle)
# Set the <particle> name attribute.
gtobssimParticle.setAttribute('name', 'gamma')
# Create and append the child <power_law>.
gtobssimPowerLaw = gtobssimDocument.createElement('power_law')
gtobssimParticle.appendChild(gtobssimPowerLaw)
# Set the <power_law> emin attribute.
gtobssimPowerLaw.setAttribute('emin', str(Emin))
# Set the <power_law> gamma attribute.
gamma = -g1
gtobssimPowerLaw.setAttribute('gamma', str(gamma))
# Set the <power_law> emax attribute.
gtobssimPowerLaw.setAttribute('emax', str(Emax))
# Set the <power_law> ebreak attribute.
gtobssimPowerLaw.setAttribute('ebreak', str(Eb))
# Set the <power_law> gamma2 attribute.
gamma2 = -g2
gtobssimPowerLaw.setAttribute('gamma2', str(gamma2))
# Create and append the <celestial_dir> child of the
# <spectrum>.
gtobssimCelestialDir = gtobssimDocument.createElement('celestial_dir')
gtobssimSpectrum.appendChild(gtobssimCelestialDir)
# Fetch the current spatial model.
spatialModel = self.getSpatialModel()
# Make sure the spatial model is supported.
spatialModelType = spatialModel.getType()
if spatialModelType not in ('SkyDirFunction'):
raise TypeError('Not a supported spatial model type (%s)!' \
% spatialModelType)
# Set the coordinates of the source.
parameter = spatialModel.getParameterByName('RA')
ra = parameter.getValue() * parameter.getScale()
gtobssimCelestialDir.setAttribute('ra', str(ra))
parameter = spatialModel.getParameterByName('DEC')
dec = parameter.getValue() * parameter.getScale()
gtobssimCelestialDir.setAttribute('dec', str(dec))
# Return the new DOM element.
return gtobssimSource
#******************************************************************************
# Self-test code.
# If this code generates any output, an error has been found.
if __name__ == '__main__':
# Default constructor.
source = Source()
assert str(source) == 'Source(_name=source,_spatialModel=SpatialModel(_file=None,_parameters=[Parameter(_free=False,_max=360.0,_min=0.0,_name=RA,_scale=1.0,_tagName=parameter,_value=0.0),Parameter(_free=False,_max=90.0,_min=-90.0,_name=DEC,_scale=1.0,_tagName=parameter,_value=0.0)],_tagName=spatialModel,_type=SkyDirFunction),_spectrum=Spectrum(_file=None,_parameters=[Parameter(_free=True,_max=1000.0,_min=0.001,_name=Prefactor,_scale=1e-09,_tagName=parameter,_value=1.0),Parameter(_free=True,_max=-1.0,_min=-5.0,_name=Index,_scale=1.0,_tagName=parameter,_value=-2.1),Parameter(_free=False,_max=2000.0,_min=30.0,_name=Scale,_scale=1.0,_tagName=parameter,_value=100.0)],_tagName=spectrum,_type=PowerLaw),_tagName=source,_type=PointSource)'