tikzplot42 0.6.2__tar.gz → 0.6.3__tar.gz

{tikzplot42-0.6.2 → tikzplot42-0.6.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tikzplot42
-Version: 0.6.2
+Version: 0.6.3
 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
@@ -764,6 +764,7 @@ Some basic plot commands are already implemented with commonly used arguments:
 - `imshow()`,
 - `matshow()`,
 - `text()`,
+- `annotate()`,
 - `bxp()` (without notches),
 - `boxplot()` (without notches),
 - `violin()`,

{tikzplot42-0.6.2 → tikzplot42-0.6.3}/README.md

@@ -64,6 +64,7 @@ Some basic plot commands are already implemented with commonly used arguments:
 - `imshow()`,
 - `matshow()`,
 - `text()`,
+- `annotate()`,
 - `bxp()` (without notches),
 - `boxplot()` (without notches),
 - `violin()`,

{tikzplot42-0.6.2 → tikzplot42-0.6.3}/pyproject.toml

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

tikzplot42-0.6.3/src/tikzplot/arrows.py

@@ -0,0 +1,87 @@
+from .colors import _tex_color
+
+class Arrow:
+    _LINE_MAP = {"--": "dashed", ":": "dotted", "-.": "dashdotted", "-":"solid"}
+    def __init__(self, ax, x1, y1, x2, y2, coordinate1, coordinate2, **kwargs):
+        self._axes = ax
+        self._x1 = x1
+        self._y1 = y1
+        self._x2 = x2
+        self._y2 = y2
+        self._coordinate1 = coordinate1
+        self._coordinate2 = coordinate2
+        self._kwargs = kwargs
+        self._opacity = 1
+        self._visible = True
+
+    def match_color(self, input):
+        self._has_color = True
+        ccode, op = _tex_color(input)
+        if not isinstance(op, bool):
+            self._opacity = op
+        if isinstance(ccode, str):
+            return ccode
+        r,g,b=ccode
+        self._axes._add_col(r,g,b)
+        return f"c{r:.3f}{g:.3f}{b:.3f}".replace(".", "")
+
+    def _style_string(self):
+        output = []
+        if "arrowstyle" in self._kwargs:
+            allowed = {"<", ">", "|", "stealth", "latex"}
+            arstyle = self._kwargs["arrowstyle"]
+            arstyle = arstyle.split("-")
+            if not all(s in allowed for s in arstyle):
+                raise ValueError(f"Arrow style {self._kwargs['arrowstyle']} not recognized. Valid options should consist of: {allowed}, separated by -.")
+            output.append(self._kwargs["arrowstyle"])
+        if "color" in self._kwargs or "c" in self._kwargs:
+            self._color = self.match_color(self._kwargs.get("color") or self._kwargs.get("c"))
+        if "alpha" in self._kwargs:
+            self._opacity = self._kwargs["alpha"]
+        if "line width" in self._kwargs or "lw" in self._kwargs:
+            output.append("line width=" + str(self._kwargs.get("line width") or self._kwargs.get("lw")))
+        if "linestyle" in self._kwargs or "ls" in self._kwargs:
+            ls = self._kwargs.get("linestyle") or self._kwargs.get("ls")
+            if ls in self._LINE_MAP:
+                ls = self._LINE_MAP[ls]
+            elif ls not in self._LINE_MAP.values():
+                raise ValueError(f"Line style {ls} not recognized. Valid options are: {list(self._LINE_MAP.keys())}.")
+            output.append("line style=" + str(ls))
+        if self._opacity < 1:
+            output.insert(0,f"opacity={self._opacity}")
+        if self._color:
+            output.insert(0,f"color={self._color}")
+        return ", ".join(output)
+
+    def _to_tex(self, *args, **kwargs):
+        if self._visible:
+            if self._coordinate1 is not None:
+                return f"\\coordinate {self._coordinate1} at (axis cs:{self._x1},{self._y1});"
+        else:
+            return ""
+        
+    def _to_tex_fin(self):
+        if self._visible:
+            if self._coordinate1 is not None and self._coordinate2 is not None:
+                return f"\\draw[{self._style_string()}] {self._coordinate2} -- {self._coordinate1};"
+        else:
+            return ""
+
+    def _filter(self, which, label):
+        pass
+
+    def _get_erange(self, which):
+        if which == "xmin":
+            return min(self._x1, self._x2)
+        elif which == "xmax":
+            return max(self._x1, self._x2)
+        elif which == "ymin":
+            return min(self._y1, self._y2)
+        elif which == "ymax":
+            return max(self._y1, self._y2)
+
+    def _num_points(self):
+        return 2
+    
+    def _reduce_points(self, max_points):
+        pass

{tikzplot42-0.6.2 → tikzplot42-0.6.3}/src/tikzplot/axes.py

@@ -9,6 +9,7 @@ from skimage import measure
 
 from .elements import Graph, Single
 from .texts import Text
+from .arrows import Arrow
 from .config import TikzConfig
 from .colorbar import Colorbar
 from .state import _next_imshow_num, main_name
@@ -2560,6 +2561,32 @@ class BaseAxes:
             txt = Text(self, x, y, None, s, **kwargs)
         self._elements[self._get_overlay()].append(txt)
 
+    def annotate(self, text, xy, xytext=None, arrowprops=None, **kwargs):
+        kws = {"alpha", "color", "c", "fontsize", "size", "backgroundcolor", "horizontalalignment", "ha", "verticalalignment", "va", "rotation", "label"}
+        kwargs = self._check_kwargs("annotate", kws, **kwargs)
+        akws = {"arrowstyle", "alpha", "color", "c", "linewidth", "lw", "linestyle", "ls"}
+        passing_kwargs = {"alpha", "color", "c"}
+        ap0 = {k: kwargs[k] for k in passing_kwargs if k in kwargs}
+        if arrowprops is not None:
+            arrowprops = self._check_kwargs("annotate: arrowprops", akws, **arrowprops)
+        else:
+            arrowprops = {}
+        arrowprops = ap0 | arrowprops
+        assert self._fig is not None
+        xa, ya = xy
+        if xytext is not None:
+            xt, yt = xytext
+        else:
+            return self.text(xa, ya, text, **kwargs)
+        ca = self._fig._next_coordinate_name()
+        ct = self._fig._next_coordinate_name()
+        txt = Text(self, xt, yt, ct, text, **kwargs)
+        self._fig._add_text(txt)
+        arr = Arrow(self, xa, ya, xt, yt, ca, ct, **arrowprops)
+        self._fig._add_arrow(arr)
+        self._elements[self._get_overlay()].append(txt)
+        self._elements[self._get_overlay()].append(arr)
+
     def magnify(self, x_p, y_p, x_m, y_m, zoom, size, **kwargs):
         kws = {"shape", "connect"}
         kwargs = self._check_kwargs("magnify", kws, **kwargs)
@@ -2568,6 +2595,9 @@ class BaseAxes:
         self._coordinates.update({f"spypoint{n}": (x_p,y_p)})
         self._coordinates.update({f"spyviewr{n}": (x_m,y_m)})
 
+    def set_axis_off(self):
+        self._axis_options["hide axis"] = None
+
     def _add_legend_entries(self):
         if self._add_legend == []: return ""
         axs, labs = self._add_legend

{tikzplot42-0.6.2 → tikzplot42-0.6.3}/src/tikzplot/axes.pyi

@@ -368,7 +368,7 @@ class BaseAxes:
             Text position in axis coordinates
 
         s: str
-            Text content (LaTeX format)
+            Text content
 
         color or c: all matplotlib color formats (without X11/xkcd), optional
             Text color: RGB/RGBA (tuple), HEX (str), grayscale (float), single-char (str), name (str), default cycle ("CX", X int), none for invisible
@@ -395,6 +395,51 @@ class BaseAxes:
             Legend entry
         """
         ...
+
+    def annotate(self, text: str, xy: Tuple[float|int, float|int], xytext: Optional[Tuple[float|int, float|int]] = None, arrowprops: Optional[dict] = None, alpha: float = 1, color: Optional[ColorLike] = ..., c: Optional[ColorLike] = ..., fontsize: Optional[FontSize] = ..., size: Optional[FontSize] = ..., backgroundcolor: Optional[ColorLike] = ..., horizontalalignment: Literal["left", "center", "right"] = "center", ha: Literal["left", "center", "right"] = "center", verticalalignment: Literal["bottom", "center", "top"] = "center", va: Literal["bottom", "center", "top"] = "center", rotation: float = 0, label: Optional[str] = ...) -> None:
+        """
+        Add an annotation with optional arrow to the selected axis.
+
+        Parameters
+        ----------
+        text: str
+            Annotation text
+
+        xy: tuple of float
+            Point (x,y) to annotate in axis coordinates
+
+        xytext: tuple of float, optional
+            Position (x,y) of the text in axis coordinates. If not provided, only text will be displayed at specified location (same as using text() method).
+
+        arrowprops: dict, optional
+            Dictionary of properties for the arrow. If not provided, no arrow will be drawn. Possible keys include 'arrowstyle', 'color', 'c', 'linewidth', 'lw', 'linestyle', 'ls', 'alpha'. For 'arrowstyle', basic LaTeX arrow styles are allowed ('>', '<', '|', 'stealth', 'latex', etc., separated by '-' to indicate side). 
+
+        alpha: float, optional
+            Opacity
+
+        color or c: all matplotlib color formats (without X11/xkcd), optional
+            Text color: RGB/RGBA (tuple), HEX (str), grayscale (float), single-char (str), name (str), default cycle ("CX", X int), none for invisible
+
+        fontsize or size: FontSize, optional
+            Font size
+
+        backgroundcolor: all matplotlib color formats (without X11/xkcd), optional
+            Background color of text box: RGB/RGBA (tuple), HEX (str), grayscale (float), single-char (str), name (str), default cycle ("CX", X int), none for invisible
+
+        horizontalalignment or ha: {"center", "left", "right"}, optional
+            Horizontal alignment of text
+
+        verticalalignment or va: {"center", "top", "bottom"}, optional
+            Vertical alignment of text
+
+        rotation: float or {"vertical", "horizontal"}, optional
+            Rotation angle in degrees or preset rotation
+
+        label: str, optional
+            Legend entry
+        """
+        ...
+
     def hlines(
         self,
         y: Union[float, ArrayLike],
@@ -2094,6 +2139,12 @@ class BaseAxes:
         """
         ...
 
+    def set_axis_off(self) -> None:
+        """
+        Turn off axis (no ticks, no labels, no frame)
+        """
+        ...
+
     def _add_legend_entries(self) -> str: ...
     def _content_tex(self, filename: str) -> str: ...
     def _get_hard_range(self, which: Literal["xmin","xmax","ymin","ymax"]) -> Tuple[float,str]: ...

{tikzplot42-0.6.2 → tikzplot42-0.6.3}/src/tikzplot/axes3d.py

@@ -86,7 +86,6 @@ class Axes3:
             self._width= f"{self._fig._get_width() / ncols}cm"
         if self._fig._get_height():
             self._height = f"{self._fig._get_height() / nrows}cm"
-
         self._style_defaults()
 
     def _new_pos(self, nrows, ncols, index):
@@ -1020,14 +1019,26 @@ class Axes3:
         mode = "lin"
         if arg in self._axis_options:
             mode = self._axis_options[arg]
-        if which in self._axis_options:
-            for e in self._elements[self._get_overlay()]:
-                e._filter(which, self._axis_options[which])
+        common = self._get_all_elements().copy()
+        if which in self._axis_options and isinstance(self._axis_options[which], (int, float)):
+            other = which.replace("min", "max") if "min" in which else which.replace("max", "min")
+            if other in self._axis_options and (("min" in which and self._axis_options[which] > self._axis_options[other]) or ("max" in which and self._axis_options[which] < self._axis_options[other])):
+                for e in common:
+                    e._filter(other, self._axis_options[which])
+            else:
+                for e in common:
+                    e._filter(which, self._axis_options[which])
             return (self._axis_options[which], True, mode)
+        values = [e._get_erange(which) for e in common]
+        if which in self._preferred_lims:
+            values.append(self._preferred_lims[which])
+        values = [v for v in values if v is not None]
+        if not values:
+            return (None, False, mode)
         if "min" in which:
-            return (min([e._get_erange(which) for e in self._get_all_elements()]), False, mode)
-        return (max([e._get_erange(which) for e in self._get_all_elements()]), False, mode)
-    
+            return (min(values), False, mode)
+        return (max(values), False, mode) 
+       
     def _set_range(self, which, value):
         self._axis_options[which] = value
         for e in self._get_all_elements():
@@ -1100,6 +1111,9 @@ class Axes3:
     def set_minorticks_num(self, num):
         self._axis_options["minor tick num"] = num
 
+    def set_axis_off(self):
+        self._axis_options["hide axis"] = None
+
     def _axis_option_string(self):
         if self._extend:
             self._axis_options.pop("alias", self._axis_options.pop("name", None))

{tikzplot42-0.6.2 → tikzplot42-0.6.3}/src/tikzplot/axes3d.pyi

@@ -581,6 +581,12 @@ class Axes3:
         """
         ...
 
+    def set_axis_off(self) -> None:
+        """
+        Turn off the axis lines, ticks, and labels.
+        """
+        ...
+
     def _add_legend_entries(self) -> str: ...
     def _content_tex(self, filename: str) -> str: ...
     def _get_hard_range(self, which: Literal["xmin","xmax","ymin","ymax"]) -> Tuple[float,str]: ...

{tikzplot42-0.6.2 → tikzplot42-0.6.3}/src/tikzplot/figure.py

@@ -37,6 +37,7 @@ class Figure:
         self._num_coordinates = 0
 
         self._texts = []
+        self._arrows = []
 
         self._lims = {"xmin": {}, "xmax": {}, "ymin": {}, "ymax": {}, "zmin": {}, "zmax": {}}
 
@@ -628,6 +629,8 @@ class Figure:
             lines.append(spy)
         for text in self._texts:
             lines.append(text._to_tex_fin())
+        for arr in self._arrows:
+            lines.append(arr._to_tex_fin())
         for ext in self._external:
             lines.append(ext._to_tex())
         lines.append("\\end{tikzpicture}")
@@ -730,6 +733,9 @@ class Figure:
     def _add_text(self, text):
         self._texts.append(text)
 
+    def _add_arrow(self, arrow):
+        self._arrows.append(arrow)
+
     def tight_layout(self, h_pad=0, w_pad=0, rect=(0,0,1,1)):
         TikzConfig.SCALE_ONLY_AXIS = True
         if not TikzConfig.USE_GROUPPLOTS:

{tikzplot42-0.6.2 → tikzplot42-0.6.3}/src/tikzplot/latex_special.py

@@ -59,4 +59,4 @@ def tex_text(sa: str) -> str:
 
         i += 1
 
-    return "".join(out)
+    return "".join(out) if len(out) > 0 else ""

{tikzplot42-0.6.2 → tikzplot42-0.6.3}/src/tikzplot/plots.py

@@ -195,6 +195,11 @@ def text(*args, **kwargs):
     assert _current_axes
     return _current_axes.text(*args, **kwargs)
 
+def annotate(*args, **kwargs):
+    _ensure_axes()
+    assert _current_axes
+    return _current_axes.annotate(*args, **kwargs)
+
 def hlines(*args, **kwargs):
     _ensure_axes()
     assert _current_axes

{tikzplot42-0.6.2 → tikzplot42-0.6.3}/src/tikzplot/plots.pyi

@@ -754,7 +754,7 @@ def text(x: float, y: float, s: str, color: Optional[ColorLike] = ..., c: Option
         Text position in axis coordinates
     
     s: str
-        Text content (LaTeX format)
+        Text content
     
     color or c: all matplotlib color formats (without X11/xkcd), optional
         Text color: RGB/RGBA (tuple), HEX (str), grayscale (float), single-char (str), name (str), default cycle ("CX", X int), none for invisible
@@ -782,6 +782,50 @@ def text(x: float, y: float, s: str, color: Optional[ColorLike] = ..., c: Option
     """
     ...
 
+def annotate(self, text: str, xy: Tuple[float|int, float|int], xytext: Optional[Tuple[float|int, float|int]] = None, arrowprops: Optional[dict] = None, alpha: float = 1, color: Optional[ColorLike] = ..., c: Optional[ColorLike] = ..., fontsize: Optional[FontSize] = ..., size: Optional[FontSize] = ..., backgroundcolor: Optional[ColorLike] = ..., horizontalalignment: Literal["left", "center", "right"] = "center", ha: Literal["left", "center", "right"] = "center", verticalalignment: Literal["bottom", "center", "top"] = "center", va: Literal["bottom", "center", "top"] = "center", rotation: float = 0, label: Optional[str] = ...) -> None:
+    """
+    Add an annotation with optional arrow to the selected axis.
+
+    Parameters
+    ----------
+    text: str
+        Annotation text
+
+    xy: tuple of float
+        Point (x,y) to annotate in axis coordinates
+
+    xytext: tuple of float, optional
+        Position (x,y) of the text in axis coordinates. If not provided, only text will be displayed at specified location (same as using text() method).
+
+    arrowprops: dict, optional
+        Dictionary of properties for the arrow. If not provided, no arrow will be drawn. Possible keys include 'arrowstyle', 'color', 'c', 'linewidth', 'lw', 'linestyle', 'ls', 'alpha'. For 'arrowstyle', basic LaTeX arrow styles are allowed ('>', '<', '|', 'stealth', 'latex', etc., separated by '-' to indicate side). 
+
+    alpha: float, optional
+        Opacity
+
+    color or c: all matplotlib color formats (without X11/xkcd), optional
+        Text color: RGB/RGBA (tuple), HEX (str), grayscale (float), single-char (str), name (str), default cycle ("CX", X int), none for invisible
+
+    fontsize or size: FontSize, optional
+        Font size
+
+    backgroundcolor: all matplotlib color formats (without X11/xkcd), optional
+        Background color of text box: RGB/RGBA (tuple), HEX (str), grayscale (float), single-char (str), name (str), default cycle ("CX", X int), none for invisible
+
+    horizontalalignment or ha: {"center", "left", "right"}, optional
+        Horizontal alignment of text
+
+    verticalalignment or va: {"center", "top", "bottom"}, optional
+        Vertical alignment of text
+
+    rotation: float or {"vertical", "horizontal"}, optional
+        Rotation angle in degrees or preset rotation
+
+    label: str, optional
+        Legend entry
+    """
+    ...
+
 def loglog(x: ArrayLike = ..., y: ArrayLike = ..., base: Optional[float] = 10,  fmt: Optional[str] = ...,*, alpha: Optional[float] = ..., color: Optional[ColorLike] = ..., c: Optional[ColorLike] = ...,
              linestyle: Optional[LineStyle] = ..., ls: Optional[LineStyle] = ..., linewidth: Optional[float]= ..., lw: Optional[float] = ...,
              marker: Optional[MarkerStyle] = ..., markersize: Optional[float] = ..., ms: Optional[float] = ...) -> Graph:

{tikzplot42-0.6.2 → tikzplot42-0.6.3}/src/tikzplot/texts.py

@@ -1,4 +1,5 @@
 from .colors import _tex_color
+from .latex_special import tex_text
 
 class Text:
     def __init__(self, ax, x, y, coordinate, s, **kwargs):
@@ -6,7 +7,7 @@ class Text:
         self._x = x
         self._y = y
         self._coordinate = coordinate
-        self._s = s
+        self._s = tex_text(s)
         self._kwargs = kwargs
         self._color = False
         self._opacity = 1
@@ -14,7 +15,6 @@ class Text:
         self._label = kwargs.get("label", None)
         self._visible = True
 
-
     def match_color(self, input):
         self._has_color = True
         ccode, op = _tex_color(input)
@@ -71,7 +71,6 @@ class Text:
             output.insert(0,f"color={self._color}")
         return ", ".join(output)
 
-
     def _to_tex(self, *args, **kwargs):
         if self._visible:
             if self._coordinate is not None:
@@ -87,6 +86,7 @@ class Text:
                 return f"\\node[{self._style_string()}] at {self._coordinate} {{{self._fsize or ''}{self._s}}};"
         else:
             return ""
+        
     def _set_label(self, label):
         self._label = label
 

{tikzplot42-0.6.2 → tikzplot42-0.6.3}/src/tikzplot42.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tikzplot42
-Version: 0.6.2
+Version: 0.6.3
 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
@@ -764,6 +764,7 @@ Some basic plot commands are already implemented with commonly used arguments:
 - `imshow()`,
 - `matshow()`,
 - `text()`,
+- `annotate()`,
 - `bxp()` (without notches),
 - `boxplot()` (without notches),
 - `violin()`,

{tikzplot42-0.6.2 → tikzplot42-0.6.3}/src/tikzplot42.egg-info/SOURCES.txt

@@ -3,6 +3,7 @@ README.md
 pyproject.toml
 src/tikzplot/__init__.py
 src/tikzplot/__init__.pyi
+src/tikzplot/arrows.py
 src/tikzplot/axes.py
 src/tikzplot/axes.pyi
 src/tikzplot/axes3d.py

{tikzplot42-0.6.2 → tikzplot42-0.6.3}/tests/test7.py

@@ -27,6 +27,7 @@ ax.plot(x, y, color="blue", lw=1.5, label="sin(x)")
 ax.text(1.5, 0.5, r"text $\alpha$", color="blue", ha="center", on_top=False, va="center", backgroundcolor="cyan", rotation=30)
 ax.plot(x, y2, ls="--", color="red", label="cos(x)")
 ax.text(1.5, -0.5, r"text $\beta$", color="teal", ha="center", va="center", rotation=-70)
+ax.annotate(r"min", xy=(4.7, -1), xytext=(5, -0.5), arrowprops={"arrowstyle": "|-stealth", "color": "grey", "lw": 1.5}, c="cyan", va="bottom", rotation=-10)
 
 ax.grid()
 ax.legend(loc="upper right")