pcl::PCA — PointCloudLibrary

Анализ главных компонент (PCA) класс. Подробнее...

#include <pcl/common/pca.h>

Публичные типы
перечисление	FLAG { увеличение , сохранение }
	Флаг обновления метода. Подробнее...
используется	Base = pcl::PCLBase< PointT >
используется	PointCloud = typename Base::PointCloud
используется	PointCloudPtr = typename Base::PointCloudPtr
используется	PointCloudConstPtr = typename Base::PointCloudConstPtr
используется	PointIndicesPtr = typename Base::PointIndicesPtr
используется	PointIndicesConstPtr = typename Base::PointIndicesConstPtr
Публичные типы, унаследованные от pcl::PCLBase< PointT >
используется	PointCloud = pcl::PointCloud< PointT >
используется	PointCloudPtr = typename PointCloud::Ptr
используется	PointCloudConstPtr = typename PointCloud::ConstPtr
используется	PointIndicesPtr = PointIndices::Ptr

using PointIndicesConstPtr = PointIndices::ConstPtr

Публичные члены-функции
	PCA (bool basis_only=false)
	Конструктор по умолчанию. Подробнее...
	PCA (PCA const &pca)
	Конструктор копирования. Подробнее...
PCA &	operator= (PCA const &pca)
	Оператор присваивания. Подробнее...
void	setInputCloud (const PointCloudConstPtr &cloud) override
	Предоставьте указатель на входные данные. Подробнее...
void	setIndices (const IndicesPtr &indices) override
	Предоставьте указатель на вектор индексов, представляющих входные данные. Подробнее...
void	setIndices (const IndicesConstPtr &indices) override
	Предоставьте указатель на вектор индексов, представляющих входные данные. Подробнее...
void	setIndices (const PointIndicesConstPtr &indices) override
	Предоставьте указатель на вектор индексов, представляющих входные данные. Подробнее...
void	setIndices (std::size_t row_start, std::size_t col_start, std::size_t nb_rows, std::size_t nb_cols) override
	Установите индексы для точек, находящихся в области интереса облака точек. Подробнее...
Eigen::Vector4f &	getMean ()

	Доступ к среднему значению. Подробнее...
Eigen::Matrix3f &	getEigenVectors ()
	Доступ к векторам Eigen. Подробнее...
Eigen::Vector3f &	getEigenValues ()
	Доступ к собственным значениям Eigen. Подробнее...
Eigen::MatrixXf &	getCoefficients ()
	Доступ к коэффициентам. Подробнее...
void	update (const PointT &input, FLAG flag=preserve)
	Обновление анализа главных компонент (PCA) с новой точкой Подробнее...
void	project (const PointT &input, PointT &projection)
	Проецирование точки на подпространство собственных векторов. Подробнее...
void	project (const PointCloud &input, PointCloud &projection)
	Проецирование облака точек на подпространство собственных векторов. Подробнее...
void	reconstruct (const PointT &projection, PointT &input)
	Восстановление точки из её проекции. Подробнее...
void	reconstruct (const PointCloud &projection, PointCloud &input)

	Восстановить облако по его проекции. Подробнее...
bool	initCompute ()
	Этот метод должен быть вызван перед началом фактического вычисления. Подробнее...
virtual void	setInputCloud (const PointCloudConstPtr &cloud)
	Предоставьте указатель на входные данные. Подробнее...
Публичные члены-функции, унаследованные от pcl::PCLBase< PointT >
	PCLBase ()
	Пустой конструктор. Подробнее...
	PCLBase (const PCLBase &base)
	Конструктор копирования. Подробнее...
virtual	~PCLBase ()=default
	Деструктор. Подробнее...
PointCloudConstPtr const	getInputCloud () const
	Получить указатель на входное облако точек. Подробнее...
IndicesPtr	getIndices ()
	Получить указатель на вектор индексов. Подробнее...

IndicesConstPtr const	getIndices () const
	Получить указатель на вектор индексов, используемых. Подробнее...
const PointT &	operator[] (std::size_t pos) const
	Переопределить PointCloud оператор[] для сокращения кода. Подробнее...

Публичные атрибуты
PointCloudConstPtr	input_
	Входной набор данных точек. Подробнее...
IndicesPtr	indices_
	Указатель на вектор индексов точек для использования. Подробнее...

Дополнительные унаследованные члены
Защищенные члены-функции, унаследованные от pcl::PCLBase< PointT >
bool	initCompute ()
	Этот метод должен вызываться перед началом фактического вычисления. Подробнее...
bool	deinitCompute ()
	Этот метод должен вызываться после завершения фактического вычисления. Подробнее...
Защищенные атрибуты, унаследованные от pcl::PCLBase< PointT >
PointCloudConstPtr	input_
	Набор входных данных облака точек. Подробнее...
IndicesPtr	indices_
	Указатель на вектор индексов точек для использования. Подробнее...
bool	use_indices_
	Устанавливается в значение true, если используются индексы точек. Подробнее...
