pcl::search::KdTree — PointCloudLibrary

search::KdTree — это класс-обертка, наследующий класс pcl::KdTree для выполнения функций поиска с использованием структуры KdTree. Подробнее...

#include <pcl/search/kdtree.h>

Общедоступные типы
using	PointCloud = typename Search< PointT >::PointCloud
using	PointCloudConstPtr = typename Search< PointT >::PointCloudConstPtr
using	Ptr = shared_ptr< KdTree< PointT, Tree > >
using	ConstPtr = shared_ptr< const KdTree< PointT, Tree > >
using	KdTreePtr = typename Tree::Ptr
using	KdTreeConstPtr = typename Tree::ConstPtr
using	PointRepresentationConstPtr = typename PointRepresentation< PointT >::ConstPtr
Общедоступные типы, унаследованные от pcl::search::Search< PointT >
using	PointCloud = pcl::PointCloud< PointT >
using	PointCloudPtr = typename PointCloud::Ptr
using	PointCloudConstPtr = typename PointCloud::ConstPtr
using	Ptr = shared_ptr< pcl::search::Search< PointT > >
using	ConstPtr = shared_ptr< const pcl::search::Search< PointT > >
using	IndicesPtr = pcl::IndicesPtr
using	IndicesConstPtr = pcl::IndicesConstPtr

Открытые функции-члены
	KdTree (bool sorted=true)
	Конструктор KdTree. Подробнее...
	~KdTree () override=default
	Деструктор KdTree. Подробнее...
void	setPointRepresentation (const PointRepresentationConstPtr &point_representation)
	Задать указатель на представление точек, используемое для преобразования точек в k-D-векторы. Подробнее...
PointRepresentationConstPtr	getPointRepresentation () const
	Получить указатель на представление точек, используемое при преобразовании точек в k-D-векторы. Подробнее...
void	setSortedResults (bool sorted_results) override
	Задаёт, нужно ли сортировать результаты. Подробнее...
void	setEpsilon (float eps)
	Задаёт точность поиска epsilon (границу погрешности) для поиска ближайших соседей. Подробнее...
float	getEpsilon () const
	Получить точность поиска epsilon (границу погрешности) для поиска ближайших соседей. Подробнее...
bool	setInputCloud (const PointCloudConstPtr &cloud, const IndicesConstPtr &indices=IndicesConstPtr()) override
	Задать указатель на входной набор данных. Подробнее...
int	nearestKSearch (const PointT &point, int k, Indices &k_indices, std::vector< float > &k_sqr_distances) const override
	Поиск k ближайших соседей для заданной точки-запроса. Подробнее...
int	radiusSearch (const PointT &point, double radius, Indices &k_indices, std::vector< float > &k_sqr_distances, unsigned int max_nn=0) const override
	Поиск всех ближайших соседей точки-запроса в заданном радиусе. Подробнее...
Открытые функции-члены, унаследованные от pcl::search::Search< PointT >
	Search (const std::string &name="", bool sorted=false)
	Конструктор. Подробнее...
virtual	~Search ()=default
	Деструктор. Подробнее...
virtual const std::string &	getName () const
	Возвращает имя метода поиска. Подробнее...
virtual bool	getSortedResults ()
	Возвращает признак того, должны ли результаты быть отсортированы (по возрастанию расстояния). В противном случае результаты могут возвращаться в произвольном порядке. Подробнее...
virtual PointCloudConstPtr	getInputCloud () const
	Получить указатель на входной набор облака точек. Подробнее...
virtual IndicesConstPtr	getIndices () const
	Получить указатель на используемый вектор индексов. Подробнее...
template<typename PointTDiff >
int	nearestKSearchT (const PointTDiff &point, int k, Indices &k_indices, std::vector< float > &k_sqr_distances) const
	Поиск k ближайших соседей для заданной точки-запроса. Подробнее...
virtual int	nearestKSearch (const PointCloud &cloud, index_t index, int k, Indices &k_indices, std::vector< float > &k_sqr_distances) const
	Поиск k ближайших соседей для заданной точки-запроса. Подробнее...
virtual int	nearestKSearch (index_t index, int k, Indices &k_indices, std::vector< float > &k_sqr_distances) const
	Поиск k ближайших соседей для заданной точки-запроса (без копирования). Подробнее...
