Nearest Points

APIs to compute the nearest points between geometries. More...

Files
file	nearest_points.hpp
file	nearest_points.cuh

Classes
struct	cuspatial::point_linestring_nearest_points_result
	Container for the result of pairwise_point_linestring_nearest_points More...

Functions
point_linestring_nearest_points_result	cuspatial::pairwise_point_linestring_nearest_points (std::optional< cudf::device_span< cudf::size_type const > > multipoint_geometry_offsets, cudf::column_view points_xy, std::optional< cudf::device_span< cudf::size_type const > > multilinestring_geometry_offsets, cudf::device_span< cudf::size_type const > linestring_part_offsets, cudf::column_view linestring_points_xy, rmm::device_async_resource_ref mr=rmm::mr::get_current_device_resource())
	Compute the nearest points and geometry ID between pairs of (multi)point and (multi)linestring.

Detailed Description

APIs to compute the nearest points between geometries.

Function Documentation

pairwise_point_linestring_nearest_points()

point_linestring_nearest_points_result cuspatial::pairwise_point_linestring_nearest_points	(	std::optional< cudf::device_span< cudf::size_type const > >	multipoint_geometry_offsets,
		cudf::column_view	points_xy,
		std::optional< cudf::device_span< cudf::size_type const > >	multilinestring_geometry_offsets,
		cudf::device_span< cudf::size_type const >	linestring_part_offsets,
		cudf::column_view	linestring_points_xy,
		rmm::device_async_resource_ref	mr = rmm::mr::get_current_device_resource() )

Compute the nearest points and geometry ID between pairs of (multi)point and (multi)linestring.

The nearest point from a test point to a linestring is a point on the linestring that has the shortest distance to the test point compared to any other points on the linestring.

The nearest point from a test multipoint to a multilinestring is the nearest point in the multilinestring that has the shortest distance between all pairs of points and linestrings.

Returns a structure of columns containing (for each pair) the ID to the nearest point in (multi)point, the ID to the linestring in the (multi)linestring, the ID to the segment in the linestring and the coordinate to the nearest point on the (multi)linestring. See point_linestring_nearest_points_result for detail.

The below example computes the nearest point from 2 points to 2 linestrings:

The first pair:
Point: (0.0, 0.0)
Linestring: (1.0, -1.0) -> (1.0, 0.0) -> (0.0, 1.0)
Nearest segment ID in linestring: 1
Nearest Point on LineString Coordinate: (0.5, 0.5)
 
The second pair:
Point: (1.0, 2.0)
Linestring: (0.0, 0.0) -> (3.0, 1.0) -> (3.9, 4) -> (5.5, 1.2)
Nearest segment ID in linestring: 0
Nearest Point on LineString Coordinate: (1.5, 0.5)
 
Input:
multipoint_parts_offsets: std::nullopt
points_xy: {0.0, 0.0, 1.0, 2.0}
multilinestring_parts_offsets: std::nullopt
linestring_offsets:  {0, 3, 7}
linestring_points_xy: {1, -1, 1, 0, 0, 1, 0, 0, 3, 1, 3.9, 4, 5.5, 1.2}
 
Output:
point_linestring_nearest_points_result{
  std::nullopt,
  std::nullopt,
  {1, 0},
  {0.5, 0.5, 1.5, 0.5}
}

The below example computes the nearest point from 3 multipoints to 3 multilinestrings:

The first pair:
MultiPoint: {(1.1, 3.0), (3.6, 2.4)}
MultiLineString: {(2.1, 3.14) -> (8.4, -0.5) -> (6.0, 1.4), (-1.0, 0.0) -> (-1.7, 0.83)}
Nearest Point ID in MultiPoint: 1
Nearest LineString ID in MultiLineString: 0
Nearest Segment ID in LineString: 0
Nearest Point on LineString Coordinate: (3.54513, 2.30503)
 
The second pair:
MultiPoint: {(10.0, 15.0)}
MultiLineString: {(20.14, 13.5) -> (18.3, 14.3), (8.34, 9.1) -> (9.9, 9.4)}
Nearest Point ID in MultiPoint: 0
Nearest LineString ID in MultiLineString: 1
Nearest Segment ID in LineString: 0
Nearest Point in LineString Coordinate: (9.9, 9.4)
 
The third pair:
MultiPoint: {(-5.0, -8.7), (-6.28, -7.0), (-10.0, -10.0)}
MultiLineString: {(-20.0, 0.0) -> (-15.0, -15.0) -> (0.0, -18.0) -> (0.0, 0.0)}
Nearest Point ID in MultiPoint: 0
Nearest LineString ID in MultiLineString: 0
Nearest Segment ID in LineString: 2
Nearest Point in LineString Coordinate: (0.0, -8.7)
 
Input:
multipoint_parts_offsets: {0, 2, 3, 6}
points_xy: {1.1, 3.0, 3.6, 2.4, 10.0, 15.0, -5.0, -8.7, -6.28, -7.0, -10.0, -10.0}
multilinestring_parts_offsets: {0, 2, 4, 5}
linestring_offsets:  {0, 3, 5, 7, 9, 13}
linestring_points_xy: {
  2.1, 3.14, 8.4, -0.5, 6.0, 1.4, -1.0, 0.0,
  -1.7, 0.83, 20.14, 13.5, 18.3, 14.3, 8.34, 9.1,
  9.9, 9.4, -20.0, 0.0, -15.0, -15.0, 0.0, -18.0,
  0.0, 0.0
}
 
Output:
point_linestring_nearest_points_result{
 {1, 0, 0},
 {0, 1, 0},
 {0, 0, 2},
 {3.545131432802666, 2.30503517215846, 9.9, 9.4, 0.0, -8.7}
}

Parameters

multipoint_geometry_offsets	Beginning and ending indices for each multipoint
points_xy	Interleaved x, y-coordinate of points
multilinestring_geometry_offsets	Beginning and ending indices for each multilinestring
linestring_part_offsets	Beginning and ending indices for each linestring
linestring_points_xy	Interleaved x, y-coordinates of the linestring points
mr	Device memory resource used to allocate the returned column.

Returns

point_linestring_nearest_points_result

Exceptions

cuspatial::logic_error	if points_xy or linestring_points_xy contains odd number of coordinates.
cuspatial::logic_error	if points_xy or linestring_points_xy are not floating point type.
cuspatial::logic_error	if the number of (multi)point(s) mismatch the number of (multi)linestring(s).
cuspatial::logic_error	if the type of point_xy and linestring_points_xy mismatch.
cuspatial::logic_error	if any of point_xy and linestring_points_xy contains null.