bool	fake_indices_
	Если набор индексов не задан, мы создаём набор фиктивных индексов, которые имитируют входное PointCloud. Подробнее...

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

шаблон<typename PointT>
класс pcl::PCA< PointT >

Анализ главных компонент (PCA) класс.

Главные компоненты извлекаются с помощью разложения по сингулярным значениям ковариационной матрицы центрированного входного облака. Доступные данные после вычисления PCA:

Среднее значение входных данных
Собственные векторы: упорядоченный набор векторов, представляющих результирующие главные компоненты и декартову основу собственного пространства (правостороннее координатное пространство).
Собственные значения: соответсвующие нагрузки собственных векторов, упорядоченные в порядке убывания.

Другие методы позволяют проектировать в собственное пространство, восстанавливать из собственного пространства и обновлять собственное пространство с новым данными (согласно Matej Artec, Matjaz Jogan и Ales Leonardis: "Инкрементный PCA для онлайн визуального обучения и распознавания").

Автор: Nizar Sallem

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

Документация типов-членов

Base

шаблон<typename PointT >

используя pcl::PCA< PointT >::Base = pcl::PCLBase<PointT>

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

PointCloud

шаблон<typename PointT >

используя pcl::PCA< PointT >::PointCloud = typename Base::PointCloud

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

PointCloudConstPtr

шаблон<typename PointT >

используя pcl::PCA< PointT >::PointCloudConstPtr = typename Base::PointCloudConstPtr

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

PointCloudPtr

шаблон<typename PointT >

используя pcl::PCA< PointT >::PointCloudPtr = typename Base::PointCloudPtr

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

PointIndicesConstPtr

шаблон<typename PointT >

используя pcl::PCA< PointT >::PointIndicesConstPtr = typename Base::PointIndicesConstPtr

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

PointIndicesPtr

template<typename PointT >

using pcl::PCA< PointT >::PointIndicesPtr = typename Base::PointIndicesPtr

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

Документация перечисления членов

ФЛАГ

template<typename PointT >

enum pcl::PCA::FLAG

Флаг обновления метода.

Перечислитель
increase	сохранить новые векторы базиса, если возможно
preserve	сохранить размерность подпространства

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

Документация конструкторов и деструкторов

PCA() [1/2]

template<typename PointT >

pcl::PCA< PointT >::PCA ( bool basis_only = false )

inline

Конструктор по умолчанию.

Параметры

basis_only флаг для вычисления только базиса PCA

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

PCA() [2/2]

template<typename PointT >

pcl::PCA< PointT >::PCA ( PCA< PointT > const & pca )

inline

Копирующий конструктор.

Параметры

[in] pca объект PCA

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

Документация функций-членов

getCoefficients()

template<typename PointT >

Eigen::MatrixXf& pcl::PCA< PointT >::getCoefficients ( )

inline

Доступ к коэффициентам.

Исключения

InitFailedException

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

getEigenValues()

template<typename PointT >

Eigen::Vector3f& pcl::PCA< PointT >::getEigenValues ( )

inline

Доступ к собственным значениям Eigen.

Исключения

InitFailedException

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

getEigenVectors()

template<typename PointT >

Eigen::Matrix3f& pcl::PCA< PointT >::getEigenVectors ( )

inline

Доступ к собственным векторам Eigen.

Возвращает: Собственные векторы в порядке столбцов, представляющие декартово базис собственного пространства (правостороннюю систему координат).

Исключения

InitFailedException

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

getMean()

template<typename PointT >

Eigen::Vector4f& pcl::PCA< PointT >::getMean ( )

inline

Доступ к среднему значению.

Исключения

InitFailedException

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

initCompute()

template<typename PointT >

bool pcl::PCLBase< PointT >::initCompute

Этот метод должен вызываться перед началом фактического вычисления.

Внутри initCompute() выполняется следующее:

проверяется, предоставлен ли набор входных данных, и возвращается false в противном случае
проверяется, предоставлен ли набор входных индексов. Возвращается true, если да.
если набор входных индексов не предоставлен, создается фиктивный набор, который будет использоваться до тех пор, пока:
- либо новый набор не будет предоставлен через setIndices(), или
- новый облако не будет предоставлено с другим набором точек. Это вызовет обновление набора фиктивных индексов

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

operator=()

template<typename PointT >

PCA& pcl::PCA< PointT >::operator= ( PCA< PointT > const & pca )

inline

Оператор присваивания.

Parameters

[in] pca объект PCA

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

project() [1/2]

template<typename PointT >

void pcl::PCA< PointT >::project	(	const PointCloud &	input,
		PointCloud &	projection
	)

inline

Проектирование облака на собственное пространство.

Parameters

[in]	input	облако из исходного набора данных
[out]	projection	облако в пространстве собственных векторов

Exceptions

InitFailedException

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

Ссылки на pcl::geometry::project().

project() [2/2]

template<typename PointT >

void pcl::PCA< PointT >::project	(	const PointT &	input,
		PointT &	projection
	)

inline

Проецирование точки на собственное подпространство.

Параметры

[in]	input	точка из исходного набора данных
[out]	projection	точка в пространстве собственных векторов