virtual void	nearestKSearch (const PointCloud &cloud, const Indices &indices, int k, std::vector< Indices > &k_indices, std::vector< std::vector< float > > &k_sqr_distances) const
	Поиск k ближайших соседей для заданной точки-запроса. Подробнее...
template<typename PointTDiff >
void	nearestKSearchT (const pcl::PointCloud< PointTDiff > &cloud, const Indices &indices, int k, std::vector< Indices > &k_indices, std::vector< std::vector< float > > &k_sqr_distances) const
	Поиск k ближайших соседей для заданной точки-запроса. Подробнее...
template<typename PointTDiff >
int	radiusSearchT (const PointTDiff &point, double radius, Indices &k_indices, std::vector< float > &k_sqr_distances, unsigned int max_nn=0) const
	Поиск всех ближайших соседей точки-запроса в заданном радиусе. Подробнее...
virtual int	radiusSearch (const PointCloud &cloud, index_t index, double radius, Indices &k_indices, std::vector< float > &k_sqr_distances, unsigned int max_nn=0) const
	Поиск всех ближайших соседей точки-запроса в заданном радиусе. Подробнее...
virtual int	radiusSearch (index_t index, double radius, Indices &k_indices, std::vector< float > &k_sqr_distances, unsigned int max_nn=0) const
	Поиск всех ближайших соседей точки-запроса в заданном радиусе (без копирования). Подробнее...
virtual void	radiusSearch (const PointCloud &cloud, const Indices &indices, double radius, std::vector< Indices > &k_indices, std::vector< std::vector< float > > &k_sqr_distances, unsigned int max_nn=0) const
	Поиск всех ближайших соседей точки-запроса в заданном радиусе. Подробнее...
template<typename PointTDiff >
void	radiusSearchT (const pcl::PointCloud< PointTDiff > &cloud, const Indices &indices, double radius, std::vector< Indices > &k_indices, std::vector< std::vector< float > > &k_sqr_distances, unsigned int max_nn=0) const
	Поиск всех ближайших соседей точек-запросов в заданном радиусе. Подробнее...

Защищённые функции-члены
	KdTree (const std::string &name, bool sorted)
	При этом внутренний объект tree_ остаётся неинициализированным! Подробнее...
Защищённые функции-члены, унаследованные от pcl::search::Search< PointT >
void	sortResults (Indices &indices, std::vector< float > &distances) const

Защищённые атрибуты
KdTreePtr	tree_
	Указатель на внутренний объект KdTree. Подробнее...
Защищённые атрибуты, унаследованные от pcl::search::Search< PointT >
PointCloudConstPtr	input_
IndicesConstPtr	indices_
bool	sorted_results_
std::string	name_

Подробное описание

template<typename PointT, class Tree = pcl::KdTreeFLANN<PointT>>
class pcl::search::KdTree< PointT, Tree >

search::KdTree — класс-обёртка, наследующий класс pcl::KdTree для выполнения поисковых функций с использованием структуры KdTree.

KdTree — это универсальный тип пространственного локатора для 3D-пространства, использующий структуры kD-дерева. В этом классе используется проект FLANN (Fast Library for Approximate Nearest Neighbor), созданный Мариусом Мухой и Дэвидом Лоу.

Автор: Radu B. Rusu

Определение в строке 61 файла kdtree.h.

Описание псевдонимов типов-членов

ConstPtr

template<typename PointT , class Tree = pcl::KdTreeFLANN<PointT>>

using pcl::search::KdTree< PointT, Tree >::ConstPtr = shared_ptr<const KdTree<PointT, Tree> >

Определение в строке 76 файла kdtree.h.

KdTreeConstPtr

template<typename PointT , class Tree = pcl::KdTreeFLANN<PointT>>

using pcl::search::KdTree< PointT, Tree >::KdTreeConstPtr = typename Tree::ConstPtr

Определение в строке 79 файла kdtree.h.

KdTreePtr

template<typename PointT , class Tree = pcl::KdTreeFLANN<PointT>>

using pcl::search::KdTree< PointT, Tree >::KdTreePtr = typename Tree::Ptr

Определение в строке 78 файла kdtree.h.

PointCloud

template<typename PointT , class Tree = pcl::KdTreeFLANN<PointT>>

using pcl::search::KdTree< PointT, Tree >::PointCloud = typename Search<PointT>::PointCloud

Определение в строке 64 файла kdtree.h.

