Merge pull request #275 from nschloe/annotations

Annotations

Author: nschloe

matplotlib2tikz/axes.py

@@ -36,18 +36,19 @@ def __init__(self, data, obj):
 
         # get plot title
         title = obj.get_title()
+        data["current axis title"] = title
         if title:
-            self.axis_options.append("title={{{}}}".format(title))
+            self.axis_options.append(u"title={{{}}}".format(title))
 
         # get axes titles
         xlabel = obj.get_xlabel()
         if xlabel:
             xlabel = mpl_backend_pgf.common_texification(xlabel)
-            self.axis_options.append("xlabel={{{}}}".format(xlabel))
+            self.axis_options.append(u"xlabel={{{}}}".format(xlabel))
         ylabel = obj.get_ylabel()
         if ylabel:
             ylabel = mpl_backend_pgf.common_texification(ylabel)
-            self.axis_options.append("ylabel={{{}}}".format(ylabel))
+            self.axis_options.append(u"ylabel={{{}}}".format(ylabel))
 
         # Axes limits.
         # Sort the limits so make sure that the smaller of the two is actually

matplotlib2tikz/save.py

@@ -18,7 +18,7 @@
 from . import quadmesh as qmsh
 from . import path
 from . import patch
-from . import text as mytext
+from . import text
 
 from .__about__ import __version__
 
@@ -223,7 +223,6 @@ def get_tikz_code(
 \\usepackage[utf8]{{inputenc}}
 \\usepackage{{pgfplots}}
 \\usepgfplotslibrary{{groupplots}}
-\\usetikzlibrary{{shapes.arrows}}
 \\pgfplotsset{{compat=newest}}
 \\begin{{document}}
 {}
@@ -277,7 +276,7 @@ def _print_pgfplot_libs_message(data):
     pgfplotslibs = ",".join(list(data["pgfplots libs"]))
     tikzlibs = ",".join(list(data["tikz libs"]))
 
-    print("=========================================================")
+    print(70 * "=")
     print("Please add the following lines to your LaTeX preamble:\n")
     print("\\usepackage[utf8]{inputenc}")
     print("\\usepackage{fontspec}  % This line only for XeLaTeX and LuaLaTeX")
@@ -286,7 +285,7 @@ def _print_pgfplot_libs_message(data):
         print("\\usetikzlibrary{" + tikzlibs + "}")
     if pgfplotslibs:
         print("\\usepgfplotslibrary{" + pgfplotslibs + "}")
-    print("=========================================================")
+    print(70 * "=")
     return
 
 
@@ -360,9 +359,6 @@ def _recurse(data, obj):
         elif isinstance(child, mpl.image.AxesImage):
             data, cont = img.draw_image(data, child)
             content.extend(cont, child.get_zorder())
-            # # Really necessary?
-            # data, children_content = _recurse(data, child)
-            # content.extend(children_content)
         elif isinstance(child, mpl.patches.Patch):
             data, cont = patch.draw_patch(data, child)
             content.extend(cont, child.get_zorder())
@@ -384,19 +380,15 @@ def _recurse(data, obj):
             data = legend.draw_legend(data, child)
             if data["legend colors"]:
                 content.extend(data["legend colors"], 0)
-        elif isinstance(
-            child, (mpl.axis.XAxis, mpl.axis.YAxis, mpl.spines.Spine, mpl.text.Text)
-        ):
+        elif isinstance(child, (mpl.text.Text, mpl.text.Annotation)):
+            data, cont = text.draw_text(data, child)
+            content.extend(cont, child.get_zorder())
+        elif isinstance(child, (mpl.axis.XAxis, mpl.axis.YAxis, mpl.spines.Spine)):
             pass
         else:
             warnings.warn(
                 "matplotlib2tikz: Don't know how to handle object {}.".format(
                     type(child)
                 )
             )
-    # XXX: This is ugly
-    if isinstance(obj, (mpl.axes.Subplot, mpl.figure.Figure)):
-        for text in obj.texts:
-            data, cont = mytext.draw_text(data, text)
-            content.extend(cont, text.get_zorder())
     return data, content.flatten()

matplotlib2tikz/text.py

@@ -21,6 +21,12 @@ def draw_text(data, obj):
     #                   -------1--------2---3--4--
     pos = obj.get_position()
     text = obj.get_text()
+
+    if text in ["", data["current axis title"]]:
+        # Text nodes which are direct children of Axes are typically titles.  They are
+        # already captured by the `title` property of pgfplots axes, so skip them here.
+        return data, content
+
     size = obj.get_size()
     bbox = obj.get_bbox_patch()
     converter = mpl.colors.ColorConverter()
@@ -109,8 +115,8 @@ def draw_text(data, obj):
         text = text.replace("\n ", "\\\\")
 
     content.append(
-        "\\node at {}[\n  {}\n]{{{} {}}};\n".format(
-            tikz_pos, ",\n  ".join(properties), " ".join(style), text
+        "\\node at {}[\n  {}\n]{{{}}};\n".format(
+            tikz_pos, ",\n  ".join(properties), " ".join(style + [text])
         )
     )
     return data, content
@@ -144,11 +150,27 @@ def _annotation(obj, data, content):
         )
         return data, content
     else:  # Create a basic tikz arrow
+        arrow_translate = {
+            "-": ["-"],
+            "->": ["->"],
+            "<-": ["<-"],
+            "<->": ["<->"],
+            "|-|": ["|-|"],
+            "-|>": ["-latex"],
+            "<|-": ["latex-"],
+            "<|-|>": ["latex-latex"],
+            "]-[": ["|-|"],
+            "-[": ["-|"],
+            "]-": ["|-"],
+            "fancy": ["-latex", "very thick"],
+            "simple": ["-latex", "very thick"],
+            "wedge": ["-latex", "very thick"],
+        }
         arrow_style = []
         if obj.arrowprops is not None:
             if obj.arrowprops["arrowstyle"] is not None:
-                if obj.arrowprops["arrowstyle"] in ["-", "->", "<-", "<->"]:
-                    arrow_style.append(obj.arrowprops["arrowstyle"])
+                if obj.arrowprops["arrowstyle"] in arrow_translate:
+                    arrow_style += arrow_translate[obj.arrowprops["arrowstyle"]]
                     data, col, _ = color.mpl_color2xcolor(
                         data, obj.arrow_patch.get_ec()
                     )

test/helpers.py

@@ -44,11 +44,11 @@ def assert_equality(plot, filename):
     assert reference == code, _unidiff_output(reference, code)
 
     code = matplotlib2tikz.get_tikz_code(include_disclaimer=False, standalone=True)
-    assert _does_compile(code)
+    assert _compile(code) is not None
     return
 
 
-def _does_compile(code):
+def _compile(code):
     _, tmp_base = tempfile.mkstemp()
 
     tex_file = tmp_base + ".tex"
@@ -65,12 +65,33 @@ def _does_compile(code):
             stderr=subprocess.STDOUT,
         )
     except subprocess.CalledProcessError as e:
