-
Notifications
You must be signed in to change notification settings - Fork 1
/
plotfun.py
430 lines (370 loc) · 12 KB
/
plotfun.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
"""
Package: Qtools
Module: plotfun
(C) 2020-2022 Andreas H. Nielsen
See README.md for further details.
"""
import numpy as np
import matplotlib.pyplot as plt
from matplotlib.ticker import FuncFormatter
from qtools.config import set_module, Info
from qtools.power_spectrum import PowerSpectrum, FourierSpectrum
from math import log10
# Define a formatter for tick labels
def format_func(x, pos):
"""
Formats tick labels like Excel's general format.
"""
if x < 1:
pr = int(-log10(x))
return '{val:.{prec}f}'.format(val=x, prec=pr)
else:
return '{val:.0f}'.format(val=x)
@set_module('qtools')
def plotrs(*args, **kwargs):
"""Function for plotting instances of class ResponseSpectrum.
Parameters
----------
*args
Any number of response spectra
**kwargs
Optional named parameters (see below under **Other parameters**)
Other parameters
----------------
style : str
Plot style. See `Matplotlib style sheets reference <https://
matplotlib.org/stable/gallery/style_sheets/
style_sheets_reference.html>`_ for available styles. Default `default`.
xaxis : {'f', 'T'}
Quantity to plot on the x-axis. Default 'f'.
yaxis : {'sa', 'sv', 'sd'}
Quantity to plot on the y-axis. Default 'sa'.
xscale : {'log', 'lin'}
Specifies the scale on the x-axis (logarithmic or linear).
Default 'log'.
legend : dict (or bool)
The keys in this dictionary will be used to set the arguments in a
call to :func:`matplotlib.pyplot.legend`. If this parameter is not
provided, the legend will not be shown. This parameter can also be set
to True to show the legend with default parameters ``{'loc': 'best'}``.
filename : str
If given, save plot to file using `filename` as file name. The file
name should include the desired extension (e.g. 'png' or 'svg'), from
which the file format will be determined as per
:func:`matplotlib.pyplot.savefig`.
transparent : bool
This parameter will be passed directly to
:func:`matplotlib.pyplot.savefig` (if a `filename` is given). Default
``False``.
dpi : int
Dots per inch to use if saving plot to file. Default None.
right : float
Sets the upper limit on the x-axis.
left : float
Sets the lower limit on the x-axis.
top : float
Sets the upper limit on the y-axis.
bottom : float
Sets the lower limit on the y-axis.
grid : dict
The keys in this dictionary will be used to set the arguments in a
call to :func:`matplotlib.pyplot.grid`. Default: ``{'which': 'major',
'color': '0.75'}``
fig_size : (float, float)
Set the figure size. The first value in the tuple is the figure width
(in cm) and the second is the figure height (also in cm). If None is
passed, the default Matplotlib values will be used. Default: None.
Notes
-----
The line format can be set in the 'fmt' attribute of a response spectrum.
The line format is passed directly to :func:`matplotlib.pyplot.plot` as
'fmt'. Additionally, the color can be set in
:meth:`qtools.ResponseSpectrum.setLineFormat`.
Examples
--------
A typical call with 3 response spectra and default options is::
qt.plotrs(rs1,rs2,rs3)
If the spectra are contained in a list (say, `rslist`), unpack the list
inside the call using the star operator::
qt.plotrs(*rslist)
"""
# Get the parameters
style = kwargs.get('style', 'default')
xaxis = kwargs.get('xaxis', 'f')
yaxis = kwargs.get('yaxis', 'sa')
xscale = kwargs.get('xscale', 'log')
yscale = kwargs.get('yscale', 'lin')
if 'legend' in kwargs:
show_legend = True
legend = {'loc': 'best'}
if isinstance(kwargs['legend'], dict):
legend = kwargs['legend']
else:
show_legend = False
filename = kwargs.get('filename', '')
transparent = kwargs.get('transparent', False)
dpi = kwargs.get('dpi', None)
grid = kwargs.get('grid', {'which': 'major', 'color': '0.75'})
fig_size = kwargs.get('fig_size', None)
plt.style.use(style)
# Get the axes of a new plot
fig, ax = plt.subplots()
# Set the appropriate type of plot
if xscale == 'log' and yscale == 'log':
plot = ax.loglog
elif xscale == 'log' and yscale == 'lin':
plot = ax.semilogx
elif xscale == 'lin' and yscale == 'log':
plot = ax.semilogy
elif xscale == 'lin' and yscale == 'lin':
plot = ax.plot
# Set the labels on the axes
if xaxis == 'f':
ax.set_xlabel('Frequency [Hz]')
elif xaxis == 'T':
ax.set_xlabel('Period [s]')
else:
raise ValueError('{} is not a valid value for the x-axis on a'
' response spectrum plot'.format(xaxis))
if yaxis == 'sa':
ax.set_ylabel('Spectral acceleration [g]')
ucf = 1.0
elif yaxis == 'sv':
ax.set_ylabel('Spectral velocity [cm/s]')
ucf = 100
elif yaxis == 'sd':
ax.set_ylabel('Spectral displacement [mm]')
ucf = 1000
elif yaxis == 'ei':
ax.set_ylabel('Spectral input energy [J/kg]')
else:
raise ValueError('{} is not a valid value for the y-axis on a'
' response spectrum plot'.format(yaxis))
xmax = -1e6
xmin = 1e6
for rs in args:
x = rs.__dict__[xaxis]
y = rs.__dict__[yaxis]
xmax = max(np.amax(x),xmax)
xmin = min(np.amin(x),xmin)
if rs.color == '':
plot(x, ucf*y, rs.fmt, label=rs.label)
else:
plot(x, ucf*y, rs.fmt, label=rs.label, color=rs.color)
# Set upper limit on x-axis if specified
if 'right' in kwargs:
xmax = kwargs['right']
ax.set_xlim(right=xmax)
# Set lower limit on x-axis if specified
if 'left' in kwargs:
xmin = kwargs['left']
ax.set_xlim(left=xmin)
# Set upper limit on y-axis if specified
if 'top' in kwargs:
ax.set_ylim(top=kwargs['top'])
# Set lower limit on y-axis if specified
if 'bottom' in kwargs:
ax.set_ylim(bottom=kwargs['bottom'])
if show_legend:
ax.legend(**legend)
ax.grid(**grid)
if fig_size is not None:
w = fig_size[0]/2.54
h = fig_size[1]/2.54
fig.set_size_inches((w,h))
if xscale == 'log':
ax.xaxis.set_major_formatter(FuncFormatter(format_func))
if log10(xmax/xmin) < 1:
ax.xaxis.set_minor_formatter(FuncFormatter(format_func))
# Note: in Matplotlib version 3.3.4, the following call should be valid
#ax.xaxis.set_major_formatter(format_func)
if yscale == 'log':
ax.yaxis.set_major_formatter(FuncFormatter(format_func))
# Note: in Matplotlib version 3.3.4, the following call should be valid
#ax.yaxis.set_major_formatter(format_func)
if len(filename) > 0:
plt.savefig(filename, dpi=dpi, bbox_inches='tight',
transparent=transparent)
plt.show()
@set_module('qtools')
def plotps(*args, **kwargs):
"""Function for plotting instances of class PowerSpectrum and
FourierSpectrum.
Parameters
----------
*args
Any number of power spectra or Fourier spectra. All spectra must be
of the same type.
**kwargs
Optional named parameters (see below under **Other parameters**)
Other parameters
----------------
style : str
Plot style. See `Matplotlib style sheets reference <https://
matplotlib.org/stable/gallery/style_sheets/
style_sheets_reference.html>`_ for available styles. Default `default`.
xscale : {'log', 'lin'}
Specifies the scale on the x-axis (logarithmic or linear).
Default 'lin'.
legend : dict (or bool)
The keys in this dictionary will be used to set the arguments in a
call to :func:`matplotlib.pyplot.legend`. If this parameter is not
provided, the legend will not be shown. This parameter can also be set
to True to show the legend with default parameters ``{'loc': 'best'}``
filename : str
If given, save plot to file using `filename` as file name. The file
name should include the desired extension (e.g. 'png' or 'svg'), from
which the file format will be determined as per
:func:`matplotlib.pyplot.savefig`.
dpi : int
Dots per inch to use if plot is saved to file. Default None.
right : float
Sets the upper limit on the x-axis.
left : float
Sets the lower limit on the x-axis.
top : float
Sets the upper limit on the y-axis.
bottom : float
Sets the lower limit on the y-axis.
grid : dict
The keys in this dictionary will be used to set the arguments in a
call to :func:`matplotlib.pyplot.grid`. Default: ``{'which': 'major',
'color': '0.75'}``
Notes
-----
The line format can be set in the 'fmt' attribute of a spectrum.
The line format is passed directly to :func:`matplotlib.pyplot.plot` as
'fmt'.
Examples
--------
See :func:`qtools.plotrs`.
"""
style = kwargs.get('style', 'default')
xscale = kwargs.get('xscale', 'lin')
if 'legend' in kwargs:
show_legend = True
legend = {'loc': 'best'}
if isinstance(kwargs['legend'], dict):
legend = kwargs['legend']
else:
show_legend = False
filename = kwargs.get('filename', '')
dpi = kwargs.get('dpi', None)
grid = kwargs.get('grid', {'which': 'major', 'color': '0.75'})
plt.style.use(style)
# Get the axes of a new plot
fig, ax = plt.subplots()
# Set the appropriate type of plot
if xscale == 'log':
plot = ax.semilogx
elif xscale == 'lin':
plot = ax.plot
ax.set_xlabel('Frequency [Hz]')
# Check the validity of the arguments and set the labels on the y-axis
if all([isinstance(ps, FourierSpectrum) for ps in args]):
ax.set_ylabel('Fourier amplitude [{}]'.format(args[0].unit))
yaxis = 'X'
elif all([isinstance(ps, PowerSpectrum) for ps in args]):
ax.set_ylabel('Spectral power density [{}]'.format(args[0].unit))
yaxis = 'Wf'
else:
raise ValueError('The arguments provided to plotps are not all of the'
' same type (either FourierSpectrum or PowerSpectrum)')
if len(set([ps.unit for ps in args])) > 1:
Info.warn('In plotps, it seems that some spectra have different '
'units.')
# Create the plots
for ps in args:
if yaxis=='X':
y = ps.abs()
else:
y = ps.Wf
if ps.fmt == '_default_':
plot(ps.f, y, label=ps.label)
else:
plot(ps.f, y, ps.fmt, label=ps.label)
# Set upper limit on x-axis if specified
if 'right' in kwargs:
ax.set_xlim(right=kwargs['right'])
# Set lower limit on x-axis if specified
if 'left' in kwargs:
ax.set_xlim(left=kwargs['left'])
# Set upper limit on y-axis if specified
if 'top' in kwargs:
ax.set_ylim(top=kwargs['top'])
# Set lower limit on y-axis if specified
if 'bottom' in kwargs:
ax.set_ylim(bottom=kwargs['bottom'])
if show_legend:
ax.legend(**legend)
ax.grid(**grid)
if len(filename) > 0:
plt.savefig(filename, dpi=dpi, bbox_inches='tight')
plt.show()
@set_module('qtools')
def plotth(*args, **kwargs):
"""Function for plotting instances of class TimeHistory.
Parameters
----------
*args
Any number of time histories
**kwargs
Optional named parameters (see below under **Other parameters**)
Other parameters
----------------
legend : bool
Display the legend on the plot. Default False.
filename : str
If given, save plot to file using `filename` as file name. The file
name should include the desired extension (e.g. 'png' or 'svg'), from
which the file format will be determined as per
:func:`matplotlib.pyplot.savefig`.
dpi : int
Dots per inch to use if plot is saved to file. Default None.
right : float
Sets the upper limit on the x-axis.
left : float
Sets the lower limit on the x-axis.
top : float
Sets the upper limit on the y-axis.
bottom : float
Sets the lower limit on the y-axis.
Notes
-----
The line format can be set in the 'fmt' attribute of a response spectrum.
The line format is passed directly to :func:`matplotlib.pyplot.plot` as
'fmt'.
"""
xscale = kwargs.get('xscale','lin')
show_legend = kwargs.get('legend',False)
filename = kwargs.get('filename','')
dpi = kwargs.get('dpi',None)
plt.xlabel('Time [s]')
if args[0].ordinate == 'a':
plt.ylabel('Acceleration')
elif args[0].ordinate == 'v':
plt.ylabel('Velocity')
elif args[0].ordinate == 'd':
plt.ylabel('Displacement')
for th in args:
if xscale == 'log':
plt.semilogx(th.time, th.data, th.fmt, label=th.label)
elif xscale == 'lin':
plt.plot(th.time, th.data, th.fmt, label=th.label)
# Set upper limit on x-axis if specified
if 'right' in kwargs:
plt.xlim(right=kwargs['right'])
# Set lower limit on x-axis if specified
if 'left' in kwargs:
plt.xlim(left=kwargs['left'])
# Set upper limit on y-axis if specified
if 'top' in kwargs:
plt.ylim(top=kwargs['top'])
# Set lower limit on y-axis if specified
if 'bottom' in kwargs:
plt.ylim(bottom=kwargs['bottom'])
if show_legend:
plt.legend(loc='best')
if len(filename) > 0:
plt.savefig(filename, dpi=dpi)
plt.show()