PointCloudConstPtr

template<typename PointT , class Tree = pcl::KdTreeFLANN<PointT>>

using pcl::search::KdTree< PointT, Tree >::PointCloudConstPtr = typename Search<PointT>::PointCloudConstPtr

Определение в строке 65 файла kdtree.h.

PointRepresentationConstPtr

template<typename PointT , class Tree = pcl::KdTreeFLANN<PointT>>

using pcl::search::KdTree< PointT, Tree >::PointRepresentationConstPtr = typename PointRepresentation<PointT>::ConstPtr

Определение в строке 80 файла kdtree.h.

Ptr

template<typename PointT , class Tree = pcl::KdTreeFLANN<PointT>>

using pcl::search::KdTree< PointT, Tree >::Ptr = shared_ptr<KdTree<PointT, Tree> >

Определение в строке 75 файла kdtree.h.

Описание конструктора и деструктора

KdTree() [1/2]

template<typename PointT , class Tree >

pcl::search::KdTree< PointT, Tree >::KdTree ( bool sorted = true )

Конструктор KdTree.

Параметры

[in] sorted установите значение true, если результаты поиска ближайших соседей необходимо отсортировать по возрастанию расстояния до точки запроса

Определение в строке 45 файла kdtree.hpp.

~KdTree()

template<typename PointT , class Tree = pcl::KdTreeFLANN<PointT>>

pcl::search::KdTree< PointT, Tree >::~KdTree ( )

overridedefault

Деструктор KdTree.

KdTree() [2/2]

template<typename PointT , class Tree >

pcl::search::KdTree< PointT, Tree >::KdTree	(	const std::string &	name,
		bool	sorted
	)

protected

Внутренний объект tree_ остаётся неинициализированным!

Определение в строке 52 файла kdtree.hpp.

Описание функций-членов

getEpsilon()

template<typename PointT , class Tree = pcl::KdTreeFLANN<PointT>>

float pcl::search::KdTree< PointT, Tree >::getEpsilon ( ) const

inline

Получить точность epsilon поиска (границу погрешности) при поиске ближайших соседей.

Определение в строке 122 файла kdtree.h.

Ссылки: pcl::search::KdTree< PointT, Tree >::tree_.

getPointRepresentation()

template<typename PointT , class Tree = pcl::KdTreeFLANN<PointT>>

PointRepresentationConstPtr pcl::search::KdTree< PointT, Tree >::getPointRepresentation ( ) const

inline

Получить указатель на представление точки, используемое при преобразовании точек в k-D-векторы.

Определение в строке 103 файла kdtree.h.

Ссылки: pcl::search::KdTree< PointT, Tree >::tree_.

nearestKSearch()

template<typename PointT , class Tree >

int pcl::search::KdTree< PointT, Tree >::nearestKSearch	(	const PointT &	point,
		int	k,
		Indices &	k_indices,
		std::vector< float > &	k_sqr_distances
	)		const

overridevirtual

Выполнить поиск k ближайших соседей для заданной точки запроса.

Параметры

[in]	point	заданная точка запроса
[in]	k	количество соседей для поиска
[out]	k_indices	индексы найденных соседних точек (предварительно необходимо изменить размер до k!)
[out]	k_sqr_distances	квадраты расстояний до найденных соседних точек (предварительно необходимо изменить размер до k!)

Возвращает: количество найденных соседей

Реализует pcl::search::Search< PointT >.

Определение в строке 100 файла kdtree.hpp.

Используется в pcl::GeneralizedIterativeClosestPoint< PointSource, PointTarget, Scalar >::computeCovariances(), pcl::registration::FPCSInitialAlignment< PointSource, PointTarget, pcl::Normal, float >::FPCSInitialAlignment() и pcl::getMeanPointDensity().

radiusSearch()

template<typename PointT , class Tree >

int pcl::search::KdTree< PointT, Tree >::radiusSearch	(	const PointT &	point,
		double	radius,
		Indices &	k_indices,
		std::vector< float > &	k_sqr_distances,
		unsigned int	max_nn = `0`
	)		const

overridevirtual

Выполнить поиск всех ближайших соседей точки запроса в заданном радиусе.

Параметры

