Merge pull request #9645 from yymao/patch-1

dopplershift · web-flow · commit 8acb14fce12d · 2018-01-03T14:01:35.000-06:00
expose Path.contains_points as a method of Patch
diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py
@@ -143,14 +143,30 @@ def contains(self, mouseevent, radius=None):
 
     def contains_point(self, point, radius=None):
         """
-        Returns *True* if the given point is inside the path
+        Returns ``True`` if the given *point* is inside the path
         (transformed with its transform attribute).
+
+        *radius* allows the path to be made slightly larger or smaller.
         """
         radius = self._process_radius(radius)
         return self.get_path().contains_point(point,
                                               self.get_transform(),
                                               radius)
 
+    def contains_points(self, points, radius=None):
+        """
+        Returns a bool array which is ``True`` if the (closed) path
+        contains the corresponding point.
+        (transformed with its transform attribute).
+
+        *points* must be Nx2 array.
+        *radius* allows the path to be made slightly larger or smaller.
+        """
+        radius = self._process_radius(radius)
+        return self.get_path().contains_points(points,
+                                               self.get_transform(),
+                                               radius)
+
     def update_from(self, other):
         """
         Updates this :class:`Patch` from the properties of *other*.
diff --git a/lib/matplotlib/tests/test_patches.py b/lib/matplotlib/tests/test_patches.py
@@ -386,3 +386,27 @@ def test_datetime_datetime_fails():
 
     with pytest.raises(TypeError):
         mpatches.Rectangle((0, start), 1, dt_delta)
+
+
+def test_contains_point():
+    ell = mpatches.Ellipse((0.5, 0.5), 0.5, 1.0, 0)
+    points = [(0.0, 0.5), (0.2, 0.5), (0.25, 0.5), (0.5, 0.5)]
+    path = ell.get_path()
+    transform = ell.get_transform()
+    radius = ell._process_radius(None)
+    expected = np.array([path.contains_point(point,
+                                             transform,
+                                             radius) for point in points])
+    result = np.array([ell.contains_point(point) for point in points])
+    assert np.all(result == expected)
+
+
+def test_contains_points():
+    ell = mpatches.Ellipse((0.5, 0.5), 0.5, 1.0, 0)
+    points = [(0.0, 0.5), (0.2, 0.5), (0.25, 0.5), (0.5, 0.5)]
+    path = ell.get_path()
+    transform = ell.get_transform()
+    radius = ell._process_radius(None)
+    expected = path.contains_points(points, transform, radius)
+    result = ell.contains_points(points)
+    assert np.all(result == expected)
