Point Cloud Library (PCL)  1.15.1-dev
Namespaces | Classes | Typedefs | Enumerations | Functions | Variables
pcl::search Namespace Reference

Namespaces

 internal
 

Classes

class  BruteForce
 Implementation of a simple brute force search algorithm. More...
 
class  FlannSearch
 search::FlannSearch is a generic FLANN wrapper class for the new search interface. More...
 
class  KdTree
 search::KdTree is a wrapper class which inherits the pcl::KdTree class for performing search functions using KdTree structure. More...
 
class  Octree
 search::Octree is a wrapper class which implements nearest neighbor search operations based on the pcl::octree::Octree structure. More...
 
class  OrganizedNeighbor
 OrganizedNeighbor is a class for optimized nearest neighbor search in organized projectable point clouds, for instance from Time-Of-Flight cameras or stereo cameras. More...
 
class  Search
 Generic search class. More...
 

Typedefs

using L1_Adaptor = nanoflann::L1_Adaptor< float, pcl::search::internal::PointCloudAdaptor< float >, float, pcl::index_t >
 
using L2_Adaptor = nanoflann::L2_Adaptor< float, pcl::search::internal::PointCloudAdaptor< float >, float, pcl::index_t >
 
using L2_Simple_Adaptor = nanoflann::L2_Simple_Adaptor< float, pcl::search::internal::PointCloudAdaptor< float >, float, pcl::index_t >
 
using SO2_Adaptor = nanoflann::SO2_Adaptor< float, pcl::search::internal::PointCloudAdaptor< float >, float, pcl::index_t >
 
using SO3_Adaptor = nanoflann::SO3_Adaptor< float, pcl::search::internal::PointCloudAdaptor< float >, float, pcl::index_t >
 

Enumerations

enum class  Purpose : std::uint32_t { undefined = 0 , radius_search = 1 , one_knn_search = 2 , many_knn_search = 4 }
 

Functions

template<typename PointT >
pcl::search::Search< PointT > * autoSelectMethod (const typename pcl::PointCloud< PointT >::ConstPtr &cloud, bool sorted_results, Purpose purpose=Purpose::undefined)
 Automatically select the fastest search method for the given point cloud. More...
 

Variables

template<typename PointT , std::int32_t Dim = 3, typename Distance = std::conditional_t<Dim >= 4, L2_Adaptor , L2_Simple_Adaptor >
 Tree
 

Typedef Documentation

◆ L1_Adaptor

using pcl::search::L1_Adaptor = typedef nanoflann::L1_Adaptor<float, pcl::search::internal::PointCloudAdaptor<float>, float, pcl::index_t>

Definition at line 111 of file kdtree_nanoflann.h.

◆ L2_Adaptor

using pcl::search::L2_Adaptor = typedef nanoflann::L2_Adaptor<float, pcl::search::internal::PointCloudAdaptor<float>, float, pcl::index_t>

Definition at line 116 of file kdtree_nanoflann.h.

◆ L2_Simple_Adaptor

using pcl::search::L2_Simple_Adaptor = typedef nanoflann::L2_Simple_Adaptor<float, pcl::search::internal::PointCloudAdaptor<float>, float, pcl::index_t>

Definition at line 121 of file kdtree_nanoflann.h.

◆ SO2_Adaptor

using pcl::search::SO2_Adaptor = typedef nanoflann::SO2_Adaptor<float, pcl::search::internal::PointCloudAdaptor<float>, float, pcl::index_t>

Definition at line 126 of file kdtree_nanoflann.h.

◆ SO3_Adaptor

using pcl::search::SO3_Adaptor = typedef nanoflann::SO3_Adaptor<float, pcl::search::internal::PointCloudAdaptor<float>, float, pcl::index_t>

Definition at line 131 of file kdtree_nanoflann.h.

Enumeration Type Documentation

◆ Purpose

enum pcl::search::Purpose : std::uint32_t
strong
Enumerator
undefined 

Default value, for general-purpose search method.

radius_search 

The search method will mainly be used for radiusSearch.

one_knn_search 

The search method will mainly be used for nearestKSearch where k is 1.

many_knn_search 

The search method will mainly be used for nearestKSearch where k is larger than 1.

Definition at line 17 of file auto.h.

Function Documentation

◆ autoSelectMethod()

template<typename PointT >
pcl::search::Search< PointT > * pcl::search::autoSelectMethod ( const typename pcl::PointCloud< PointT >::ConstPtr &  cloud,
bool  sorted_results,
Purpose  purpose = Purpose::undefined 
)

Automatically select the fastest search method for the given point cloud.

Make sure to delete the returned object after use!

Parameters
[in]cloudPoint cloud, this function will pass it to the search method via setInputCloud
[in]sorted_resultsWhether the search method should always return results sorted by distance (may be slower than unsorted)
[in]purposeOptional, can be used to give more information about what this search method will be used for, to achieve optimal performance

Definition at line 21 of file auto.hpp.

References pcl::utils::ignore(), pcl::PointCloud< PointT >::isOrganized(), one_knn_search, and pcl::search::Search< PointT >::setInputCloud().