Changed the rcParam option name from 'vector_graphics.combine_images' to 'image.combine_images', and updated the matplotlibrc.template.

breedlun · breedlun · commit b357367e2ac5 · 2015-02-27T10:08:09.000-07:00
Update the backend tests with the new rcParam name 'image.combine_images'

Added the rcParams 'pdf.combine_images', 'svg.combine_images', and
'ps.combine_images' to permit users to decide whether they want the
vector graphics backend to combine all images within a set of axes
into a single image.  (If images do not get combined, users can open
vector graphics files in Adobe Illustrator or Inkscape and edit each
image individually.)  Also changed 'renderer.option_nocomposite' to
the clearer name 'renderer.option_combine_images'.

Improved combine image tests to actually count the number of images in the vector graphics files.  Also replaced the rcParams 'pdf.combine_images', 'svg.combine_images', and 'ps.combine_images' with 'vector_backends.combine_images'

Corrected PEP8 coding standard violations

Updated 'combine_images' tests for PS and SVG backends to hopefully make them Python 3 compatible.

Fixed some PEP8 violations to leave the code cleaner than I found it.

Fixed PEP8 violations introduced in my effort to fix PEP8 violations in my last commit.

Changed the rcParam option name from 'vector_graphics.combine_images' to 'image.combine_images', and updated the matplotlibrc.template.

Update the backend tests with the new rcParam name 'image.combine_images'
diff --git a/CHANGELOG b/CHANGELOG
@@ -2,7 +2,7 @@
            corner masking.  This is controlled by the 'corner_mask' keyword
            in plotting commands 'contour' and 'contourf'. - IMT
 
-2015-01-31 Added the rcParam 'vector_backends.combine_images' to permit users 
+2015-01-31 Added the rcParam 'image.combine_images' to permit users 
 		   to decide whether they want the vector graphics backends to combine 
 		   all images within a set of axes into a single image.  (If images do 
 		   not get combined, users can open vector graphics files in Adobe 
diff --git a/lib/matplotlib/backends/backend_pdf.py b/lib/matplotlib/backends/backend_pdf.py
@@ -1582,7 +1582,7 @@ def option_combine_images(self):
         return whether to combine multiple images on a set of axes into one
         image
         """
-        return rcParams['vector_backends.combine_images']
+        return rcParams['image.combine_images']
 
     def draw_image(self, gc, x, y, im, dx=None, dy=None, transform=None):
         self.check_gc(gc)
diff --git a/lib/matplotlib/backends/backend_ps.py b/lib/matplotlib/backends/backend_ps.py
@@ -457,7 +457,7 @@ def option_combine_images(self):
         return whether to combine multiple images on a set of axes into one 
         image
         """
-        return rcParams['vector_backends.combine_images']
+        return rcParams['image.combine_images']
 
     def _get_image_h_w_bits_command(self, im):
         if im.is_grayscale:
diff --git a/lib/matplotlib/backends/backend_svg.py b/lib/matplotlib/backends/backend_svg.py
@@ -535,7 +535,7 @@ def option_combine_images(self):
         if rcParams['svg.image_noscale']:
             return False
         else:
-            return rcParams['vector_backends.combine_images']
+            return rcParams['image.combine_images']
 
     def _convert_path(self, path, transform=None, clip=None, simplify=None):
         if clip:
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -595,6 +595,9 @@ def __call__(self, s):
     'image.lut':           [256, validate_int],  # lookup table
     'image.origin':        ['upper', six.text_type],  # lookup table
     'image.resample':      [False, validate_bool],
+    # Force vector graphics backends to combine all images on a set of axes 
+    # into a single image
+    'image.combine_images': [True, validate_bool],
 
     # contour props
     'contour.negative_linestyle': ['dashed',
@@ -764,9 +767,7 @@ def __call__(self, s):
     # Maintain shell focus for TkAgg
     'tk.window_focus':  [False, validate_bool],
     'tk.pythoninspect': [False, validate_tkpythoninspect],  # obsolete
-    
-    # combine all images on a set of axes into a single image
-    'vector_backends.combine_images': [True, validate_bool],
+
     # Set the papersize/type
     'ps.papersize':     ['letter', validate_ps_papersize],
     'ps.useafm':        [False, validate_bool],  # Set PYTHONINSPECT
diff --git a/lib/matplotlib/tests/test_backend_pdf.py b/lib/matplotlib/tests/test_backend_pdf.py
@@ -99,11 +99,11 @@ def test_combine_images():
     ax.set_xlim(0, 3)
     ax.imshow(Z, extent=[0, 1, 0, 1])
     ax.imshow(Z[::-1], extent=[2, 3, 0, 1])
-    plt.rcParams['vector_backends.combine_images'] = True
+    plt.rcParams['image.combine_images'] = True
     with PdfPages(io.BytesIO()) as pdf:
         fig.savefig(pdf, format="pdf")
         assert len(pdf._file.images.keys()) == 1
-    plt.rcParams['vector_backends.combine_images'] = False
+    plt.rcParams['image.combine_images'] = False
     with PdfPages(io.BytesIO()) as pdf:
         fig.savefig(pdf, format="pdf")
         assert len(pdf._file.images.keys()) == 2
diff --git a/lib/matplotlib/tests/test_backend_ps.py b/lib/matplotlib/tests/test_backend_ps.py
@@ -97,13 +97,13 @@ def test_combine_images():
     ax.set_xlim(0, 3)
     ax.imshow(Z, extent=[0, 1, 0, 1])
     ax.imshow(Z[::-1], extent=[2, 3, 0, 1])
-    plt.rcParams['vector_backends.combine_images'] = True
+    plt.rcParams['image.combine_images'] = True
     with io.BytesIO() as ps:
         fig.savefig(ps, format="ps")
         ps.seek(0)
         buff = ps.read()
         assert buff.count(six.b(' colorimage')) == 1
-    plt.rcParams['vector_backends.combine_images'] = False
+    plt.rcParams['image.combine_images'] = False
     with io.BytesIO() as ps:
         fig.savefig(ps, format="ps")
         ps.seek(0)
diff --git a/lib/matplotlib/tests/test_backend_svg.py b/lib/matplotlib/tests/test_backend_svg.py
@@ -66,13 +66,13 @@ def test_combine_images():
     ax.set_xlim(0, 3)
     ax.imshow(Z, extent=[0, 1, 0, 1])
     ax.imshow(Z[::-1], extent=[2, 3, 0, 1])
-    plt.rcParams['vector_backends.combine_images'] = True
+    plt.rcParams['image.combine_images'] = True
     with BytesIO() as svg:
         fig.savefig(svg, format="svg")
         svg.seek(0)
         buff = svg.read()
         assert buff.count(six.b('<image ')) == 1
-    plt.rcParams['vector_backends.combine_images'] = False
+    plt.rcParams['image.combine_images'] = False
     with BytesIO() as svg:
         fig.savefig(svg, format="svg")
         svg.seek(0)
diff --git a/matplotlibrc.template b/matplotlibrc.template
@@ -358,6 +358,10 @@ backend      : %(backend)s
 #image.lut    : 256               # the size of the colormap lookup table
 #image.origin : upper             # lower | upper
 #image.resample  : False
+#image.combine_images : True      # When True, all the images on a set of axes 
+                                  # are combined into a single image before 
+                                  # saving a figure as a vector graphics file, 
+                                  # such as a PDF.
 
 ### CONTOUR PLOTS
 #contour.negative_linestyle : dashed # dashed | solid
