Nearest neighbor search interface. More...

Inheritance diagram for gtsam_points::NearestNeighborSearch:

[legend]

Public Types
using	Ptr = std::shared_ptr< NearestNeighborSearch >

using	ConstPtr = std::shared_ptr< const NearestNeighborSearch >

Public Member Functions
virtual size_t	knn_search (const double pt, size_t k, size_t k_indices, double *k_sq_dists, double max_sq_dist=std::numeric_limits< double >::max()) const
	k-nearest neighbor search

virtual size_t	radius_search (const double *pt, double radius, std::vector< size_t > &indices, std::vector< double > &sq_dists, int max_num_neighbors=std::numeric_limits< int >::max()) const
	Radius search.

Detailed Description

Nearest neighbor search interface.

Member Function Documentation

virtual size_t gtsam_points::NearestNeighborSearch::knn_search	(	const double *	pt,
		size_t	k,
		size_t *	k_indices,
		double *	k_sq_dists,
		double	max_sq_dist = `std::numeric_limits<double>::max()`
	)		const

inlinevirtual

k-nearest neighbor search

Parameters

pt	Point
k	Number of neighbors
k_indices	Indices of k-nearest neighbors
k_sq_dists	Squared distances to the neighbors (sorted in ascending order)

virtual size_t gtsam_points::NearestNeighborSearch::radius_search	(	const double *	pt,
		double	radius,
		std::vector< size_t > &	indices,
		std::vector< double > &	sq_dists,
		int	max_num_neighbors = `std::numeric_limits<int>::max()`
	)		const

inlinevirtual

Radius search.

Note: There is no assumption and guarantee on the order of points to be selected when max_num_neighbors is specified. (Some algorithms like KdTree tend to first pick closer points though).

Parameters

pt	Point
radius	Search radius
indices	Indices of neighbors within the radius
sq_dists	Squared distances to the neighbors (sorted in ascending order)
max_num_neighbors	Maximum number of neighbors

The documentation for this struct was generated from the following file:

/home/runner/work/gtsam_points/gtsam_points/include/gtsam_points/ann/nearest_neighbor_search.hpp