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

tsid
Author(s): Andrea Del Prete, Justin Carpentier
autogenerated on Thu Apr 3 2025 02:47:15