[in]	point	заданная точка запроса
[in]	radius	радиус сферы, содержащей всех соседей точки p_q
[out]	k_indices	индексы найденных соседних точек
[out]	k_sqr_distances	квадраты расстояний до найденных соседних точек
[in]	max_nn	если задано, ограничивает максимальное количество возвращаемых соседей этим значением. Если max_nn равно 0 или больше количества точек во входном облаке, будут возвращены все соседи в пределах radius.

Возвращает: количество соседей, найденных в пределах радиуса

Реализует pcl::search::Search< PointT >.

Определение в строке 109 файла kdtree.hpp.

Используется в pcl::HarrisKeypoint6D< PointInT, PointOutT, NormalT >::refineCorners().

setEpsilon()

template<typename PointT , class Tree >

void pcl::search::KdTree< PointT, Tree >::setEpsilon ( float eps )

Задать точность epsilon поиска (границу погрешности) при поиске ближайших соседей.

Параметры

[in] eps точность (граница погрешности) при поиске ближайших соседей

Определение в строке 78 файла kdtree.hpp.

setInputCloud()

template<typename PointT , class Tree >

bool pcl::search::KdTree< PointT, Tree >::setInputCloud	(	const PointCloudConstPtr &	cloud,
		const IndicesConstPtr &	indices = `IndicesConstPtr ()`
	)

overridevirtual

Предоставить указатель на входной набор данных.

Параметры

[in]	cloud	константный общий указатель boost на сообщение PointCloud
[in]	indices	подмножество индексов точек из cloud, которое будет использоваться

Переопределяет метод из pcl::search::Search< PointT >.

Определение в строке 88 файла kdtree.hpp.

Используется в pcl::people::GroundBasedPeopleDetectionApp< PointT >::compute(), pcl::getMeanPointDensity(), pcl::HarrisKeypoint6D< PointInT, PointOutT, NormalT >::refineCorners() и pcl::HypothesisVerification< ModelT, SceneT >::setSceneCloud().

setPointRepresentation()

template<typename PointT , class Tree >

void pcl::search::KdTree< PointT, Tree >::setPointRepresentation ( const PointRepresentationConstPtr & point_representation )

Предоставляет указатель на представление точки, используемое для преобразования точек в k-D-векторы.

Параметры

[in] point_representation константный общий указатель boost на PointRepresentation

Определение в строке 59 файла kdtree.hpp.

setSortedResults()

template<typename PointT , class Tree >

void pcl::search::KdTree< PointT, Tree >::setSortedResults ( bool sorted_results )

overridevirtual

Задает, нужно ли сортировать результаты.

Параметры

[in] sorted_results установите значение true, если результаты поиска в радиусе должны быть отсортированы

Переопределено из pcl::search::Search< PointT >.

Определение в строке 70 файла kdtree.hpp.

Описание данных-членов

tree_

template<typename PointT , class Tree = pcl::KdTreeFLANN<PointT>>

KdTreePtr pcl::search::KdTree< PointT, Tree >::tree_

protected

Указатель на внутренний объект KdTree.

Определение в строке 167 файла kdtree.h.

Используется в pcl::search::KdTree< PointT, Tree >::getEpsilon() и pcl::search::KdTree< PointT, Tree >::getPointRepresentation().

Документация для этого класса сгенерирована на основе следующих файлов:

pcl/search/kdtree.h
pcl/search/impl/kdtree.hpp

© 2009–2012, Willow Garage, Inc.
© 2012–, Open Perception, Inc.
Licensed under the BSD License.
https://pointclouds.org/documentation/classpcl_1_1search_1_1_kd_tree.html

Общедоступные типы

Открытые функции-члены

Защищённые функции-члены

Защищённые атрибуты

Подробное описание

template<typename PointT, class Tree = pcl::KdTreeFLANN<PointT>> class pcl::search::KdTree< PointT, Tree >

Описание псевдонимов типов-членов

ConstPtr

KdTreeConstPtr

KdTreePtr

PointCloud

PointCloudConstPtr

PointRepresentationConstPtr

Ptr

Описание конструктора и деструктора

KdTree() [1/2]

~KdTree()

KdTree() [2/2]

Описание функций-членов

getEpsilon()

getPointRepresentation()

nearestKSearch()

radiusSearch()

setEpsilon()

setInputCloud()

setPointRepresentation()

setSortedResults()

Описание данных-членов

tree_

template<typename PointT, class Tree = pcl::KdTreeFLANN<PointT>>
class pcl::search::KdTree< PointT, Tree >