Merge pull request #163 from danielhkl/master

extra_axis_parameters and extra_tikzpicture_parameters

Author: nschloe

matplotlib2tikz/image.py

@@ -27,13 +27,13 @@ def draw_image(data, obj):
     # store the image as in a file
     img_array = obj.get_array()
 
+    if obj.origin == "lower":
+        img_array = numpy.flipud(img_array)
+
     dims = img_array.shape
     if len(dims) == 2:  # the values are given as one real number: look at cmap
         clims = obj.get_clim()
 
-        if obj.origin == "lower":
-            img_array = numpy.flipud(img_array)
-
         mpl.pyplot.imsave(fname=filename,
                           arr=img_array,
                           cmap=obj.get_cmap(),
@@ -44,9 +44,9 @@ def draw_image(data, obj):
     else:
         # RGB (+alpha) information at each point
         assert len(dims) == 3 and dims[2] in [3, 4]
-        # convert to PIL image (after upside-down flip)
-        image = PIL.Image.fromarray(numpy.flipud(img_array))
-        image.save(filename)
+        # convert to PIL image
+        image = PIL.Image.fromarray(img_array)
+        image.save(filename, origin=obj.origin)
 
     # write the corresponding information to the TikZ file
     extent = obj.get_extent()

matplotlib2tikz/save.py

@@ -26,10 +26,11 @@ def get_tikz_code(
         tex_relative_path_to_data=None,
         strict=False,
         wrap=True,
-        extra=None,
+        extra_axis_parameters=None,
+        extra_tikzpicture_parameters=None,
         dpi=None,
         show_info=True
-        ):
+):
     '''Main function. Here, the recursion into the image starts and the
     contents are picked up. The actual file gets written in this routine.
 
@@ -83,9 +84,15 @@ def get_tikz_code(
                  Default is ``True``.
     :type wrap: bool
 
-    :param extra: Extra axis options to be passed (as a set) to pgfplots.
-                  Default is ``None``.
-    :type extra: a set of strings for the pfgplots axes.
+    :param extra_axis_parameters: Extra axis options to be passed (as a set)
+                                    to pgfplots. Default is ``None``.
+    :type extra_axis_parameters: a set of strings for the pfgplots axes.
+
+    :param extra_tikzpicture_parameters: Extra tikzpicture options to be passed
+                                        (as a set) to pgfplots.
+
+    :type extra_tikzpicture_parameters: a set of strings for the pfgplots
+                                        tikzpicture.
 
     :param dpi: The resolution in dots per inch of the rendered image in case
                 of QuadMesh plots. If ``None`` it will default to the value
@@ -117,12 +124,13 @@ def get_tikz_code(
     data['pgfplots libs'] = set()
     data['font size'] = textsize
     data['custom colors'] = {}
+    data['extra tikzpicture parameters'] = extra_tikzpicture_parameters
     # rectangle_legends is used to keep track of which rectangles have already
     # had \addlegendimage added. There should be only one \addlegenimage per
     # bar chart data series.
     data['rectangle_legends'] = set()
-    if extra:
-        data['extra axis options [base]'] = extra.copy()
+    if extra_axis_parameters:
+        data['extra axis options [base]'] = extra_axis_parameters.copy()
     else:
         data['extra axis options [base]'] = set()
 
@@ -152,6 +160,9 @@ def get_tikz_code(
     # write the contents
     if wrap:
         code += '\\begin{tikzpicture}\n\n'
+        if extra_tikzpicture_parameters:
+            code += ',\n'.join(data['extra tikzpicture parameters'])
+            code += '\n'
 
     coldefs = _get_color_definitions(data)
     if coldefs:
@@ -255,7 +266,7 @@ def _recurse(data, obj):
     content = _ContentManager()
     for child in obj.get_children():
         if isinstance(child, mpl.axes.Axes):
-            # Reset 'extra axis options' for every new Axes environment.
+            # Reset 'extra axis parameters' for every new Axes environment.
             data['extra axis options'] = \
                 data['extra axis options [base]'].copy()
 

test/helpers.py

@@ -3,6 +3,7 @@
 import matplotlib2tikz
 
 import os
+import shutil
 import tempfile
 import subprocess
 from PIL import Image
@@ -93,6 +94,9 @@ def assert_phash(fig, reference_phash):
         compute_phash(fig)
 
     if reference_phash != phash:
+        # Copy pdf_file in test directory
+        shutil.copy(pdf_file, os.path.dirname(os.path.abspath(__file__)))
+
         # Compute the Hamming distance between the two 64-bit numbers
         hamming_dist = \
             bin(int(phash, 16) ^ int(reference_phash, 16)).count('1')

test/test_image_plot.py

@@ -1,30 +1,61 @@
 # -*- coding: utf-8 -*-
 #
 import helpers
+from matplotlib import rcParams
+from matplotlib import pyplot as pp
+import pytest
+import os
 
+try:
+    from PIL import Image
+except ImportError:
+    raise RuntimeError('PIL must be installed to run this example')
 
-def plot():
-    from matplotlib import rcParams
-    from matplotlib import pyplot as pp
-    import os
-    try:
-        from PIL import Image
-    except ImportError:
-        raise RuntimeError('PIL must be installed to run this example')
+# the picture 'lena.png' with origin='lower' is flipped upside-down.
+# So it has to be upside-down in the pdf-file as well.
+
+
+# test for monochrome picture
+def plot1():
 
     this_dir = os.path.dirname(os.path.realpath(__file__))
     lena = Image.open(os.path.join(this_dir, 'lena.png'))
+    lena = lena.convert('L')
     dpi = rcParams['figure.dpi']
     figsize = lena.size[0]/dpi, lena.size[1]/dpi
     fig = pp.figure(figsize=figsize)
     ax = pp.axes([0, 0, 1, 1], frameon=False)
     ax.set_axis_off()
-    pp.imshow(lena, origin='lower')
+    pp.imshow(lena, cmap='viridis', origin='lower')
+    # Set the current color map to HSV.
+    pp.hsv()
+    pp.colorbar()
+    return fig
+
+
+# test for rgb picture
+def plot2():
+
+    this_dir = os.path.dirname(os.path.realpath(__file__))
+    lena = Image.open(os.path.join(this_dir, 'lena.png'))
+    dpi = rcParams['figure.dpi']
+    figsize = lena.size[0] / dpi, lena.size[1] / dpi
+    fig = pp.figure(figsize=figsize)
+    ax = pp.axes([0, 0, 1, 1], frameon=False)
+    ax.set_axis_off()
+    pp.imshow(lena, cmap='viridis', origin='lower')
     # Set the current color map to HSV.
     pp.hsv()
     pp.colorbar()
     return fig
 
 
-def test():
-    helpers.assert_phash(plot(), '7558d3b30f634b06')
+@pytest.mark.parametrize(
+    'plot, phash', [
+        (plot1, '455361ec211d72fb'),
+        (plot2, '7558d3b30f634b06'),
+    ]
+    )
+def test(plot, phash):
+    helpers.assert_phash(plot(), phash)
+    return

test/test_rotated_labels.py

@@ -62,7 +62,7 @@ def test_rotated_labels_parameters(x_alignment, y_alignment,
     matplotlib2tikz.save(
         tikz_file,
         figurewidth='7.5cm',
-        extra=extra_dict
+        extra_axis_parameters=extra_dict
         )
 
     # close figure
@@ -101,7 +101,7 @@ def test_rotated_labels_parameters_different_values(x_tick_label_width,
     matplotlib2tikz.save(
         tikz_file,
         figurewidth='7.5cm',
-        extra=extra_dict
+        extra_axis_parameters=extra_dict
         )
 
     # close figure