-        print("Command output:")
+        print("pdflatex output:")
         print("=" * 70)
-        print(e.output)
+        print(e.output.decode("utf-8"))
         print("=" * 70)
-        does_compile = False
+        output_pdf = None
     else:
-        does_compile = True
+        output_pdf = tmp_base + ".pdf"
 
-    return does_compile
+    return output_pdf
+
+
+def compare_mpl_latex(plot):
+    plot()
+    code = matplotlib2tikz.get_tikz_code(standalone=True)
+    directory = os.getcwd()
+    filename = "test-0.png"
+    plt.savefig(filename)
+    plt.close()
+
+    pdf_file = _compile(code)
+    pdf_dirname = os.path.dirname(pdf_file)
+
+    # Convert PDF to PNG.
+    subprocess.check_output(
+        ["pdftoppm", "-r", "1000", "-png", pdf_file, "test"], stderr=subprocess.STDOUT
+    )
+    png_path = os.path.join(pdf_dirname, "test-1.png")
+
+    os.rename(png_path, os.path.join(directory, "test-1.png"))
+    return

test/test_annotate.py

@@ -34,3 +34,10 @@ def plot():
 def test():
     assert_equality(plot, "test_annotate_reference.tex")
     return
+
+
+if __name__ == "__main__":
+    import helpers
+
+    # helpers.compare_mpl_latex(plot)
+    helpers.print_tree(plot())

test/test_annotate_reference.tex

@@ -42,13 +42,13 @@
   anchor=base west,
   text=black,
   rotate=0.0
-]{ text};
+]{text};
 \node at (axis cs:-50,30)[
   scale=0.5,
   anchor=base west,
   text=black,
   rotate=0.0
-]{ arrowstyle};
+]{arrowstyle};
 \end{axis}
 
 \end{tikzpicture}

test/test_arrows.py

@@ -0,0 +1,76 @@
+# -*- coding: utf-8 -*-
+#
+import matplotlib.patches as mpatches
+import matplotlib.pyplot as plt
+
+
+# https://matplotlib.org/examples/pylab_examples/fancyarrow_demo.html
+def plot():
+    styles = mpatches.ArrowStyle.get_styles()
+
+    ncol = 2
+    nrow = (len(styles) + 1) // ncol
+    figheight = nrow + 0.5
+    fig1 = plt.figure(1, (4.0 * ncol / 1.5, figheight / 1.5))
+    fontsize = 0.2 * 70
+
+    ax = fig1.add_axes([0, 0, 1, 1], frameon=False, aspect=1.0)
+
+    ax.set_xlim(0, 4 * ncol)
+    ax.set_ylim(0, figheight)
+
+    def to_texstring(s):
+        s = s.replace("<", r"$<$")
+        s = s.replace(">", r"$>$")
+        s = s.replace("|", r"$|$")
+        return s
+
+    for i, (stylename, styleclass) in enumerate(sorted(styles.items())):
+        x = 3.2 + (i // nrow) * 4
+        y = figheight - 0.7 - i % nrow  # /figheight
+        p = mpatches.Circle((x, y), 0.2)
+        ax.add_patch(p)
+
+        ax.annotate(
+            to_texstring(stylename),
+            (x, y),
+            (x - 1.2, y),
+            # xycoords="figure fraction", textcoords="figure fraction",
+            ha="right",
+            va="center",
+            size=fontsize,
+            arrowprops=dict(
+                arrowstyle=stylename,
+                patchB=p,
+                shrinkA=5,
+                shrinkB=5,
+                fc="k",
+                ec="k",
+                connectionstyle="arc3,rad=-0.05",
+            ),
+            bbox=dict(boxstyle="square", fc="w"),
+        )
+
+    ax.xaxis.set_visible(False)
+    ax.yaxis.set_visible(False)
+    return plt.gcf()
+
+
+# if __name__ == "__main__":
+#     import helpers
+#
+#     # fig = plot()
+#     # helpers.print_tree(fig)
+#     # plt.show()
+#
+#     plot()
+#     import matplotlib2tikz
+#     code = matplotlib2tikz.get_tikz_code(include_disclaimer=False, standalone=True)
+#     plt.close()
+#     helpers._does_compile(code)
+
+if __name__ == "__main__":
+    import helpers
+
+    helpers.compare_mpl_latex(plot)
+    # helpers.print_tree(plot())