plot_utils.py
Go to the documentation of this file.
1 # -*- coding: utf-8 -*-
2 """
3 Created on Fri Jan 16 09:16:56 2015
4 
5 @author: adelpret
6 """
7 
8 import matplotlib as mpl
9 import matplotlib.pyplot as plt
10 import matplotlib.ticker as ticker
11 import numpy as np
12 
13 DEFAULT_FONT_SIZE = 20
14 DEFAULT_AXIS_FONT_SIZE = DEFAULT_FONT_SIZE
15 DEFAULT_LINE_WIDTH = 4 # 13
16 DEFAULT_MARKER_SIZE = 6
17 DEFAULT_FONT_FAMILY = "sans-serif"
18 DEFAULT_FONT_SIZE = DEFAULT_FONT_SIZE
19 DEFAULT_FONT_SERIF = [
20  "Times New Roman",
21  "Times",
22  "Bitstream Vera Serif",
23  "DejaVu Serif",
24  "New Century Schoolbook",
25  "Century Schoolbook L",
26  "Utopia",
27  "ITC Bookman",
28  "Bookman",
29  "Nimbus Roman No9 L",
30  "Palatino",
31  "Charter",
32  "serif",
33 ]
34 DEFAULT_FIGURE_FACE_COLOR = "white" # figure facecolor 0.75 is scalar gray
35 DEFAULT_LEGEND_FONT_SIZE = DEFAULT_FONT_SIZE
36 DEFAULT_AXES_LABEL_SIZE = DEFAULT_FONT_SIZE # fontsize of the x any y labels
37 DEFAULT_TEXT_USE_TEX = False
38 LINE_ALPHA = 0.9
39 SAVE_FIGURES = False
40 FILE_EXTENSIONS = ["png"] # 'pdf'] #['png'] #,'eps']
41 FIGURES_DPI = 150
42 SHOW_LEGENDS = False
43 LEGEND_ALPHA = 0.5
44 SHOW_FIGURES = False
45 FIGURE_PATH = "./"
46 LINE_WIDTH_RED = 0 # reduction of line width when plotting multiple lines on same plot
47 LINE_WIDTH_MIN = 1
48 BOUNDS_COLOR = "silver"
49 
50 # legend.framealpha : 1.0 # opacity of of legend frame
51 # axes.hold : True # whether to clear the axes by default on
52 # axes.linewidth : 1.0 # edge linewidth
53 # axes.titlesize : large # fontsize of the axes title
54 # axes.color_cycle : b, g, r, c, m, y, k # color cycle for plot lines
55 # xtick.labelsize : medium # fontsize of the tick labels
56 # figure.dpi : 80 # figure dots per inch
57 # image.cmap : jet # gray | jet etc...
58 # savefig.dpi : 100 # figure dots per inch
59 # savefig.facecolor : white # figure facecolor when saving
60 # savefig.edgecolor : white # figure edgecolor when saving
61 # savefig.format : png # png, ps, pdf, svg
62 # savefig.jpeg_quality: 95 # when a jpeg is saved, the default quality parameter.
63 # savefig.directory : ~ # default directory in savefig dialog box,
64 # # leave empty to always use current working directory
65 
66 
67 def create_empty_figure(nRows=1, nCols=1, figsize=(7, 7), spinesPos=None, sharex=True):
68  f, ax = plt.subplots(nRows, nCols, figsize=figsize, sharex=sharex)
69  mngr = plt.get_current_fig_manager()
70  # mngr.window.setGeometry(50,50,1080,720)
71 
72  if spinesPos is not None:
73  if nRows * nCols > 1:
74  for axis in ax.reshape(nRows * nCols):
75  movePlotSpines(axis, spinesPos)
76  else:
77  movePlotSpines(ax, spinesPos)
78  return f, ax
79 
80 
81 def movePlotSpines(ax, spinesPos):
82  ax.spines["right"].set_color("none")
83  ax.spines["top"].set_color("none")
84  ax.xaxis.set_ticks_position("bottom")
85  ax.spines["bottom"].set_position(("data", spinesPos[0]))
86  ax.yaxis.set_ticks_position("left")
87  ax.spines["left"].set_position(("data", spinesPos[1]))
88 
89 
90 def setAxisFontSize(ax, size):
91  for label in ax.get_xticklabels() + ax.get_yticklabels():
92  label.set_fontsize(size)
93  label.set_bbox(dict(facecolor="white", edgecolor="None", alpha=0.65))
94 
95 
96 mpl.rcdefaults()
97 mpl.rcParams["lines.linewidth"] = DEFAULT_LINE_WIDTH
98 mpl.rcParams["lines.markersize"] = DEFAULT_MARKER_SIZE
99 mpl.rcParams["patch.linewidth"] = 1
100 mpl.rcParams["axes.grid"] = True
101 mpl.rcParams["font.family"] = DEFAULT_FONT_FAMILY
102 mpl.rcParams["font.size"] = DEFAULT_FONT_SIZE
103 mpl.rcParams["font.serif"] = DEFAULT_FONT_SERIF
104 mpl.rcParams["text.usetex"] = DEFAULT_TEXT_USE_TEX
105 mpl.rcParams["axes.labelsize"] = DEFAULT_AXES_LABEL_SIZE
106 mpl.rcParams["legend.fontsize"] = DEFAULT_LEGEND_FONT_SIZE
107 mpl.rcParams["figure.facecolor"] = DEFAULT_FIGURE_FACE_COLOR
108 mpl.rcParams["figure.figsize"] = 23, 12 # 12, 9 #
109 
110 
111 def plot3dQuantity(
112  quantity,
113  title,
114  ax=None,
115  boundUp=None,
116  boundLow=None,
117  yscale="linear",
118  linestyle="k",
119 ):
120  return plotNdQuantity(
121  3, 1, quantity, title, ax, boundUp, boundLow, yscale, linestyle
122  )
123 
124 
125 def plotNdQuantity(
126  nRows,
127  nCols,
128  quantity,
129  title="",
130  ax=None,
131  boundUp=None,
132  boundLow=None,
133  yscale="linear",
134  linestyle="k--",
135  sharey=False,
136  margins=None,
137 ):
138  t = quantity.shape[0]
139  n = quantity.shape[1]
140  if margins is not None:
141  if isinstance(margins, list):
142  margins = [margins[0].reshape(t, 1, n), margins[1].reshape(t, 1, n)]
143  else:
144  margins = margins.reshape(t, 1, n)
145  return plotNdQuantityPerSolver(
146  nRows,
147  nCols,
148  quantity.reshape(t, 1, n),
149  title,
150  None,
151  [linestyle],
152  ax,
153  boundUp,
154  boundLow,
155  yscale,
156  None,
157  None,
158  sharey,
159  margins,
160  )
161 
162 
163 def plotNdQuantityPerSolver(
164  nRows,
165  nCols,
166  quantity,
167  title,
168  solver_names,
169  line_styles,
170  ax=None,
171  boundUp=None,
172  boundLow=None,
173  yscale="linear",
174  subplot_titles=None,
175  ylabels=None,
176  sharey=False,
177  margins=None,
178  x=None,
179 ):
180  if ax is None:
181  f, ax = plt.subplots(nRows, nCols, sharex=True, sharey=sharey)
182  ax = ax.reshape(nRows, nCols)
183  k = 0
184  if x is None:
185  x = list(range(quantity.shape[0]))
186  for j in range(nCols):
187  for i in range(nRows):
188  if k < quantity.shape[2]:
189  if subplot_titles is not None:
190  ax[i, j].set_title(subplot_titles[k])
191  elif i == 0:
192  ax[i, j].set_title(str(k)) # set titles on first row only
193  if ylabels is not None:
194  ax[i, j].set_ylabel(ylabels[k])
195 
196  ymin = np.min(quantity[:, :, k])
197  ymax = np.max(quantity[:, :, k])
198  if boundUp is not None:
199  if len(boundUp.shape) == 1: # constant bound
200  if boundUp[k] < 2 * ymax:
201  ymax = np.max([ymax, boundUp[k]])
202  ax[i, j].plot(
203  [0, quantity.shape[0] - 1],
204  [boundUp[k], boundUp[k]],
205  "--",
206  color=BOUNDS_COLOR,
207  alpha=LINE_ALPHA,
208  )
209  elif (
210  len(boundUp.shape) == 2
211  ): # bound variable in time but constant for each solver
212  if np.max(boundUp[:, k]) < 2 * ymax:
213  ymax = np.max(np.concatenate(([ymax], boundUp[:, k])))
214  ax[i, j].plot(
215  boundUp[:, k],
216  "--",
217  color=BOUNDS_COLOR,
218  label="Upper bound",
219  alpha=LINE_ALPHA,
220  )
221  if boundLow is not None:
222  if len(boundLow.shape) == 1:
223  if boundLow[k] > 2 * ymin:
224  ymin = np.min([ymin, boundLow[k]])
225  ax[i, j].plot(
226  [0, quantity.shape[0] - 1],
227  [boundLow[k], boundLow[k]],
228  "--",
229  color=BOUNDS_COLOR,
230  alpha=LINE_ALPHA,
231  )
232  else:
233  if np.min(boundLow[:, k]) > 2 * ymin:
234  ymin = np.min(np.concatenate(([ymin], boundLow[:, k])))
235  ax[i, j].plot(
236  boundLow[:, k],
237  "--",
238  color=BOUNDS_COLOR,
239  label="Lower bound",
240  alpha=LINE_ALPHA,
241  )
242  lw = DEFAULT_LINE_WIDTH
243  for s in range(quantity.shape[1]):
244  (p,) = ax[i, j].plot(
245  x,
246  quantity[:, s, k],
247  line_styles[s],
248  alpha=LINE_ALPHA,
249  linewidth=lw,
250  )
251  if margins is not None:
252  if isinstance(margins, list):
253  mp = margins[0]
254  mn = margins[1]
255  else:
256  mp = margins
257  mn = margins
258  ymax = np.max(
259  np.concatenate(([ymax], quantity[:, s, k] + mp[:, s, k]))
260  )
261  ymin = np.min(
262  np.concatenate(([ymin], quantity[:, s, k] - mn[:, s, k]))
263  )
264  ax[i, j].fill_between(
265  x,
266  quantity[:, s, k] + mp[:, s, k],
267  quantity[:, s, k] - mn[:, s, k],
268  alpha=0.15,
269  linewidth=0,
270  facecolor="green",
271  )
272  if solver_names is not None:
273  p.set_label(solver_names[s])
274  lw = max(LINE_WIDTH_MIN, lw - LINE_WIDTH_RED)
275  ax[i, j].set_yscale(yscale)
276  ax[i, j].xaxis.set_ticks(np.arange(0, x[-1], x[-1] / 2))
277  ax[i, j].yaxis.set_ticks([ymin, ymax])
278  if ymax - ymin > 5.0:
279  ax[i, j].yaxis.set_major_formatter(
280  ticker.FormatStrFormatter("%0.0f")
281  )
282  elif ymax - ymin > 0.5:
283  ax[i, j].yaxis.set_major_formatter(
284  ticker.FormatStrFormatter("%0.1f")
285  )
286  else:
287  ax[i, j].yaxis.set_major_formatter(
288  ticker.FormatStrFormatter("%0.2f")
289  )
290  if not sharey:
291  ax[i, j].set_ylim(
292  [ymin - 0.1 * (ymax - ymin), ymax + 0.1 * (ymax - ymin)]
293  )
294  k += 1
295  else:
296  ax[i, j].yaxis.set_major_formatter(ticker.FormatStrFormatter("%0.0f"))
297 
298  if SAVE_FIGURES:
299  for ext in FILE_EXTENSIONS:
300  plt.gcf().savefig(
301  FIGURE_PATH + title.replace(" ", "_") + "." + ext,
302  format=ext,
303  dpi=FIGURES_DPI,
304  bbox_inches="tight",
305  )
306  else:
307  ax[nRows // 2, 0].set_ylabel(title)
308  if SHOW_LEGENDS:
309  # leg = ax[0,0].legend(bbox_to_anchor=(0., 1.02, 1., .102), loc=3, ncol=2, mode="expand", borderaxespad=0.)
310  leg = ax[0, 0].legend(loc="best")
311  # leg.get_frame().set_alpha(LEGEND_ALPHA)
312  return ax
313 
314 
315 def plotQuantityPerSolver(
316  quantity,
317  title,
318  solver_names,
319  line_styles,
320  yscale="linear",
321  ylabel="",
322  x=None,
323  xlabel="",
324  legend_location="best",
325 ):
326  f, ax = plt.subplots()
327  lw = DEFAULT_LINE_WIDTH
328  if x is None:
329  x = list(range(quantity.shape[0]))
330 
331  for i in range(len(solver_names)):
332  ax.plot(x, quantity[:, i], line_styles[i], alpha=LINE_ALPHA, linewidth=lw)
333  lw = max(lw - LINE_WIDTH_RED, LINE_WIDTH_MIN)
334  ax.set_yscale(yscale)
335  ax.set_ylabel(ylabel)
336  ax.set_xlabel(xlabel)
337  ymin = np.min(quantity)
338  ymax = np.max(quantity)
339  ax.set_ylim([ymin - 0.1 * (ymax - ymin), ymax + 0.1 * (ymax - ymin)])
340  if SHOW_LEGENDS:
341  leg = ax.legend(solver_names, loc=legend_location)
342  leg.get_frame().set_alpha(LEGEND_ALPHA)
343  if SAVE_FIGURES:
344  for ext in FILE_EXTENSIONS:
345  plt.gcf().savefig(
346  FIGURE_PATH + title.replace(" ", "_") + "." + ext,
347  format=ext,
348  dpi=FIGURES_DPI,
349  bbox_inches="tight",
350  )
351  elif ylabel == "":
352  ax.set_ylabel(title)
353 
354 
355 def plotQuantityVsQuantityPerSolver(
356  quantity, quantityPerSolver, legend, solver_names, line_styles, yscale="linear"
357 ):
358  r = 0
359  c = 0
360  if len(solver_names) == 4 or len(solver_names) == 3:
361  r = 2
362  c = 2
363  elif len(solver_names) == 5 or len(solver_names) == 6:
364  r = 2
365  c = 3
366  else:
367  print("ERROR in plotQuantityVsQuantityPerSolver, number of solvers not managed")
368  return
369  f, ax = plt.subplots(r, c, sharex=True, sharey=True)
370  for i in range(len(solver_names)):
371  ax[i / c, i % c].plot(
372  quantity[:, i],
373  "kx-",
374  quantityPerSolver[:, i],
375  line_styles[i],
376  alpha=LINE_ALPHA,
377  )
378  ax[i / c, i % c].set_ylabel(solver_names[i])
379  ax[i / c, i % c].set_yscale(yscale)
380  if SAVE_FIGURES:
381  for ext in FILE_EXTENSIONS:
382  f.savefig(
383  FIGURE_PATH
384  + (legend[0] + "_VS_" + legend[1]).replace(" ", "_")
385  + "."
386  + ext,
387  format=ext,
388  dpi=FIGURES_DPI,
389  bbox_inches="tight",
390  )
391  if SHOW_LEGENDS:
392  leg = ax[0, 0].legend(legend, loc="best")
393  leg.get_frame().set_alpha(LEGEND_ALPHA)
394 
395 
396 def grayify_cmap(cmap):
397  """Return a grayscale version of the colormap"""
398  cmap = plt.cm.get_cmap(cmap)
399  colors = cmap(np.arange(cmap.N))
400 
401  # convert RGBA to perceived greyscale luminance
402  # cf. http://alienryderflex.com/hsp.html
403  RGB_weight = [0.299, 0.587, 0.114]
404  luminance = np.sqrt(np.dot(colors[:, :3] ** 2, RGB_weight))
405  colors[:, :3] = luminance[:, np.newaxis]
406 
407  return cmap.from_list(cmap.name + "_grayscale", colors, cmap.N)
408 
409 
410 def saveFigure(title):
411  if SAVE_FIGURES:
412  for ext in FILE_EXTENSIONS:
413  plt.gcf().savefig(
414  FIGURE_PATH + title.replace(" ", "_") + "." + ext,
415  format=ext,
416  dpi=FIGURES_DPI,
417  bbox_inches="tight",
418  )
plot_utils.create_empty_figure
def create_empty_figure(nRows=1, nCols=1, figsize=(7, 7), spinesPos=None, sharex=True)
Definition: plot_utils.py:67
plot_utils.plotQuantityVsQuantityPerSolver
def plotQuantityVsQuantityPerSolver(quantity, quantityPerSolver, legend, solver_names, line_styles, yscale="linear")
Definition: plot_utils.py:357
plot_utils.plotNdQuantityPerSolver
def plotNdQuantityPerSolver(nRows, nCols, quantity, title, solver_names, line_styles, ax=None, boundUp=None, boundLow=None, yscale="linear", subplot_titles=None, ylabels=None, sharey=False, margins=None, x=None)
Definition: plot_utils.py:179
plot_utils.setAxisFontSize
def setAxisFontSize(ax, size)
Definition: plot_utils.py:90
plot_utils.saveFigure
def saveFigure(title)
Definition: plot_utils.py:410
plot_utils.plot3dQuantity
def plot3dQuantity(quantity, title, ax=None, boundUp=None, boundLow=None, yscale="linear", linestyle="k")
Definition: plot_utils.py:119
plot_utils.grayify_cmap
def grayify_cmap(cmap)
Definition: plot_utils.py:396
plot_utils.plotNdQuantity
def plotNdQuantity(nRows, nCols, quantity, title="", ax=None, boundUp=None, boundLow=None, yscale="linear", linestyle="k--", sharey=False, margins=None)
Definition: plot_utils.py:137
plot_utils.plotQuantityPerSolver
def plotQuantityPerSolver(quantity, title, solver_names, line_styles, yscale="linear", ylabel="", x=None, xlabel="", legend_location="best")
Definition: plot_utils.py:325
plot_utils.movePlotSpines
def movePlotSpines(ax, spinesPos)
Definition: plot_utils.py:81

tsid
Author(s): Andrea Del Prete, Justin Carpentier
autogenerated on Sun Jul 2 2023 02:21:51