csmodelinfo.py
10.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
#!/usr/bin/env python
# ==========================================================================
# Shows the content of a model container
#
# Copyright (C) 2015-2016 Michael Mayer
#
# 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/>.
#
# ==========================================================================
import sys
import gammalib
import ctools
from cscripts import modutils
# ================= #
# csmodelinfo class #
# ================= #
class csmodelinfo(ctools.cscript):
"""
Shows the content of a model container
The script is useful to show, e.g., the number of sources in a model
container, the background models, free and fixed parameters etc.
The script can also dump the models into a region file to for display
with DS9.
"""
# Constructor
def __init__(self, *argv):
"""
Constructor
"""
# Set name
self._name = 'csmodelinfo'
self._version = '1.2.0'
# Initialise class members
self._models = gammalib.GModels()
# Initialise application by calling the appropriate class constructor
self._init_cscript(argv)
# Return
return
# Private methods
def _get_parameters(self):
"""
Get parameters from parfile and setup the observation
"""
# Get models
self._models = gammalib.GModels(self['inmodel'].filename())
# Query hidden parameters for region file
self['pnt_type'].string()
self['pnt_mark_size'].integer()
self['show_labels'].boolean()
self['width'].integer()
self['fontfamily'].string()
self['fontsize'].integer()
self['fontweight'].string()
self['fontslant'].string()
self['show_ext_type'].boolean()
self['free_color'].string()
self['fixed_color'].string()
# Query ahead DS9 filename
if self._read_ahead():
self["ds9file"].filename()
# Write input parameters into logger
self._log_parameters(gammalib.TERSE)
# Return
return
# Public methods
def run(self):
"""
Run the script
"""
# Switch screen logging on in debug mode
if self._logDebug():
self._log.cout(True)
# Get parameters
self._get_parameters()
# Optionally log models
if self._logVerbose():
self._log('\n')
self._log.header1('Models')
self._log('\n')
self._log(str(self._models))
self._log('\n')
# Initialise output values
types = {}
instruments = {}
ts = {}
pars_at_limit = {}
free_src_pars = {}
n_par_total = 0
n_par_free = 0
n_par_fixed = 0
n_par_at_limit = 0
n_par_free_bkg = 0
n_par_free_src = 0
n_par_free_spec = 0
n_par_free_spat = 0
n_par_free_temp = 0
# Loop over models and initialise dictionaries with model names
for model in self._models:
types[model.type()] = 0
instruments[model.instruments()] = 0
pars_at_limit[model.name()] = []
# Loop over models again and fill values to be dumped
for model in self._models:
# Model types
types[model.type()] += 1
# Model instruments
instruments[model.instruments()] += 1
# TS
if model.has_ts():
ts[model.name()] = model.ts()
# Skymodel?
skymodel = (model.classname() == 'GModelSky')
if skymodel:
free_src_pars[model.name()] = []
# Loop over model parameters
for par in model:
# Increment total parameters
n_par_total += 1
# Check if parameter is at limit
if par.has_range():
if par.value() == par.min() or par.value() == par.max():
pars_at_limit[model.name()].append(par.name())
n_par_at_limit += 1
# Check if model parameter is free/fixed and
# increment respective variable
if par.is_free():
n_par_free += 1
if skymodel:
free_src_pars[model.name()].append(par)
n_par_free_src += 1
else:
n_par_free_bkg += 1
else:
n_par_fixed += 1
# If sky model, divide free parameters into spatial, spectral
# and temporal
if skymodel:
for par in model.spectral():
if par.is_free():
n_par_free_spec += 1
for par in model.spatial():
if par.is_free():
n_par_free_spat += 1
for par in model.temporal():
if par.is_free():
n_par_free_temp += 1
# Optionally log model information
if self._logTerse():
# Log summary
self._log_header1(gammalib.TERSE, 'Summary')
# Log instruments
self._log.header3('Instrument specific models')
for inst, n_inst in instruments.items():
if inst == '':
inst = 'All'
self._log_value(gammalib.TERSE, inst, n_inst)
# Log model types
self._log_header3(gammalib.TERSE, 'Model types')
for modeltype, n_types in types.items():
self._log_value(gammalib.TERSE, modeltype, n_types)
# Log model parameter information
self._log_header1(gammalib.TERSE,'Parameter information')
self._log_value(gammalib.TERSE,'All parameters', n_par_total)
self._log_value(gammalib.TERSE,'Fixed parameters', n_par_fixed)
self._log_value(gammalib.TERSE,'Free parameters (total)', n_par_free)
self._log_value(gammalib.TERSE,'Free background parameters', n_par_free_bkg)
self._log_value(gammalib.TERSE,'Free source parameters', n_par_free_src)
if n_par_free_spec > 0:
self._log_value(gammalib.TERSE,'Free spectral parameters', n_par_free_spec)
if n_par_free_spat > 0:
self._log_value(gammalib.TERSE,'Free spatial parameters', n_par_free_spat)
if n_par_free_temp > 0:
self._log_value(gammalib.TERSE,'Free temporal parameters', n_par_free_temp)
self._log_value(gammalib.TERSE,'Parameters at limit', n_par_at_limit)
# Log parameters at limit (if any)
if n_par_at_limit > 0:
self._log_header3(gammalib.TERSE, 'Parameters at limit')
for source, parameter in pars_at_limit.items():
if len(parameter):
for par in parameter:
self._log_value(gammalib.TERSE, source, par)
# Optionally log free parameters
if len(free_src_pars):
self._log_header2(gammalib.EXPLICIT, 'Free source parameters')
for source, parameter in free_src_pars.items():
if len(parameter):
self._log.header3(source)
for par in parameter:
self._log_string(gammalib.EXPLICIT, str(par)+'\n')
# Log TS values if available
if len(ts):
self._log_header3(gammalib.TERSE, 'Test statistics')
for source, tsvalue in ts.items():
self._log_value(gammalib.TERSE, source, tsvalue)
# Return
return
def save(self):
"""
Save models to ds9 region file
"""
# Get output filename
ds9file = self['ds9file'].filename()
# Check if DS9 file is valid
if ds9file != '' and ds9file != 'NONE':
# Write header
self._log_header1(gammalib.TERSE, 'Save models in DS9 file')
# Log filename
self._log_value(gammalib.NORMAL, 'DS9 filename', ds9file.url())
# Get ds9 parameters
pnt_type = self['pnt_type'].string()
pnt_mark_size = self['pnt_mark_size'].integer()
free_color = self['free_color'].string()
fixed_color = self['fixed_color'].string()
width = self['width'].integer()
fontfamily = self['fontfamily'].string()
fontsize = self['fontsize'].integer()
fontweight = self['fontweight'].string()
fontslant = self['fontslant'].string()
# Save DS9 region file
errors = modutils.models2ds9file(self._models, ds9file.url(),
pnt_type=pnt_type,
pnt_mark_size=pnt_mark_size,
free_color=free_color,
fixed_color=fixed_color,
width=width,
fontfamily=fontfamily,
fontsize=fontsize,
fontweight=fontweight,
fontslant=fontslant)
# Log errors
if len(errors):
self._log(errors)
# Return
return
def execute(self):
"""
Execute the script
"""
# Open logfile
self.logFileOpen()
# Read ahead output parameters
self._read_ahead(True)
# Run the script
self.run()
# Save ds9 file if required
self.save()
# Return
return
# ======================== #
# Main routine entry point #
# ======================== #
if __name__ == '__main__':
# Create instance of application
app = csmodelinfo(sys.argv)
# Execute application
app.execute()