tikzplot42 0.3.4__tar.gz → 0.3.6__tar.gz

{tikzplot42-0.3.4 → tikzplot42-0.3.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tikzplot42
-Version: 0.3.4
+Version: 0.3.6
 Summary: TikzPlot to make TikZ/PGFPlots plots with matplotlib.pyplot-like syntax.
 Author-email: Zan Ambrozic <zan.ambrozic7@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -737,12 +737,13 @@ Some basic plot commands are already implemented with commonly used arguments:
 - `semilogx()/semilogy()`,
 - `errorbar()`,
 - `stem()`,
-- `fill-between()`,
+- `fill_between()`,
 - `hlines()/vlines()`,
 - `historgam()`,
 - `step()`,
 - `imshow()`,
-- `text()`.
+- `text()`,
+- `magnify()` (used to magnify part of a plot, but Tikz cannot handle `fill_between` if this one is used, which is a long known issue). 
 
 #### Figures
 - `plt.figure()` (currently only to give you figure object or to set `figsize`),
@@ -775,7 +776,8 @@ If axes and plot have different name for command with same effect, both are impl
 #### Colorbars
 Colorbars and colormaps are implemented a bit differently than in matplotlib (simplified):
 - if you use `imshow()`, you may use its return in `Colorbar()` (which you have to import as `from tikzplot import Colorbar`),
-- you may use `Colorbar(axis, cmap, lower, upper, ...)` for manual colorbar. Additional kwargs may also be used by `imshow()` return.
+- you may use `Colorbar(axis, cmap, lower, upper, ...)` for manual colorbar. Additional kwargs may also be used by `imshow()` return,
+- note that only one colorbar/colormap per axis is allowed (also if you use `scatter` with colormap/colorbar).
 
 #### TikzConfig
 For plot configurations (default sizes, paddings, etc.), use `from tikzplot import TikzConfig`:

{tikzplot42-0.3.4 → tikzplot42-0.3.6}/README.md

@@ -35,12 +35,13 @@ Some basic plot commands are already implemented with commonly used arguments:
 - `semilogx()/semilogy()`,
 - `errorbar()`,
 - `stem()`,
-- `fill-between()`,
+- `fill_between()`,
 - `hlines()/vlines()`,
 - `historgam()`,
 - `step()`,
 - `imshow()`,
-- `text()`.
+- `text()`,
+- `magnify()` (used to magnify part of a plot, but Tikz cannot handle `fill_between` if this one is used, which is a long known issue). 
 
 #### Figures
 - `plt.figure()` (currently only to give you figure object or to set `figsize`),
@@ -73,7 +74,8 @@ If axes and plot have different name for command with same effect, both are impl
 #### Colorbars
 Colorbars and colormaps are implemented a bit differently than in matplotlib (simplified):
 - if you use `imshow()`, you may use its return in `Colorbar()` (which you have to import as `from tikzplot import Colorbar`),
-- you may use `Colorbar(axis, cmap, lower, upper, ...)` for manual colorbar. Additional kwargs may also be used by `imshow()` return.
+- you may use `Colorbar(axis, cmap, lower, upper, ...)` for manual colorbar. Additional kwargs may also be used by `imshow()` return,
+- note that only one colorbar/colormap per axis is allowed (also if you use `scatter` with colormap/colorbar).
 
 #### TikzConfig
 For plot configurations (default sizes, paddings, etc.), use `from tikzplot import TikzConfig`:

{tikzplot42-0.3.4 → tikzplot42-0.3.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "tikzplot42"
-version = "0.3.4"
+version = "0.3.6"
 description = "TikzPlot to make TikZ/PGFPlots plots with matplotlib.pyplot-like syntax."
 authors = [
     { name = "Zan Ambrozic", email = "zan.ambrozic7@gmail.com" }

{tikzplot42-0.3.4 → tikzplot42-0.3.6}/src/tikzplot/axes.py

@@ -20,6 +20,8 @@ class BaseAxes:
             self._axis_args.add("/pgf/number format/use comma")
 
         self._add_legend = ""
+        self._coordinates = {}
+        self._cmap_bar = None
 
     def _plot(self, x, y, settings=None, xerr=None, yerr=None, **style):
         if not isinstance(self, Secondary) and self._polar:
@@ -71,6 +73,10 @@ class BaseAxes:
                             vmin = kwargs.pop("vmin", min(c))
                             vmax = kwargs.pop("vmax", max(c))
                             kwargs["cmap"] = Colorbar(cmap=cmap, lower=vmin, upper=vmax)
+                    if self._cmap_bar and self._cmap_bar != kwargs["cmap"]:
+                        raise Warning("Multiple colormaps on same axis! Only one per axis is allowed.")
+                    else:
+                        self._cmap_bar = kwargs["cmap"]
         except: pass
         
         return self._plot(x, y, **kwargs, ls="", settings=["scatter"])
@@ -331,6 +337,13 @@ class BaseAxes:
         txt = Text(self, x, y, s, **kwargs)
         self._elements.append(txt)
 
+    def magnify(self, x_p, y_p, x_m, y_m, zoom, size, **kwargs):
+        kws = {"shape", "connect"}
+        kwargs = self._check_kwargs("magnify", kws, **kwargs)
+        n = self._fig._add_spy(zoom, size, **kwargs)
+        self._coordinates.update({f"spypoint{n}": (x_p,y_p)})
+        self._coordinates.update({f"spyviewr{n}": (x_m,y_m)})
+
     def _add_legend_entries(self):
         if self._add_legend == "": return ""
         axs, labs = self._add_legend
@@ -346,6 +359,9 @@ class BaseAxes:
     def _content_tex(self, filename):
         ouptut = "\n".join(e._to_tex(filename) for e in self._elements)
         ouptut += self._add_legend_entries()
+        for coord in self._coordinates:
+            x,y = self._coordinates[coord]
+            ouptut += f"\n\\coordinate ({coord}) at ({x},{y});"
         return ouptut
     
     def _get_hard_range(self,which):
@@ -659,7 +675,10 @@ class Axes(BaseAxes):
         if self._axis_options:
             if axis_opt_str: axis_opt_str += ",\n"
             axis_opt_str += ",\n".join(f"{k}={v}" for k, v in self._axis_options.items())
-        axis_opt_str += self._colorbar
+        if self._colorbar:
+            axis_opt_str += self._colorbar
+        elif self._cmap_bar:
+            axis_opt_str += f",\n colormap={self._cmap_bar._generate_tex_colormap(self._cmap_bar._cmap)}"
         return axis_opt_str
 
     

{tikzplot42-0.3.4 → tikzplot42-0.3.6}/src/tikzplot/axes.pyi

@@ -313,6 +313,32 @@ class BaseAxes:
             Mark size in pt
         """
         ...
+
+    def spy(self, x_p: float, y_p: float, x_m: float, y_m: float, zoom: float, size: float, **kwargs) -> int:
+        """
+        Add a spy to the selected axis.
+
+        Parameters
+        ----------
+        x_p, y_p: float
+            Spy point coordinates in axis units
+
+        x_m, y_m: float
+            Spy view coordinates in cm
+
+        zoom: float
+            Spy zoom
+
+        size: float
+            Spy viewer size in cm
+
+        shape: {"circle"}, optional
+            Spy shape, default square
+
+        connect: bool, optional
+            Connect spy point and view with a line, default False
+        """
+        ...
     
     def set_ylabel(self, label: str) -> None: 
         """

{tikzplot42-0.3.4 → tikzplot42-0.3.6}/src/tikzplot/elements.py

@@ -88,11 +88,15 @@ class BaseGraph:
                 opts.append(ls)
 
         if "c" in self._style or "color" in self._style:
-            if "scatter" in self._settings and self._colors is not None:
-                if isinstance(self._colors[0], (int, float)):
-                    self._colors = [match_color(cmap.color(p)) for p in self._colors]
-                else:
-                    self._colors = [match_color(p) for p in self._colors]
+            if "scatter" in self._settings:
+                if self._colors is not None:
+                    if not isinstance(self._colors[0], (int, float)):
+                        self._colors = [match_color(p) for p in self._colors]
+                elif self._sizes is not None:
+                    c = self._style.get("c", self._style.get("color"))
+                    sel_col = match_color(c)
+                    if sel_col:
+                        self._colors = [sel_col] * len(self._x)
             else:
                 c = self._style.get("c", self._style.get("color"))
                 sel_col = match_color(c)
@@ -163,19 +167,28 @@ class BaseGraph:
         if self._settings:
             opts = self._settings + opts
         if "scatter" in self._settings and (self._colors is not None or self._sizes is not None):
-            last = 0
-            for i in range(len(self._x)):
-                st = ""
-                if self._colors is not None:
-                    st = f"color={{{self._colors[i]}}},"
-                if self._sizes is not None:
-                    st += f"mark size={self._sizes[i]:.9f}pt"
-                if st not in self._st_dict:
-                    self._st_dict[st] = "s" + str(last+1)
-                    last += 1
-                self._p_dict[i] = self._st_dict[st]
-            opts.append("point meta=explicit symbolic")
-            opts.append(f"scatter/classes={{\n" + ',\n'.join(f"{v}={{{k}}}" for k,v in self._st_dict.items()) + "\n}")
+            if self._sizes is not None:
+                    if self._p_dict:
+                        opts.append("visualization depends on=\\thisrow{size} \\as \\perpointsize,")
+                    else:
+                        opts.append("visualization depends on=\\thisrow{size} \\as \\perpointsize,\n scatter/@pre marker code/.append code={ \\pgfplotsset{mark size=\\perpointsize}},")
+            if "cmap" in self._style:
+                opts.append("scatter src=explicit")
+            else:
+                last = 0
+                for i in range(len(self._x)):
+                    st = ""
+                    if self._colors is not None:
+                        if self._sizes is None:
+                            st = f"color={{{self._colors[i]}}},"
+                        else:
+                            st = f"color={{{self._colors[i]}}},/tikz/mark size=\\perpointsize,"
+                    if st not in self._st_dict:
+                        self._st_dict[st] = "s" + str(last+1)
+                        last += 1
+                    self._p_dict[i] = self._st_dict[st]
+                opts.append("point meta=explicit symbolic")
+                opts.append(f"scatter/classes={{\n" + ',\n'.join(f"{v}={{{k}}}" for k,v in self._st_dict.items()) + "\n}")
         self._style_str = ",\n".join(str(o) for o in opts)
         return self._style_str
     
@@ -251,9 +264,6 @@ class Graph(BaseGraph):
                     except: pass
                 if self._colors is None and self._sizes is None:
                     self._settings.remove("scatter")
-                else:
-                    if self._colors is None:
-                        self._colors = style.get("c", style.get("color", self._axes._get_defcol())) * np.ones(len(self._x))
         else:
             self._special = coordinates
         self._label = None
@@ -277,8 +287,13 @@ class Graph(BaseGraph):
             else:
                 cols.append("yerror")
         if "scatter" in self._settings:
-            if self._p_dict:
-                cols.append("label")                
+            if "cmap" in self._style:
+                cols.append("color")
+            else:
+                if self._p_dict:
+                    cols.append("label")                
+            if self._sizes is not None:
+                    cols.append("size")
         return " ".join(cols)
 
     def _rows(self):    
@@ -296,8 +311,13 @@ class Graph(BaseGraph):
                 else:
                     line.append(self._yerr[i])
             if "scatter" in self._settings:
-                if self._p_dict:
-                    line.append(self._p_dict[i])
+                if "cmap" in self._style:
+                    line.append(self._colors[i])
+                else:
+                    if self._p_dict:
+                        line.append(self._p_dict[i])
+                if self._sizes is not None:
+                    line.append(f"{self._sizes[i]:.9f} pt")
             rows.append(" ".join(str(v) for v in line))
         return "\n".join(rows)
     
@@ -312,8 +332,11 @@ class Graph(BaseGraph):
                 table_opts += ",x error=xerror"
             if self._yerr is not None:
                 table_opts += ",y error=yerror"
-            if "scatter" in self._settings and self._p_dict:
-                table_opts += ",meta=label"
+            if "scatter" in self._settings:
+                if "cmap" in self._style:
+                    table_opts += ",meta=color"
+                elif self._p_dict:
+                    table_opts += ",meta=label"
             datapoints = f"{header}\n{rows}\n"
             if TikzConfig.SAVE_DATAPOINTS:
                 datapoints = self._save_data(datapoints, filename)

{tikzplot42-0.3.4 → tikzplot42-0.3.6}/src/tikzplot/figure.py

@@ -28,6 +28,7 @@ class Figure:
         self._col_dict = {}
 
         self._globals = set()
+        self._spies = []
 
     def add_subplot(self, nrows=1, ncols=1, index=1, sharex=None, sharey=None, projection=None, polar=False):
         if projection=="3d":
@@ -195,6 +196,21 @@ class Figure:
         for group in shared_y:
             set_ax_ranges("y", group)
 
+    def _add_spy(self, zoom, size, **kwargs):
+        sp_str = f"\\spy [size={size}cm, magnification={zoom}"
+        bck = ""
+        n = len(self._spies)
+        if "shape" in kwargs and kwargs["shape"] == "circle":
+            sp_str += ", circle"
+            bck = f"\\fill[white] (spyviewr{n}) circle ({size/2}cm);\n"
+        else:
+            bck = f"\\fill[white] ($(spyviewr{n}) + (-{size/2}cm,-{size/2}cm)$) rectangle ($(spyviewr{n}) + ({size/2}cm,{size/2}cm)$);\n"
+        if "connect" in kwargs and kwargs["connect"]:
+            sp_str += ", connect spies"
+        sp_str += f"] on (spypoint{n}) in node at (spyviewr{n});"
+        self._spies.append(bck + sp_str)
+        return n
+    
     def _reduce_points(self):
         counts = [0]
         for ax in self._axes:
@@ -229,14 +245,20 @@ class Figure:
             if TikzConfig.USE_GROUPPLOTS:
                 preambule += "\\usepgfplotslibrary{groupplots}\n"
             preambule += "\\usepgfplotslibrary{fillbetween}\n"
+            preambule += "\\usepgfplotslibrary{polar}\n"
             preambule += f"\\pgfplotsset{{compat={TikzConfig.TIKZ_COMPAT}}}\n"
             if TikzConfig.USE_XCOLOR:
                 preambule += "\\usepackage{xcolor}\n"
+            if self._spies:
+                 preambule += "\\usetikzlibrary{spy}\n"
             preambule += "\\begin{document}\n"
             
         lines = [g for g in self._globals]
         lines2 = []
-        lines.append("\\begin{tikzpicture}")
+        if self._spies:
+            lines.append("\\begin{tikzpicture}[spy using outlines={}]")
+        else:
+            lines.append("\\begin{tikzpicture}")
         nrows = self._axes[0]._get_nrows()
         ncols = self._axes[0]._get_ncols()
         if TikzConfig.USE_GROUPPLOTS:
@@ -253,6 +275,8 @@ class Figure:
         if TikzConfig.USE_GROUPPLOTS:
             lines.append("\\end{groupplot}")
         lines += lines2
+        for spy in self._spies:
+            lines.append(spy)
         lines.append("\\end{tikzpicture}")
         for c in self._col_dict:
             r,g,b=self._col_dict[c]

{tikzplot42-0.3.4 → tikzplot42-0.3.6}/src/tikzplot/plots.py

@@ -154,6 +154,10 @@ def step(*args, **kwargs):
     _ensure_axes()
     return _current_axes.step(*args, **kwargs)
 
+def magnify(*args, **kwargs):
+    _ensure_axes()
+    return _current_axes.magnify(*args, **kwargs)
+
 def xticks(*args, **kwargs):
     _ensure_axes()
     _current_axes.set_xticks(*args, **kwargs)

{tikzplot42-0.3.4 → tikzplot42-0.3.6}/src/tikzplot/plots.pyi

@@ -465,6 +465,26 @@ def step(self, x: ArrayLike, y: ArrayLike, *args: Any, where: Literal["pre","pos
     """
     ...
 
+def spy(self, x_p: float, y_p: float, x_m: float, y_m: float, zoom: float, size: float, **kwargs) -> int:
+    """
+    Add a spy to the selected axis.
+    Parameters
+    ----------
+    x_p, y_p: float
+        Spy point coordinates in axis units
+    x_m, y_m: float
+        Spy view coordinates in cm
+    zoom: float
+        Spy zoom
+    size: float
+        Spy viewer size in cm
+    shape: {"circle"}, optional
+        Spy shape, default square
+    connect: bool, optional
+        Connect spy point and view with a line, default False
+    """
+    ...
+
 def hlines(
     self,
     y: Union[float, Sequence[float]],

{tikzplot42-0.3.4 → tikzplot42-0.3.6}/src/tikzplot42.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tikzplot42
-Version: 0.3.4
+Version: 0.3.6
 Summary: TikzPlot to make TikZ/PGFPlots plots with matplotlib.pyplot-like syntax.
 Author-email: Zan Ambrozic <zan.ambrozic7@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -737,12 +737,13 @@ Some basic plot commands are already implemented with commonly used arguments:
 - `semilogx()/semilogy()`,
 - `errorbar()`,
 - `stem()`,
-- `fill-between()`,
+- `fill_between()`,
 - `hlines()/vlines()`,
 - `historgam()`,
 - `step()`,
 - `imshow()`,
-- `text()`.
+- `text()`,
+- `magnify()` (used to magnify part of a plot, but Tikz cannot handle `fill_between` if this one is used, which is a long known issue). 
 
 #### Figures
 - `plt.figure()` (currently only to give you figure object or to set `figsize`),
@@ -775,7 +776,8 @@ If axes and plot have different name for command with same effect, both are impl
 #### Colorbars
 Colorbars and colormaps are implemented a bit differently than in matplotlib (simplified):
 - if you use `imshow()`, you may use its return in `Colorbar()` (which you have to import as `from tikzplot import Colorbar`),
-- you may use `Colorbar(axis, cmap, lower, upper, ...)` for manual colorbar. Additional kwargs may also be used by `imshow()` return.
+- you may use `Colorbar(axis, cmap, lower, upper, ...)` for manual colorbar. Additional kwargs may also be used by `imshow()` return,
+- note that only one colorbar/colormap per axis is allowed (also if you use `scatter` with colormap/colorbar).
 
 #### TikzConfig
 For plot configurations (default sizes, paddings, etc.), use `from tikzplot import TikzConfig`:

{tikzplot42-0.3.4 → tikzplot42-0.3.6}/tests/test10.py

@@ -20,5 +20,5 @@ colors = theta
 fig = plt.figure(figsize=(6, 6))
 ax = fig.add_subplot(projection='polar')
 #cbar = Colorbar(cmap='hsv', lower=0, upper=max(theta))
-c = ax.scatter(theta, r, c=colors, s=area, cmap='hsv', alpha=0.75)
+c = ax.scatter(theta, r, c="blue", s=100, alpha=0.75)
 plt.savefig("figure.tex")

{tikzplot42-0.3.4 → tikzplot42-0.3.6}/tests/test3.py

@@ -49,6 +49,7 @@ y2 = [25, 20, 15, 10, 5]
 
 ax5.plot(x, y1, color='cyan', linestyle='--', marker='o')
 ax5.plot(x, y2, color='purple', linestyle='-', marker='x')
+ax5.magnify(3.5, 12, 2, 10, 5, 2, connect=True)
 
 ax1.errorbar(points[:,0], ys, yerr=yerr, marker="o", linestyle="", color="blue", label="Meritve")
 lims = np.array([points[0,0], points[-1,0]])