-
Notifications
You must be signed in to change notification settings - Fork 0
/
Spectrum.py
959 lines (798 loc) · 27.3 KB
/
Spectrum.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
# $Id: Spectrum.py,v 1.4 2010/05/11 01:32:47 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 Parameter import Parameter
from ParameterSet import ParameterSet
#******************************************************************************
class Spectrum(Element, ParameterSet):
"""Spectrum class to represent <spectrum> elements in ModelEditor.
Data attributes:
_type: (string) Type string for the Spectrum. Corresponds to the
'type' attribute of the <spectrum> element.
_file: (string) Path string for the Spectrum. Corresponds to the
'file' attribute of the <spectrum> element.
"""
#--------------------------------------------------------------------------
# Class constants
# Define the tag name.
_tagName = 'spectrum'
# Define the default parameters for each Spectrum type.
_defaultParameters = {
'PowerLaw':
[
Parameter(name = 'Prefactor',
value = 1.0,
scale = 1.0e-9,
min = 0.001,
max = 1000.0,
free = True),
Parameter(name = 'Index',
value = -2.1,
scale = 1.0,
min = -5.0,
max = -1.0,
free = True),
Parameter(name = 'Scale',
value = 100.0,
scale = 1.0,
min = 30.0,
max = 2000.0,
free = False)
],
'BrokenPowerLaw':
[
Parameter(name = 'Prefactor',
value = 1.0,
scale = 1.0e-9,
min = 0.001,
max = 1000.0,
free = True),
Parameter(name = 'Index1',
value = -1.8,
scale = 1.0,
min = -5.0,
max = -1.0,
free = True),
Parameter(name = 'BreakValue',
value = 1000.0,
scale = 1.0,
min = 30.0,
max = 2000.0,
free = True),
Parameter(name = 'Index2',
value = -2.3,
scale = 1.0,
min = -5.0,
max = -1.0,
free = True)
],
'PowerLaw2':
[
Parameter(name = 'Integral',
value = 1.0,
scale = 1.0e-6,
min = 1.0e-5,
max = 1000.0,
free = True),
Parameter(name = 'Index',
value = -2.0,
scale = 1.0,
min = -5.0,
max = -1.0,
free = True),
Parameter(name = 'LowerLimit',
value = 20.0,
scale = 1.0,
min = 20.0,
max = 2.0e5,
free = False),
Parameter(name = 'UpperLimit',
value = 2.0e5,
scale = 1.0,
min = 20.0,
max = 2.0e5,
free = False)
],
'BrokenPowerLaw2':
[
Parameter(name = 'Integral',
value = 1.0,
scale = 1.0e-4,
min = 0.001,
max = 1000.0,
free = True),
Parameter(name = 'Index1',
value = -1.8,
scale = 1.0,
min = -5.0,
max = -1.0,
free = True),
Parameter(name = 'Index2',
value = -2.3,
scale = 1.0,
min = -5.0,
max = -1.0,
free = True),
Parameter(name = 'BreakValue',
value = 1000.0,
scale = 1.0,
min = 30.0,
max = 1.0e4,
free = True),
Parameter(name = 'LowerLimit',
value = 20.0,
scale = 1.0,
min = 20.0,
max = 2.0e5,
free = False),
Parameter(name = 'UpperLimit',
value = 2.0e5,
scale = 1.0,
min = 20.0,
max = 2.0e5,
free = False)
],
'LogParabola':
[
Parameter(name = 'norm',
value = 1.0,
scale = 1.0e-9,
min = 0.001,
max = 1000.0,
free = True),
Parameter(name = 'alpha',
value = 1.0,
scale = 1.0,
min = 0.0,
max = 10.0,
free = True),
Parameter(name = 'Eb',
value = 300.0,
scale = 1.0,
min = 20.0,
max = 1.0e4,
free = True),
Parameter(name = 'beta',
value = 2.0,
scale = 1.0,
min = 0.0,
max = 10.0,
free = True)
],
'ExpCutoff':
[
Parameter(name = 'Prefactor',
value = 50.0,
scale = 1.0e-9,
min = 0.01,
max = 1.0e5,
free = True),
Parameter(name = 'Index',
value = -2.1,
scale = 1.0,
min = -5.0,
max = -1.0,
free = True),
Parameter(name = 'Scale',
value = 100.0,
scale = 1.0,
min = 30.0,
max = 2000.0,
free = False),
Parameter(name = 'Ebreak',
value = 10.0,
scale = 1.0,
min = 1.0,
max = 300.0,
free = True),
Parameter(name = 'P1',
value = 100.0,
scale = 1000.0,
min = 0.1,
max = 300.0,
free = True),
Parameter(name = 'P2',
value = 0.0,
scale = 1.0,
min = -1.0,
max = 1.0,
free = False),
Parameter(name = 'P3',
value = 0.0,
scale = 1.0,
min = -1.0,
max = 1.0,
free = False)],
"BrokenPowerLawExpCutoff":
[
Parameter(name = 'Prefactor',
value = 1.0,
scale = 1.0e-9,
min = 0.01,
max = 1.0e5,
free = True),
Parameter(name = 'Index1',
value = -2.1,
scale = 1.0,
min = -5.0,
max = -1.001,
free = True),
Parameter(name = 'Index2',
value = -2.1,
scale = 1.0,
min = -5.0,
max = -1.001,
free = True),
Parameter(name = 'BreakValue',
value = 1000.0,
scale = 1.0,
min = 1.0,
max = 1.0e4,
free = True),
Parameter(name = 'Eabs',
value = 10.0,
scale = 1.0,
min = 1.0,
max = 300.0,
free = True),
Parameter(name = 'P1',
value = 100.0,
scale = 1000.0,
min = 0.1,
max = 300.0,
free = True)
],
'Gaussian':
[
Parameter(name = 'Prefactor',
value = 1.0,
scale = 1.0e-9,
min = 0.001,
max = 1000.0,
free = True),
Parameter(name = 'Mean',
value = 7.0e4,
scale = 1.0,
min = 1000.0,
max = 1.0e5,
free = True),
Parameter(name = 'Sigma',
value = 1000.0,
scale = 1.0,
min = 30.0,
max = 1.0e4,
free = True)
],
'ConstantValue':
[
Parameter(name = 'Value',
value = 1.0,
scale = 1.0,
min = 0.0,
max = 10.0,
free = False)
],
'FileFunction':
[
Parameter(name = 'Normalization',
value = 1.0,
scale = 1.0,
min = 1.0e-5,
max = 1.0e5,
free = True)
],
"BandFunction":
[
Parameter(name = "norm",
value = 1.0,
scale = 1.0e-9,
min = 1.0e-5,
max = 1000.0,
free = True),
Parameter(name = "alpha",
value = -1.8,
scale = 1.0,
min = -5.0,
max = -1.0,
free = True),
Parameter(name = "beta",
value = -2.5,
scale = 1.0,
min = -5.0,
max = -1.0,
free = True),
Parameter(name = "Ep",
value = 0.1,
scale = 1.0,
min = 0.001,
max = 10.0,
free = True),
Parameter(name = "Scale",
value = 0.1,
scale = 1.0,
min = 0.001,
max = 1.0e5,
free = False),
],
'PLSuperExpCutoff':
[
Parameter(name = 'Prefactor',
value = 1.0,
scale = 1.0e-7,
min = 1.0e-5,
max = 1000.0,
free = True),
Parameter(name = 'Index1',
value = -1.7,
scale = 1.0,
min = -5.0,
max = 0.0,
free = True),
Parameter(name = 'Scale',
value = 200.0,
scale = 1.0,
min = 50.0,
max = 1000.0,
free = False),
Parameter(name = 'Cutoff',
value = 3000.0,
scale = 1.0,
min = 500.0,
max = 3.0e4,
free = True),
Parameter(name = 'Index2',
value = 1.5,
scale = 1.0,
min = 0.0,
max = 5.0,
free = True)
],
'PLSuperExpCutoff2':
[
Parameter(name = 'Prefactor',
value = 1.0,
scale = 1.0e-11,
min = 1.0e-5,
max = 1000.0,
free = True),
Parameter(name = 'Index1',
value = 1.7,
scale = -1.0,
min = -1.5,
max = 5.0,
free = True),
Parameter(name = 'Scale',
value = 1.0,
scale = 1000.0,
min = 0.001,
max = 1000.0,
free = False),
Parameter(name = 'Expfactor',
value = 0.001,
scale = 1.0,
min = -1.0,
max = 1,
free = True),
Parameter(name = 'Index2',
value = 1.0,
scale = 1.0,
min = 0.0,
max = 2.0,
free = False)
],
'PLSuperExpCutoff3':
[
Parameter(name = 'Prefactor',
value = 1.0,
scale = 1.0e-11,
min = 1.0e-5,
max = 1000.0,
free = True),
Parameter(name = 'IndexS',
value = 1.7,
scale = -1.0,
min = -1.5,
max = 5.0,
free = True),
Parameter(name = 'Scale',
value = 1.0,
scale = 1000.0,
min = 0.001,
max = 1000.0,
free = False),
Parameter(name = 'Expfactor2',
value = 0.001,
scale = 1.0,
min = -1.0,
max = 1,
free = True),
Parameter(name = 'Index2',
value = 1.0,
scale = 1.0,
min = 0.0,
max = 2.0,
free = False)
],
'PLSuperExpCutoff4':
[
Parameter(name = 'Prefactor',
value = 1.0,
scale = 1.0e-11,
min = 1.0e-5,
max = 1000.0,
free = True),
Parameter(name = 'IndexS',
value = -1.7,
scale = 1.0,
min = -5,
max = 1.5,
free = True),
Parameter(name = 'Scale',
value = 1.0,
scale = 1000.0,
min = 0.001,
max = 1000.0,
free = False),
Parameter(name = 'ExpfactorS',
value = 0.4,
scale = 1.0,
min = 0,
max = 5,
free = True),
Parameter(name = 'Index2',
value = 0.5,
scale = 1.0,
min = 0.0001,
max = 2.0,
free = False)
],
'RadialDisk':
[
Parameter(name = 'Radius',
value = 0.2,
scale = 1.0,
min = 0.0,
max = 10.0,
free = False),
Parameter(name = 'RA',
value = 166.1138,
scale = 1.0,
min = -360.,
max = 360.0,
free = True),
Parameter(name = 'Dec',
value = 38.2088,
scale = 1.0,
min = -90.0,
max = 90.0,
free = False)
],
'RadialGaussian':
[
Parameter(name = 'Sigma',
value = 0.2,
scale = 1.0,
min = 0.0,
max = 10.0,
free = False),
Parameter(name = 'RA',
value = 166.1138,
scale = 1.0,
min = -360.,
max = 360.0,
free = True),
Parameter(name = 'Dec',
value = 38.2088,
scale = 1.0,
min = -90.0,
max = 90.0,
free = False)
],
'SmoothBrokenPowerLaw':
[
Parameter(name = 'Prefactor',
value = 1.0,
scale = 1.0e-9,
min = 0.0,
max = 1.0e10,
free = True),
Parameter(name = 'Index1',
value = -2.0,
scale = 1.0,
min = -5.0,
max = -1.0,
free = True),
Parameter(name = 'Scale',
value = 100.0,
scale = 1.0,
min = 30.0,
max = 2000.0,
free = False),
Parameter(name = 'Index2',
value = -2.0,
scale = 1.0,
min = -5.0,
max = -1.0,
free = True),
Parameter(name = 'BreakValue',
value = 1000.0,
scale = 1.0,
min = 20.0,
max = 5.0e5,
free = True),
Parameter(name = 'Beta',
value = 0.2,
scale = 1.0,
min = 0.01,
max = 10.0,
free = True)
],
}
# Valid Spectrum type strings.
_validTypes = _defaultParameters.keys()
# Define the default attributes.
_defaultType = 'PowerLaw'
_defaultFile = None
_defaultConstructorParameters = None
#--------------------------------------------------------------------------
def __init__(self,
type = _defaultType,
file = _defaultFile,
parameters = _defaultConstructorParameters,
dom = None,
*args, **kwargs):
"""Initialize this Spectrum.
Parameters:
self: This object.
type: (string) Type string for this Spectrum.
file: (string) Path to file containing Spectrum data.
parameters: (list of Parameter) One or more Parameters which
define the Spectrum.
dom (xml.dom.minidom.Element): DOM element to convert to this
Spectrum. If this parameter is specified, the other parameters
are ignored.
Return value:
None.
Description:
Initialize this Spectrum. All data attributes are set from the
corresponding parameters. If a DOM element is provided, use
the attribute and element nodes of that DOM element to set the
data attributes of this Spectrum.
"""
# 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, Spectrum._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.setType(type)
self.setFile(file)
if parameters is None:
parameters = Spectrum._defaultParameters[type]
self.setParameters(parameters)
#--------------------------------------------------------------------------
def toDom(self, domDocument):
"""Convert this Spectrum to a xml.dom.minidom.Element.
Parameters:
self: This object.
domDocument (xml.dom.minidom.Document): DOM document to use
when converting this Spectrum.
Return value:
xml.dom.minidom.Element for this Spectrum.
Description:
Convert this Spectrum 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
Spectrum.
"""
# Call the inherited method.
dom = Element.toDom(self, domDocument)
# type
dom.setAttribute('type', self.getType())
# file (skip if None)
file = self.getFile()
if file is not None:
dom.setAttribute('file', file)
# parameters
for parameter in self.getParameters():
domParameter = parameter.toDom(domDocument)
dom.appendChild(domParameter)
# Return the new DOM element.
return dom
def fromDom(self, dom):
"""Initialize this Spectrum from a xml.dom.minidom.Element.
Parameters:
self: This object.
dom (xml.dom.minidom.Element): DOM element to use when
initializing this Spectrum.
Return value:
None.
Description:
Use the specified DOM element as the source of the content of
this Spectrum. Set all data attributes using the corresponding
attribute and element nodes of the DOM element.
"""
# Call the inherited method.
Element.fromDom(self, dom)
# type
self.setType(dom.getAttribute('type'))
# file (map empty string to None)
file = dom.getAttribute('file')
if file == '':
file = None
self.setFile(file)
# parameters
self.setParameters([Parameter(dom = domParameter)
for domParameter
in dom.getElementsByTagName('parameter')])
#--------------------------------------------------------------------------
def getType(self):
"""Return the type for this Spectrum.
Parameters:
self: This object.
Return value:
String containing the type for this Spectrum.
Description:
Return the type for this Spectrum as a string.
"""
return self._type
def setType(self, type):
"""Set the type for this Spectrum.
Parameters:
self: This object.
type (string): New type for this Spectrum.
Return value:
None.
Description:
Set the type of this Spectrum to the specified string. If an
invalid type is specified, raise a TypeError exception.
"""
if not self.validType(type):
raise TypeError('Invalid Spectrum type (%s)!' % type)
self._type = type
def validType(self, type):
"""Check a type for validity.
Parameters:
self: This object.
type (string): Proposed type for this Spectrum.
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 Spectrum types.
Parameters:
self: This object.
Return value:
List of strings containing the valid Spectrum types.
Description:
Return the valid types for a Spectrum as a list of strings.
"""
return Spectrum._validTypes
#--------------------------------------------------------------------------
def getFile(self):
"""Return the file for this Spectrum.
Parameters:
self: This object.
Return value:
String containing the file for this Spectrum.
Description:
Return the file for this Spectrum as a string.
"""
return self._file
def setFile(self, file):
"""Set the file for this Spectrum.
Parameters:
self: This object.
file (string): New file for this Spectrum.
Return value:
None.
Description:
Set the file of this Spectrum to the specified string. If an
invalid file is specified, raise a TypeError exception.
"""
if not self.validFile(file):
raise TypeError('Invalid Spectrum file (%s)!' % file)
self._file = file
def validFile(self, file):
"""Check a file for validity.
Parameters:
self: This object.
file (string): Proposed file for this Spectrum.
Return value:
True if the file is valid, otherwise False.
Description:
Check if the proposed new file is valid. A file is valid if it
is None, or a non-empty string (make this more specific
later).
"""
if file is None:
return True
file = str(file)
if file == '':
return False
return True
#--------------------------------------------------------------------------
def validParameters(self, parameters):
"""Check a parameter list for validity.
Parameters:
self: This object.
parameters (list of Parameter): Proposed Parameters for this
Spectrum.
Return value:
True if the parameter list is valid, otherwise False.
Description:
Check if the proposed parameter list is valid. A parameter
list is valid if it contains a complete set of valid
parameters for the spectrum type.
"""
# Fetch the current Spectrum type.
type = self.getType()
# Get the list of names of required parameters for this
# Spectrum type.
requiredParameterNames = self.getRequiredParameterNames()
# Get the list of names of the new parameters.
parameterNames = [p.getName() for p in parameters]
# Check if the sets are identical.
if set(parameterNames) == set(requiredParameterNames):
return True
# The parameter list is invalid.
return False
def getRequiredParameterNames(self):
"""Return the list of names of required parameters for this Spectrum.
Parameters:
self: This object.
Return value:
List of strings of required parameter names.
Description:
Return the list of names of parameters required by this
Spectrum. The list of required parametr names is determined by
the Spectrum type.
"""
# Fetch the Spectrum type.
type = self.getType()
names = [p.getName() for p in Spectrum._defaultParameters[type]]
return names
#******************************************************************************
# Self-test code.
# If this code generates any output, an error has been found.
if __name__ == '__main__':
# Default constructor
spectrum = Spectrum()
assert 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)'
# Constructor with attribute values.
parameters = [Parameter('Prefactor'),
Parameter('Index'),
Parameter('Scale')]
spectrum = Spectrum(type = 'PowerLaw', parameters = parameters)
assert spectrum == 'Spectrum(_file=None,_parameters=[Parameter(_free=False,_max=None,_min=None,_name=Prefactor,_scale=1.0,_tagName=parameter,_value=0.0),Parameter(_free=False,_max=None,_min=None,_name=Index,_scale=1.0,_tagName=parameter,_value=0.0),Parameter(_free=False,_max=None,_min=None,_name=Scale,_scale=1.0,_tagName=parameter,_value=0.0)],_tagName=spectrum,_type=PowerLaw)'
# Check the parameter count method.
assert spectrum.getNumParameters() == 3
# Check the Parameter access methods.
parameter = spectrum.getParameterByIndex(0)
assert str(parameter) == str(parameters[0])
parameter = spectrum.getParameterByName('Scale')
assert str(parameter) == str(parameters[2])
# Convert to/from DOM object.
import xml.dom.minidom
domDocument = xml.dom.minidom.Document()
dom = spectrum.toDom(domDocument)
spectrumCopy = Spectrum(dom = dom)
assert spectrumCopy == spectrum