Set canvas with with a string, example '17cm'

Author: max-models

pyproject.toml

@@ -16,6 +16,7 @@ classifiers = [
 ]
 dependencies = [
     "matplotlib",
+    "pint",
     "plotly",
     "pytest",
     "ruff",

src/maxplotlib/backends/matplotlib/utils.py

@@ -9,6 +9,7 @@
 import matplotlib.colors as mcolors
 import matplotlib.pyplot as plt
 import numpy as np
+import pint
 from matplotlib.collections import PatchCollection
 from mpl_toolkits.mplot3d import Axes3D
 from mpl_toolkits.mplot3d.art3d import Line3DCollection, Poly3DCollection
@@ -54,7 +55,29 @@ def setup_plotstyle(
     plt.rcParams["ytick.major.pad"] = 8
 
 
-def set_size(width, fraction=1, ratio="golden"):
+# TODO: Use the other unit package
+# Create a UnitRegistry
+ureg = pint.UnitRegistry()
+
+
+def convert_to_inches(length_str):
+    quantity = ureg(length_str)  # Parse the input string
+    return quantity.to("inch").magnitude  # Convert to inches
+
+
+def _2pt(width, dpi=300):
+    if isinstance(width, (int, float)):
+        return width
+    elif isinstance(width, str):
+        length_in = convert_to_inches(width)
+        length_pt = length_in * dpi
+        # print(f"{length_in = } {length_pt = }")
+        return length_pt
+    else:
+        raise NotImplementedError
+
+
+def set_size(width, fraction=1, ratio="golden", dpi=300):
     """
     Sets figure dimensions to avoid scaling in LaTeX.
     """
@@ -63,7 +86,7 @@ def set_size(width, fraction=1, ratio="golden"):
     elif width == "beamer":
         width_pt = 307.28987
     else:
-        width_pt = width
+        width_pt = _2pt(width=width, dpi=dpi)
 
     fig_width_pt = width_pt * fraction
     # inches_per_pt = 1 / 72.27

src/maxplotlib/canvas/canvas.py

@@ -25,9 +25,10 @@ def __init__(self, **kwargs):
         self._caption = kwargs.get("caption", None)
         self._description = kwargs.get("description", None)
         self._label = kwargs.get("label", None)
-
+        self._fontsize = kwargs.get("fontsize", 14)
         self._dpi = kwargs.get("dpi", 300)
-        self._width = kwargs.get("width", 426.79135)
+        # self._width = kwargs.get("width", 426.79135)
+        self._width = kwargs.get("width", "17cm")
         self._ratio = kwargs.get("ratio", "golden")
         self._gridspec_kw = kwargs.get("gridspec_kw", {"wspace": 0.08, "hspace": 0.1})
 
@@ -158,8 +159,9 @@ def plot_matplotlib(self, show=True, savefig=False, layers=None):
         filename (str, optional): Filename to save the figure.
         show (bool): Whether to display the plot.
         """
-        fontsize = 14
-        tex_fonts = plt_utils.setup_tex_fonts(fontsize=fontsize)
+
+        tex_fonts = plt_utils.setup_tex_fonts(fontsize=self.fontsize)
+
         plt_utils.setup_plotstyle(
             tex_fonts=tex_fonts,
             axes_grid=True,
@@ -172,13 +174,17 @@ def plot_matplotlib(self, show=True, savefig=False, layers=None):
             fig_width, fig_height = self._figsize
         else:
             fig_width, fig_height = plt_utils.set_size(
-                width=self._width, ratio=self._ratio
+                width=self._width,
+                ratio=self._ratio,
+                dpi=self.dpi,
             )
 
+        # print(f"{(fig_width / self._dpi, fig_height / self._dpi) = }")
+
         fig, axes = plt.subplots(
             self.nrows,
             self.ncols,
-            figsize=(fig_width / self._dpi, fig_height / self._dpi),
+            figsize=(fig_width, fig_height),
             squeeze=False,
             dpi=self._dpi,
         )
@@ -189,7 +195,7 @@ def plot_matplotlib(self, show=True, savefig=False, layers=None):
             # ax.set_title(f"Subplot ({row}, {col})")
             ax.grid()
         # Set caption, labels, etc., if needed
-        plt.tight_layout()
+        # plt.tight_layout()
 
         if show:
             plt.show()
@@ -205,9 +211,9 @@ def plot_plotly(self, show=True, savefig=None):
         show (bool): Whether to display the plot.
         savefig (str, optional): Filename to save the figure if provided.
         """
-        fontsize = 14
+
         tex_fonts = plt_utils.setup_tex_fonts(
-            fontsize=fontsize
+            fontsize=self.fontsize
         )  # adjust or redefine for Plotly if needed
 
         # Set default width and height if not specified
@@ -217,7 +223,7 @@ def plot_plotly(self, show=True, savefig=None):
             fig_width, fig_height = plt_utils.set_size(
                 width=self._width, ratio=self._ratio
             )
-        print(self._width, fig_width, fig_height)
+        # print(self._width, fig_width, fig_height)
         # Create subplots
         fig = make_subplots(
             rows=self.nrows,
@@ -256,6 +262,10 @@ def plot_plotly(self, show=True, savefig=None):
     def dpi(self):
         return self._dpi
 
+    @property
+    def fontsize(self):
+        return self._fontsize
+
     @property
     def nrows(self):
         return self._nrows

src/maxplotlib/logo/logo.py

@@ -1,27 +1,35 @@
 # import maxplotlib.canvas.canvas as canvas
 # from maxplotlib.subfigure.tikz_figure import TikzFigure
 from maxtikzlib.figure import TikzFigure
+
+
 def tikz_logo():
     tikz = TikzFigure()
 
-    path_actions = ['draw', 'rounded corners', 'line width=3']
+    path_actions = ["draw", "rounded corners", "line width=3"]
 
     # M
-    nodes = [[0,0],[0,3],[1,2],[2,3],[2,0]]
+    nodes = [[0, 0], [0, 3], [1, 2], [2, 3], [2, 0]]
     for i, node_data in enumerate(nodes):
         tikz.add_node(node_data[0], node_data[1], f"M{i}", layer=0)
-    tikz.add_path([f"M{i}" for i in range(len(nodes))], path_actions=path_actions, layer=1)
-    
+    tikz.add_path(
+        [f"M{i}" for i in range(len(nodes))], path_actions=path_actions, layer=1
+    )
+
     # P
-    nodes = [[3,0],[3,3],[4,2.5],[4,1.5],[3,1]]
+    nodes = [[3, 0], [3, 3], [4, 2.5], [4, 1.5], [3, 1]]
     for i, node_data in enumerate(nodes):
         tikz.add_node(node_data[0], node_data[1], f"P{i}", layer=0)
-    tikz.add_path([f"P{i}" for i in range(len(nodes))], path_actions=path_actions, layer=1)
-    
+    tikz.add_path(
+        [f"P{i}" for i in range(len(nodes))], path_actions=path_actions, layer=1
+    )
+
     # L
-    nodes = [[5,3],[5,0],[7,0]]
+    nodes = [[5, 3], [5, 0], [7, 0]]
     for i, node_data in enumerate(nodes):
         tikz.add_node(node_data[0], node_data[1], f"L{i}", layer=0)
-    tikz.add_path([f"L{i}" for i in range(len(nodes))], path_actions=path_actions, layer=1)
+    tikz.add_path(
+        [f"L{i}" for i in range(len(nodes))], path_actions=path_actions, layer=1
+    )
 
-    return tikz
+    return tikz

src/maxplotlib/objects/layer.py

@@ -1,10 +1,12 @@
 from abc import ABCMeta, abstractmethod
 
+
 class Layer(metaclass=ABCMeta):
     def __init__(self, label):
         self.label = label
         self.items = []
 
+
 class Tikzlayer(Layer):
     def __init__(self, label):
         super().__init__(label)
@@ -15,4 +17,4 @@ def generate_tikz(self):
         for item in self.items:
             tikz_script += item.to_tikz()
         tikz_script += f"\\end{{pgfonlayer}}{{{self.label}}}\n"
-        return tikz_script
+        return tikz_script

src/maxplotlib/subfigure/line_plot.py

@@ -1,9 +1,11 @@
+import matplotlib.pyplot as plt
 import numpy as np
 import plotly.graph_objects as go
 from mpl_toolkits.axes_grid1 import make_axes_locatable
-import matplotlib.pyplot as plt
+
 import maxplotlib.subfigure.tikz_figure as tf
 
+
 class Node:
     def __init__(self, x, y, label="", content="", layer=0, **kwargs):
         self.x = x
@@ -13,6 +15,7 @@ def __init__(self, x, y, label="", content="", layer=0, **kwargs):
         self.layer = layer
         self.options = kwargs
 
+
 class Path:
     def __init__(
         self, nodes, path_actions=[], cycle=False, label="", layer=0, **kwargs
@@ -24,6 +27,7 @@ def __init__(
         self.label = label
         self.options = kwargs
 
+
 class LinePlot:
     def __init__(self, **kwargs):
         """
@@ -56,7 +60,7 @@ def __init__(self, **kwargs):
         # Initialize lists to hold Node and Path objects
         self.nodes = []
         self.paths = []
-        #self.layers = {}
+        # self.layers = {}
 
         # Counter for unnamed nodes
         self._node_counter = 0
@@ -77,7 +81,7 @@ def _add(self, obj, layer):
         else:
             self.layered_line_data[layer] = [obj]
 
-    def add_line(self, x_data, y_data, layer=0, plot_type='plot', **kwargs):
+    def add_line(self, x_data, y_data, layer=0, plot_type="plot", **kwargs):
         """
         Add a line to the plot.
 
@@ -95,17 +99,17 @@ def add_line(self, x_data, y_data, layer=0, plot_type='plot', **kwargs):
             "kwargs": kwargs,
         }
         self._add(ld, layer)
-    
-    def add_imshow(self, data, layer=0, plot_type='imshow', **kwargs):
+
+    def add_imshow(self, data, layer=0, plot_type="imshow", **kwargs):
         ld = {
             "data": np.array(data),
             "layer": layer,
             "plot_type": plot_type,
             "kwargs": kwargs,
         }
         self._add(ld, layer)
-    
-    def add_patch(self, patch, layer=0, plot_type='patch', **kwargs):
+
+    def add_patch(self, patch, layer=0, plot_type="patch", **kwargs):
         ld = {
             "patch": patch,
             "layer": layer,
@@ -114,7 +118,7 @@ def add_patch(self, patch, layer=0, plot_type='patch', **kwargs):
         }
         self._add(ld, layer)
 
-    def add_colorbar(self, label="", layer=0, plot_type='colorbar', **kwargs):
+    def add_colorbar(self, label="", layer=0, plot_type="colorbar", **kwargs):
         cb = {
             "label": label,
             "layer": layer,
@@ -159,9 +163,10 @@ def plot_matplotlib(self, ax, layers=None):
                         **line["kwargs"],
                     )
                 elif line["plot_type"] == "patch":
-                    ax.add_patch(line["patch"],
-                                 **line["kwargs"],
-                                )
+                    ax.add_patch(
+                        line["patch"],
+                        **line["kwargs"],
+                    )
                 elif line["plot_type"] == "colorbar":
                     divider = make_axes_locatable(ax)
                     cax = divider.append_axes("right", size="5%", pad=0.05)
@@ -208,7 +213,7 @@ def plot_plotly(self):
             traces.append(trace)
 
         return traces
-    
+
     def add_node(self, x, y, label=None, content="", layer=0, **kwargs):
         """
         Add a node to the TikZ figure.

src/maxplotlib/subfigure/tikz_figure.py

@@ -36,6 +36,7 @@ def generate_tikz(self):
         tikz_script += f"\\end{{pgfonlayer}}{{{self.label}}}\n"
         return tikz_script
 
+
 class TikzWrapper:
     def __init__(self, raw_tikz, label="", content="", layer=0, **kwargs):
         self.raw_tikz = raw_tikz
@@ -47,6 +48,7 @@ def __init__(self, raw_tikz, label="", content="", layer=0, **kwargs):
     def to_tikz(self):
         return self.raw_tikz
 
+
 class Node:
     def __init__(self, x, y, label="", content="", layer=0, **kwargs):
         """
@@ -298,10 +300,12 @@ def generate_tikz(self):
             tikz_script = figure_env
         tikz_script = self.add_tabs(tikz_script)
         return tikz_script
+
     def savefig(self, filepath):
         tikz_code = self.generate_tikz()
-        with open(filepath, 'w') as f:
+        with open(filepath, "w") as f:
             f.write(tikz_code)
+
     def generate_standalone(self):
         tikz_code = self.generate_tikz()
 

src/maxplotlib/tests/test_imports.py

@@ -4,6 +4,7 @@
 @pytest.mark.parametrize("x", [0])
 def import_modules(x):
     import matplotlib
+
     import maxplotlib
 
 

tutorials/tutorial_06.py

@@ -0,0 +1,10 @@
+import numpy as np
+import maxplotlib.canvas.canvas as canvas
+import matplotlib.pyplot as plt
+c = canvas.Canvas(width=2000, ratio=0.5)
+sp = c.add_subplot(grid=False, xlabel='x', ylabel='y')
+# sp.add_line([0, 1, 2, 3], [0, 1, 4, 9], label="Line 1",layer=1)
+data = np.random.random((10,10))
+sp.add_imshow(data, extent=[1,10,1,20],layer=1)
+#c.plot()
+c.savefig(layer_by_layer=True, filename='figures/tutorial_06_figure_01')