Coverage for pySDC/helpers/plot_helper.py: 94%
33 statements
« prev ^ index » next coverage.py v7.8.0, created at 2025-04-01 13:12 +0000
« prev ^ index » next coverage.py v7.8.0, created at 2025-04-01 13:12 +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 'Springer_proceedings': 347.12354,
46 'JSC_thesis': 434.26027,
47 'TUHH_thesis': 426.79135,
48 }
49 # store text height in points here, get this from LaTeX using \the\textheight
50 textheights = {
51 'JSC_beamer': 214.43411,
52 'JSC_thesis': 635.5,
53 'TUHH_thesis': 631.65118,
54 'Springer_proceedings': 549.13828,
55 }
56 assert (
57 journal in textwidths.keys()
58 ), f"Textwidth only available for {list(textwidths.keys())}. Please implement one for \"{journal}\"! Get the textwidth using \"\\the\\textwidth\" in your tex file."
60 # see if the figure fits on the page or if we need to apply the scaling to the height instead
61 if scale * ratio * textwidths[journal] > textheights.get(journal, 1e9):
62 if textheights[journal] / scale / ratio > textwidths[journal]:
63 raise ValueError(
64 f"We cannot fit figure with scale {scale:.2f} and ratio {ratio:.2f} on the page for journal {journal}!"
65 )
66 return figsize(textheights[journal] / (scale * ratio), 1, ratio)
68 return figsize(textwidths[journal], scale, ratio)
71def setup_mpl(font_size=8, reset=False):
72 if reset:
73 mpl.rcParams.update(default_mpl_params)
75 # Set up plotting parameters
76 style_options = { # setup matplotlib to use latex for output
77 "font.family": "serif",
78 "font.serif": [], # blank entries should cause plots to inherit fonts from the document
79 "font.sans-serif": [],
80 "font.monospace": [],
81 # "axes.labelsize": 8, # LaTeX default is 10pt font.
82 "axes.linewidth": 0.5,
83 "font.size": font_size,
84 # "legend.fontsize": 6, # Make the legend/label fonts a little smaller
85 "legend.numpoints": 1,
86 # "xtick.labelsize": 6,
87 "xtick.major.width": 0.5, # major tick width in points
88 "xtick.minor.width": 0.25,
89 # "ytick.labelsize": 6,
90 "ytick.major.width": 0.5, # major tick width in points
91 "ytick.minor.width": 0.25,
92 "lines.markersize": 4,
93 "lines.markeredgewidth": 0.5,
94 "grid.linewidth": 0.5,
95 "grid.linestyle": '-',
96 "grid.alpha": 0.25,
97 "figure.subplot.hspace": 0.0,
98 "savefig.pad_inches": 0.01,
99 }
101 mpl.rcParams.update(style_options)
103 if find_executable('latex'):
104 latex_support = {
105 "pgf.texsystem": "pdflatex", # change this if using xetex or lautex
106 "text.usetex": True, # use LaTeX to write all text
107 "pgf.preamble": r"\usepackage[utf8x]{inputenc}"
108 r"\usepackage[T1]{fontenc}"
109 r"\usepackage{underscore}"
110 r"\usepackage{amsmath,amssymb,marvosym}",
111 }
112 else:
113 latex_support = {
114 "text.usetex": False, # use LaTeX to write all text
115 }
117 mpl.rcParams.update(latex_support)
118 plt.close('all')
121def newfig(textwidth, scale, ratio=0.6180339887):
122 plt.clf()
123 fig, ax = plt.subplots(figsize=figsize(textwidth, scale, ratio))
124 return fig, ax
127def savefig(filename, save_pdf=True, save_pgf=True, save_png=True):
128 if save_pgf and find_executable('latex'):
129 plt.savefig('{}.pgf'.format(filename), bbox_inches='tight')
130 if save_pdf:
131 plt.savefig('{}.pdf'.format(filename), bbox_inches='tight')
132 if save_png:
133 plt.savefig('{}.png'.format(filename), bbox_inches='tight')
134 plt.close()