Исключения

InitFailedException

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

reconstruct() [1/2]

template<typename PointT >

void pcl::PCA< PointT >::reconstruct	(	const PointCloud &	projection,
		PointCloud &	input
	)

inline

Восстановление облака точек из его проекции.

Параметры

[in]	projection	облако из пространства собственных векторов
[out]	input	восстановленное облако точек

Исключения

InitFailedException

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

reconstruct() [2/2]

template<typename PointT >

void pcl::PCA< PointT >::reconstruct	(	const PointT &	projection,
		PointT &	input
	)

inline

Восстановление точки из её проекции.

Параметры

[in]	projection	точка из пространства собственных векторов
[out]	input	восстановленная точка

Исключения

InitFailedException

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

setIndices() [1/4]

template<typename PointT >

void pcl::PCA< PointT >::setIndices ( const IndicesConstPtr & indices )

inlineoverridevirtual

Укажите указатель на вектор индексов, представляющий входные данные.

Parameters

[in] indices указатель на индексы, представляющие входные данные.

Переопределяет pcl::PCLBase< PointT >.

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

Ссылки на pcl::PCLBase< PointT >::setIndices().

setIndices() [2/4]

template<typename PointT >

void pcl::PCA< PointT >::setIndices ( const IndicesPtr & indices )

inlineoverridevirtual

Укажите указатель на вектор индексов, представляющий входные данные.

Parameters

[in] indices указатель на индексы, представляющие входные данные.

Переопределяет pcl::PCLBase< PointT >.

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

Ссылки на pcl::PCLBase< PointT >::setIndices().

setIndices() [3/4]

template<typename PointT >

void pcl::PCA< PointT >::setIndices ( const PointIndicesConstPtr & indices )

inlineoverridevirtual

Укажите указатель на вектор индексов, представляющий входные данные.

Parameters

[in] indices указатель на индексы, представляющие входные данные.

Переопределяет pcl::PCLBase< PointT >.

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

Ссылки на pcl::PCLBase< PointT >::setIndices().

setIndices() [4/4]

template<typename PointT >

void pcl::PCA< PointT >::setIndices	(	std::size_t	row_start,
		std::size_t	col_start,
		std::size_t	nb_rows,
		std::size_t	nb_cols
	)

inlineoverridevirtual

Установить индексы для точек, лежащих в области интереса облака точек.

Примечание: не следует вызывать этот метод для неупорядоченных облаков точек!

Параметры

[in]	row_start	смещение по строкам
[in]	col_start	смещение по столбцам
[in]	nb_rows	количество строк для рассмотрения, включая строку row_start
[in]	nb_cols	количество столбцов для рассмотрения, включая столбец col_start

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

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

Ссылки на pcl::PCLBase< PointT >::setIndices().

setInputCloud() [1/2]

template<typename PointT >

void pcl::PCLBase< PointT >::setInputCloud

Указать указатель на входные данные.

Параметры

[in] cloud указатель на константный boost shared pointer к сообщению PointCloud

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

setInputCloud() [2/2]

template<typename PointT >

void pcl::PCA< PointT >::setInputCloud ( const PointCloudConstPtr & cloud )

inlineoverridevirtual

Указать указатель на входные данные.

Параметры

cloud указатель на константный boost shared pointer к сообщению PointCloud

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

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

Ссылки на pcl::PCLBase< PointT >::setInputCloud().

update()

template<typename PointT >

void pcl::PCA< PointT >::update	(	const PointT &	input,
		FLAG	flag = `preserve`
	)

inline

обновить PCA новым элементом

Параметры

[in]	input	входной элемент
[in]	flag	флаг обновления

Исключения

InitFailedException

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

Документация по данным членов

indices_

template<typename PointT >

IndicesPtr pcl::PCLBase< PointT >::indices_

Указатель на вектор индексов точек для использования.

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

input_

template<typename PointT >

PointCloudConstPtr pcl::PCLBase< PointT >::input_

Входное облако точек.

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

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

pcl/common/pca.h
pcl/common/impl/pca.hpp

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

Публичные типы

Публичные члены-функции

Публичные атрибуты

Дополнительные унаследованные члены

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

шаблон<typename PointT> класс pcl::PCA< PointT >

Документация типов-членов

Base

PointCloud

PointCloudConstPtr

PointCloudPtr

PointIndicesConstPtr

PointIndicesPtr

Документация перечисления членов

ФЛАГ

Документация конструкторов и деструкторов

PCA() [1/2]

PCA() [2/2]

Документация функций-членов

getCoefficients()

getEigenValues()

getEigenVectors()

getMean()

initCompute()

operator=()

project() [1/2]

project() [2/2]

reconstruct() [1/2]

reconstruct() [2/2]

setIndices() [1/4]

setIndices() [2/4]

setIndices() [3/4]

setIndices() [4/4]

setInputCloud() [1/2]

setInputCloud() [2/2]

update()

Документация по данным членов

indices_

input_

шаблон<typename PointT>
класс pcl::PCA< PointT >