scikit-spatial 7.1.0__tar.gz → 7.2.0__tar.gz

{scikit_spatial-7.1.0 → scikit_spatial-7.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scikit-spatial
-Version: 7.1.0
+Version: 7.2.0
 Summary: Spatial objects and computations based on NumPy arrays.
 Home-page: https://github.com/ajhynes7/scikit-spatial
 License: BSD-3-Clause

{scikit_spatial-7.1.0 → scikit_spatial-7.2.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 
 name = "scikit-spatial"
-version = "7.1.0"
+version = "7.2.0"
 description = "Spatial objects and computations based on NumPy arrays."
 license = "BSD-3-Clause"
 

{scikit_spatial-7.1.0 → scikit_spatial-7.2.0}/src/skspatial/__init__.py

@@ -1,7 +1,12 @@
 """Top-level package for scikit-spatial."""
 
-import importlib.metadata as importlib_metadata  # type: ignore
-
 __author__ = "Andrew Hynes"
 __email__ = "andrewjhynes@gmail.com"
+
+try:
+    import importlib.metadata as importlib_metadata  # type: ignore
+
+except ModuleNotFoundError:
+    import importlib_metadata  # type: ignore
+
 __version__ = importlib_metadata.version("scikit-spatial")

{scikit_spatial-7.1.0 → scikit_spatial-7.2.0}/src/skspatial/objects/line.py

@@ -302,6 +302,46 @@ class Line(_BaseLinePlane):
         # Add the projected vector to the point on the line.
         return self.point + vector_projected
 
+    def project_points(self, points: array_like) -> Points:
+        """
+        Project multiple points onto the line.
+
+        Parameters
+        ----------
+        points : array_like
+            Input points.
+
+        Returns
+        -------
+        Points
+            Projection of the points onto the line.
+
+        Examples
+        --------
+        >>> from skspatial.objects import Line
+
+        >>> line = Line([0, 0], [0, 1])
+        >>> line.project_points([[0, 5], [1,5], [0, 1], [1, 0], [0, 2], [-15, 5], [ 50, 10]])
+        Points([[ 0.,  5.],
+                [ 0.,  5.],
+                [ 0.,  1.],
+                [ 0.,  0.],
+                [ 0.,  2.],
+                [ 0.,  5.],
+                [ 0., 10.]])
+
+        """
+        # Vectors from the points on the line to the point in space.
+        vectors = np.subtract(points, self.point)
+
+        # Project the vectors onto the line.
+        dot_products = np.dot(vectors, self.direction.unit())
+        
+        # Add the projected vector to the point on the line.
+        projected_points = Points(dot_products[:, np.newaxis] * self.direction.unit() + self.point)
+
+        return projected_points
+
     def project_vector(self, vector: array_like) -> Vector:
         """
         Project a vector onto the line.
@@ -409,6 +449,43 @@ class Line(_BaseLinePlane):
 
         return point_projected.distance_point(point)
 
+    def distance_points(self, points: array_like) -> np.ndarray:
+        """
+        Return the distances from points to the line.
+
+        These are the distances from the points to their projections on the line.
+
+        Parameters
+        ----------
+        points : array_like
+            Input points.
+
+        Returns
+        -------
+        np.ndarray
+            Distances from the points to the line.
+
+        Examples
+        --------
+        >>> import numpy as np
+        >>> from skspatial.objects import Line
+
+        >>> line = Line([0, 0], [0, 1])
+        >>> line.distance_points([[0, 5], [1,5], [0, 1], [1, 0], [0, 2], [-15, 5], [ 50, 10]])
+        array([ 0.,  1.,  0.,  1.,  0., 15., 50.])
+
+        >>> line = Line([0, 0, 0], [0, 0, 1])
+        >>> points = Points([[14, -8, 19], [16, 15, 11], [11, 19, 13], [-1,-18, 8], [-17, 1, 11]])
+        >>> np.round(line.distance_points(points), 3)
+        array([16.125, 21.932, 21.954, 18.028, 17.029])
+
+        """
+        projected_points = self.project_points(points)
+        
+        distances = np.linalg.norm(points - projected_points, axis=1)
+        
+        return distances
+
     def distance_line(self, other: Line) -> np.float64:
         """
         Return the shortest distance from the line to another.

{scikit_spatial-7.1.0 → scikit_spatial-7.2.0}/src/skspatial/objects/plane.py

@@ -273,6 +273,37 @@ class Plane(_BaseLinePlane, _ToPointsMixin):
 
         return Point(point) + vector_projected
 
+    def project_points(self, points: array_like) -> Points:
+        """
+        Project multiple points onto the plane.
+
+        Parameters
+        ----------
+        points : array_like
+            Input points.
+
+        Returns
+        -------
+        Points
+            Projections of the points onto the plane.
+
+        Examples
+        --------
+        >>> from skspatial.objects import Plane
+
+        >>> plane = Plane(point=[0, 0, 0], normal=[0, 0, 2])
+
+        >>> plane.project_points([[10, 2, 5],[1, 2, 3]])
+        Points([[10.,  2.,  0.],
+                [ 1.,  2.,  0.]])
+
+        """
+        vectors = np.subtract(self.point, points)
+
+        dot_products =  np.dot(vectors, self.normal.unit())
+
+        return Points(dot_products[:, np.newaxis] * self.normal.unit() + points)
+
     def project_vector(self, vector: array_like) -> Vector:
         """
         Project a vector onto the plane.
@@ -392,6 +423,38 @@ class Plane(_BaseLinePlane, _ToPointsMixin):
 
         return self.normal.scalar_projection(vector_to_point)
 
+    def distance_points_signed(self, points: array_like) -> np.ndarray:
+        """
+        Return the signed distances from multiple points to the plane.
+
+        Parameters
+        ----------
+        points : array_like
+            Input points.
+
+        Returns
+        -------
+        np.ndarray
+            Signed distances from the points to the plane.
+
+        References
+        ----------
+        http://mathworld.wolfram.com/Point-PlaneDistance.html
+
+        Examples
+        --------
+        >>> from skspatial.objects import Plane
+
+        >>> plane = Plane([0, 0, 0], [0, 0, 1])
+
+        >>> plane.distance_points_signed([[5, 2, 0], [5, 2, 1], [5, 2, -4], [5, 2, -4]])
+        array([ 0.,  1., -4., -4.])
+
+        """
+        vectors = np.subtract(points, self.point)
+
+        return np.array(np.dot(vectors, self.normal.unit()))
+
     def distance_point(self, point: array_like) -> np.float64:
         """
         Return the distance from a point to the plane.
@@ -428,6 +491,36 @@ class Plane(_BaseLinePlane, _ToPointsMixin):
         """
         return abs(self.distance_point_signed(point))
 
+    def distance_points(self, point: array_like) -> np.ndarray:
+        """
+        Return the distances from multiple points to the plane.
+
+        Parameters
+        ----------
+        points : array_like
+            Input points.
+
+        Returns
+        -------
+        np.ndarray
+            Distances from the points to the plane.
+
+        References
+        ----------
+        http://mathworld.wolfram.com/Point-PlaneDistance.html
+
+        Examples
+        --------
+        >>> from skspatial.objects import Plane
+
+        >>> plane = Plane([0, 0, 0], [0, 0, 1])
+
+        >>> plane.distance_points([[5, 2, 0], [5, 2, 1], [5, 2, -4], [5, 2, -4]])
+        array([0., 1., 4., 4.])
+
+        """
+        return np.abs(self.distance_points_signed(point))
+
     def side_point(self, point: array_like) -> int:
         """
         Find the side of the plane where a point lies.