Coverage for pySDC/helpers/plot_helper.py: 94%
33 statements
« prev ^ index » next coverage.py v7.5.0, created at 2024-04-29 09:02 +0000
« prev ^ index » next coverage.py v7.5.0, created at 2024-04-29 09:02 +0000
1import matplotlib as mpl
2import matplotlib.pyplot as plt
3from distutils.spawn import find_executable
5default_mpl_params = mpl.rcParams.copy()
8def figsize(textwidth, scale, ratio):
9 """
10 Get figsize.
12 Args:
13 textwidth (str): Textwdith in your LaTeX file in points
14 scale (float): The width of the figure relative to the textwidth
15 ratio (float): The height of the figure relative to its width
17 Returns:
18 list: Width and height of the figure to be passed to matplotlib
19 """
20 fig_width_pt = textwidth # Get this from LaTeX using \the\textwidth
21 inches_per_pt = 1.0 / 72.27 # Convert pt to inch
22 fig_width = fig_width_pt * inches_per_pt * scale # width in inches
23 fig_height = fig_width * ratio # height in inches
24 fig_size = [fig_width, fig_height]
25 return fig_size
28def figsize_by_journal(journal, scale, ratio): # pragma: no cover
29 """
30 Get figsize for specific journal. If you supply a text height, we will rescale the figure to fit on the page instead
31 of the parameters supplied.
33 Args:
34 journal (str): Name of journal
35 scale (float): The width of the figure relative to the textwidth
36 ratio (float): The height of the figure relative to its width
38 Returns:
39 list: Width and height of the figure to be passed to matplotlib
40 """
41 # store text width in points here, get this from LaTeX using \the\textwidth
42 textwidths = {
43 'JSC_beamer': 426.79135,
44 'Springer_Numerical_Algorithms': 338.58778,
45 }
46 # store text height in points here, get this from LaTeX using \the\textheight
47 textheights = {
48 'JSC_beamer': 214.43411,
49 }
50 assert (
51 journal in textwidths.keys()
52 ), f"Textwidth only available for {list(textwidths.keys())}. Please implement one for \"{journal}\"! Get the textwidth using \"\\the\\textwidth\" in your tex file."
54 # see if the figure fits on the page or if we need to apply the scaling to the height instead
55 if scale * ratio * textwidths[journal] > textheights.get(journal, 1e9):
56 if textheights[journal] / scale / ratio > textwidths[journal]:
57 raise ValueError(
58 f"We cannot fit figure with scale {scale:.2f} and ratio {ratio:.2f} on the page for journal {journal}!"
59 )
60 return figsize(textheights[journal] / (scale * ratio), 1, ratio)
62 return figsize(textwidths[journal], scale, ratio)
65def setup_mpl(font_size=8, reset=False):
66 if reset:
67 mpl.rcParams.update(default_mpl_params)
69 # Set up plotting parameters
70 style_options = { # setup matplotlib to use latex for output
71 "font.family": "serif",
72 "font.serif": [], # blank entries should cause plots to inherit fonts from the document
73 "font.sans-serif": [],
74 "font.monospace": [],
75 # "axes.labelsize": 8, # LaTeX default is 10pt font.
76 "axes.linewidth": 0.5,
77 "font.size": font_size,
78 # "legend.fontsize": 6, # Make the legend/label fonts a little smaller
79 "legend.numpoints": 1,
80 # "xtick.labelsize": 6,
81 "xtick.major.width": 0.5, # major tick width in points
82 "xtick.minor.width": 0.25,
83 # "ytick.labelsize": 6,
84 "ytick.major.width": 0.5, # major tick width in points
85 "ytick.minor.width": 0.25,
86 "lines.markersize": 4,
87 "lines.markeredgewidth": 0.5,
88 "grid.linewidth": 0.5,
89 "grid.linestyle": '-',
90 "grid.alpha": 0.25,
91 "figure.subplot.hspace": 0.0,
92 "savefig.pad_inches": 0.01,
93 }
95 mpl.rcParams.update(style_options)
97 if find_executable('latex'):
98 latex_support = {
99 "pgf.texsystem": "pdflatex", # change this if using xetex or lautex
100 "text.usetex": True, # use LaTeX to write all text
101 "pgf.preamble": r"\usepackage[utf8x]{inputenc}"
102 r"\usepackage[T1]{fontenc}"
103 r"\usepackage{underscore}"
104 r"\usepackage{amsmath,amssymb,marvosym}",
105 }
106 else:
107 latex_support = {
108 "text.usetex": False, # use LaTeX to write all text
109 }
111 mpl.rcParams.update(latex_support)
112 plt.close('all')
115def newfig(textwidth, scale, ratio=0.6180339887):
116 plt.clf()
117 fig, ax = plt.subplots(figsize=figsize(textwidth, scale, ratio))
118 return fig, ax
121def savefig(filename, save_pdf=True, save_pgf=True, save_png=True):
122 if save_pgf and find_executable('latex'):
123 plt.savefig('{}.pgf'.format(filename), bbox_inches='tight')
124 if save_pdf:
125 plt.savefig('{}.pdf'.format(filename), bbox_inches='tight')
126 if save_png:
127 plt.savefig('{}.png'.format(filename), bbox_inches='tight')
128 plt.close()