show_butterfly.py
4.8 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
#! /usr/bin/env python
# ==========================================================================
# Shows butterfly diagram created with ctbutterfly
#
# Copyright (C) 2014-2019 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 cscripts
try:
import matplotlib.pyplot as plt
plt.figure()
plt.close()
except (ImportError, RuntimeError):
print('This script needs the "matplotlib" module')
sys.exit()
# ======================================== #
# Get butterfly diagram values from a file #
# ======================================== #
def get_butterfly_file(filename):
"""
Get butterfly diagram values
Parameters
----------
filename : str
Butterfly CSV file
Returns
-------
btrfly : dict
Python dictionary defining butterfly plot and best fit spectrum
"""
# Read butterfly file
csv = gammalib.GCsv(filename)
# Return dictionary
return get_butterfly_csv(csv)
# =============================================== #
# Get butterfly diagram values from a GCsv object #
# =============================================== #
def get_butterfly_csv(csv):
"""
Get butterfly diagram values from GCsv object
Parameters
----------
csv : `~gammalib.GCsv`
GCsv object containing butterfly plot information
Returns
-------
btrfly : dict
Python dictionary defining butterfly plot and best fit spectrum
"""
# Initialise arrays to be filled
btrfly = {
'butterfly_x' : [],
'butterfly_y' : [],
'line_x' : [],
'line_y' : []
}
# Loop over rows of the file
nrows = csv.nrows()
for row in range(nrows):
# Get conversion coefficient
conv = csv.real(row,0) * csv.real(row,0) * gammalib.MeV2erg
# Compute upper edge of confidence band
btrfly['butterfly_x'].append(csv.real(row,0)/1.0e6) # TeV
btrfly['butterfly_y'].append(csv.real(row,2)*conv)
# Set line values
btrfly['line_x'].append(csv.real(row,0)/1.0e6) # TeV
btrfly['line_y'].append(csv.real(row,1)*conv)
# Loop over the rows backwards to compute the lower edge of the
# confidence band
for row in range(nrows):
index = nrows - 1 - row
conv = csv.real(index,0) * csv.real(index,0) * gammalib.MeV2erg
btrfly['butterfly_x'].append(csv.real(index,0)/1.0e6)
low_error = max(csv.real(index,3)*conv, 1e-26)
btrfly['butterfly_y'].append(low_error)
# Return dictionary
return btrfly
# ============== #
# Plot butterfly #
# ============== #
def plot_butterfly(filename, plotfile):
"""
Plot butterfly diagram
Parameters
----------
filename : str
Butterfly CSV file
plotfile : str
Plot filename
"""
# Read butterfly file
btrfly = get_butterfly_file(filename)
# Plot the butterfly and spectral line
plt.figure()
plt.loglog()
plt.grid()
plt.xlabel('Energy (TeV)')
plt.ylabel(r'E$^2$ $\times$ dN/dE (erg cm$^{-2}$ s$^{-1}$)')
# Plot the butterfly and spectral line
plt.plot(btrfly['line_x'],btrfly['line_y'],color='black',ls='-')
plt.fill(btrfly['butterfly_x'],btrfly['butterfly_y'],color='green',alpha=0.5)
# Show spectrum or save it into file
if len(plotfile) > 0:
plt.savefig(plotfile)
else:
plt.show()
# Return
return
# ====================== #
# Show butterfly diagram #
# ====================== #
def show_butterfly():
"""
Show butterfly diagram
"""
# Set usage string
usage = 'show_butterfly.py [-p plotfile] file'
# Set default options
options = [{'option': '-p', 'value': ''}]
# Get arguments and options from command line arguments
args, options = cscripts.ioutils.get_args_options(options, usage)
# Extract script parameters from options
plotfile = options[0]['value']
# Plot butterfly diagram
plot_butterfly(filename=args[0], plotfile=plotfile)
# Return
return
# ======================== #
# Main routine entry point #
# ======================== #
if __name__ == '__main__':
# Show butterfly diagram
show_butterfly()