MomentInvariantsEstimation estimates the 3 moment invariants (j1, j2, j3) at each 3D point. More...

#include <pcl/features/moment_invariants.h>

Inheritance diagram for pcl::MomentInvariantsEstimation< PointInT, Eigen::MatrixXf >:

Collaboration diagram for pcl::MomentInvariantsEstimation< PointInT, Eigen::MatrixXf >:

Public Types
typedef Feature< PointInT, pcl::MomentInvariants > ::PointCloudOut	PointCloudOut
typedef PCLBase< PointInT >	BaseClass
typedef boost::shared_ptr < Feature< PointInT, pcl::MomentInvariants > >	Ptr
typedef boost::shared_ptr < const Feature< PointInT, pcl::MomentInvariants > >	ConstPtr
typedef pcl::search::Search < PointInT >	KdTree
typedef pcl::search::Search < PointInT >::Ptr	KdTreePtr
typedef pcl::PointCloud< PointInT >	PointCloudIn
typedef PointCloudIn::Ptr	PointCloudInPtr
typedef PointCloudIn::ConstPtr	PointCloudInConstPtr
typedef boost::function< int(size_t, double, std::vector< int > &, std::vector< float > &)>	SearchMethod
typedef boost::function< int(const PointCloudIn &cloud, size_t index, double, std::vector < int > &, std::vector< float > &)>	SearchMethodSurface
typedef pcl::PointCloud< PointInT >	PointCloud
typedef PointCloud::Ptr	PointCloudPtr
typedef PointCloud::ConstPtr	PointCloudConstPtr
typedef PointIndices::Ptr	PointIndicesPtr
typedef PointIndices::ConstPtr	PointIndicesConstPtr
Public Member Functions
void	computePointMomentInvariants (const pcl::PointCloud< PointInT > &cloud, const std::vector< int > &indices, float &j1, float &j2, float &j3)
	Compute the 3 moment invariants (j1, j2, j3) for a given set of points, using their indices.
void	computePointMomentInvariants (const pcl::PointCloud< PointInT > &cloud, float &j1, float &j2, float &j3)
	Compute the 3 moment invariants (j1, j2, j3) for a given set of points, using their indices.
void	setSearchSurface (const PointCloudInConstPtr &cloud)
	Provide a pointer to a dataset to add additional information to estimate the features for every point in the input dataset.
PointCloudInConstPtr	getSearchSurface () const
	Get a pointer to the surface point cloud dataset.
void	setSearchMethod (const KdTreePtr &tree)
	Provide a pointer to the search object.
KdTreePtr	getSearchMethod () const
	Get a pointer to the search method used.
double	getSearchParameter () const
	Get the internal search parameter.
void	setKSearch (int k)
	Set the number of k nearest neighbors to use for the feature estimation.
int	getKSearch () const
	get the number of k nearest neighbors used for the feature estimation.
void	setRadiusSearch (double radius)
	Set the sphere radius that is to be used for determining the nearest neighbors used for the feature estimation.
double	getRadiusSearch () const
	Get the sphere radius used for determining the neighbors.
void	compute (PointCloudOut &output)
	Base method for feature estimation for all points given in <setInputCloud (), setIndices ()> using the surface in setSearchSurface () and the spatial locator in setSearchMethod ()
void	computeEigen (pcl::PointCloud< Eigen::MatrixXf > &output)
	Base method for feature estimation for all points given in <setInputCloud (), setIndices ()> using the surface in setSearchSurface () and the spatial locator in setSearchMethod ()
virtual void	setInputCloud (const PointCloudConstPtr &cloud)
	Provide a pointer to the input dataset.
PointCloudConstPtr const	getInputCloud ()
	Get a pointer to the input point cloud dataset.
void	setIndices (const IndicesPtr &indices)
	Provide a pointer to the vector of indices that represents the input data.
void	setIndices (const IndicesConstPtr &indices)
	Provide a pointer to the vector of indices that represents the input data.
void	setIndices (const PointIndicesConstPtr &indices)
	Provide a pointer to the vector of indices that represents the input data.
void	setIndices (size_t row_start, size_t col_start, size_t nb_rows, size_t nb_cols)
	Set the indices for the points laying within an interest region of the point cloud.
IndicesPtr const	getIndices ()
	Get a pointer to the vector of indices used.
const PointInT &	operator[] (size_t pos)
	Override PointCloud operator[] to shorten code.

Detailed Description

template<typename PointInT>
class pcl::MomentInvariantsEstimation< PointInT, Eigen::MatrixXf >

MomentInvariantsEstimation estimates the 3 moment invariants (j1, j2, j3) at each 3D point.

Note:: The code is stateful as we do not expect this class to be multicore parallelized. Please look at NormalEstimationOMP for an example on how to extend this to parallel implementations.

Author:: Radu B. Rusu

Definition at line 127 of file moment_invariants.h.

Member Typedef Documentation

typedef PCLBase<PointInT> pcl::Feature< PointInT, pcl::MomentInvariants >::BaseClass [inherited]

Definition at line 110 of file feature.h.

typedef boost::shared_ptr< const Feature<PointInT, pcl::MomentInvariants > > pcl::Feature< PointInT, pcl::MomentInvariants >::ConstPtr [inherited]

Definition at line 113 of file feature.h.

typedef pcl::search::Search<PointInT> pcl::Feature< PointInT, pcl::MomentInvariants >::KdTree [inherited]

Definition at line 115 of file feature.h.

typedef pcl::search::Search<PointInT>::Ptr pcl::Feature< PointInT, pcl::MomentInvariants >::KdTreePtr [inherited]

Definition at line 116 of file feature.h.

typedef pcl::PointCloud<PointInT > pcl::PCLBase< PointInT >::PointCloud [inherited]

Definition at line 74 of file pcl_base.h.

typedef PointCloud::ConstPtr pcl::PCLBase< PointInT >::PointCloudConstPtr [inherited]

Reimplemented in pcl::NormalEstimation< PointInT, PointOutT >, and pcl::NormalEstimation< PointInT, pcl::Normal >.

Definition at line 76 of file pcl_base.h.

typedef pcl::PointCloud<PointInT> pcl::Feature< PointInT, pcl::MomentInvariants >::PointCloudIn [inherited]

Definition at line 118 of file feature.h.

typedef PointCloudIn::ConstPtr pcl::Feature< PointInT, pcl::MomentInvariants >::PointCloudInConstPtr [inherited]

Definition at line 120 of file feature.h.

typedef PointCloudIn::Ptr pcl::Feature< PointInT, pcl::MomentInvariants >::PointCloudInPtr [inherited]

Definition at line 119 of file feature.h.

typedef Feature<PointInT, pcl::MomentInvariants >::PointCloudOut pcl::MomentInvariantsEstimation< PointInT, pcl::MomentInvariants >::PointCloudOut [inherited]

Reimplemented from pcl::Feature< PointInT, pcl::MomentInvariants >.

Definition at line 66 of file moment_invariants.h.

typedef PointCloud::Ptr pcl::PCLBase< PointInT >::PointCloudPtr [inherited]

Reimplemented in pcl::OrganizedFastMesh< PointInT >.

Definition at line 75 of file pcl_base.h.

typedef PointIndices::ConstPtr pcl::PCLBase< PointInT >::PointIndicesConstPtr [inherited]

Definition at line 79 of file pcl_base.h.

typedef PointIndices::Ptr pcl::PCLBase< PointInT >::PointIndicesPtr [inherited]

Definition at line 78 of file pcl_base.h.

typedef boost::shared_ptr< Feature<PointInT, pcl::MomentInvariants > > pcl::Feature< PointInT, pcl::MomentInvariants >::Ptr [inherited]

Definition at line 112 of file feature.h.

typedef boost::function<int (size_t, double, std::vector<int> &, std::vector<float> &)> pcl::Feature< PointInT, pcl::MomentInvariants >::SearchMethod [inherited]

Definition at line 124 of file feature.h.

typedef boost::function<int (const PointCloudIn &cloud, size_t index, double, std::vector<int> &, std::vector<float> &)> pcl::Feature< PointInT, pcl::MomentInvariants >::SearchMethodSurface [inherited]

Definition at line 125 of file feature.h.

Member Function Documentation

void pcl::Feature< PointInT, pcl::MomentInvariants >::compute ( PointCloudOut & output ) [inherited]

Base method for feature estimation for all points given in <setInputCloud (), setIndices ()> using the surface in setSearchSurface () and the spatial locator in setSearchMethod ()

Parameters:

[out] output the resultant point cloud model dataset containing the estimated features

void pcl::Feature< PointInT, pcl::MomentInvariants >::computeEigen ( pcl::PointCloud< Eigen::MatrixXf > & output ) [inherited]

Base method for feature estimation for all points given in <setInputCloud (), setIndices ()> using the surface in setSearchSurface () and the spatial locator in setSearchMethod ()

Parameters:

[out] output the resultant point cloud model dataset containing the estimated features

void pcl::MomentInvariantsEstimation< PointInT, pcl::MomentInvariants >::computePointMomentInvariants	(	const pcl::PointCloud< PointInT > &	cloud,
		const std::vector< int > &	indices,
		float &	j1,
		float &	j2,
		float &	j3
	)		`[inherited]`

Compute the 3 moment invariants (j1, j2, j3) for a given set of points, using their indices.

Parameters:

[in]	cloud	the input point cloud
[in]	indices	the point cloud indices that need to be used
[out]	j1	the resultant first moment invariant
[out]	j2	the resultant second moment invariant
[out]	j3	the resultant third moment invariant

void pcl::MomentInvariantsEstimation< PointInT, pcl::MomentInvariants >::computePointMomentInvariants	(	const pcl::PointCloud< PointInT > &	cloud,
		float &	j1,
		float &	j2,
		float &	j3
	)		`[inherited]`

Compute the 3 moment invariants (j1, j2, j3) for a given set of points, using their indices.

Parameters:

[in]	cloud	the input point cloud
[out]	j1	the resultant first moment invariant
[out]	j2	the resultant second moment invariant
[out]	j3	the resultant third moment invariant

IndicesPtr const pcl::PCLBase< PointInT >::getIndices ( ) [inline, inherited]

Get a pointer to the vector of indices used.

Definition at line 190 of file pcl_base.h.

PointCloudConstPtr const pcl::PCLBase< PointInT >::getInputCloud ( ) [inline, inherited]

Get a pointer to the input point cloud dataset.

Definition at line 107 of file pcl_base.h.

int pcl::Feature< PointInT, pcl::MomentInvariants >::getKSearch ( ) const [inline, inherited]

get the number of k nearest neighbors used for the feature estimation.

Definition at line 186 of file feature.h.

double pcl::Feature< PointInT, pcl::MomentInvariants >::getRadiusSearch ( ) const [inline, inherited]

Get the sphere radius used for determining the neighbors.

Definition at line 203 of file feature.h.

KdTreePtr pcl::Feature< PointInT, pcl::MomentInvariants >::getSearchMethod ( ) const [inline, inherited]

Get a pointer to the search method used.

Definition at line 166 of file feature.h.

double pcl::Feature< PointInT, pcl::MomentInvariants >::getSearchParameter ( ) const [inline, inherited]

Get the internal search parameter.

Definition at line 173 of file feature.h.

PointCloudInConstPtr pcl::Feature< PointInT, pcl::MomentInvariants >::getSearchSurface ( ) const [inline, inherited]

Get a pointer to the surface point cloud dataset.

Definition at line 153 of file feature.h.

const PointInT & pcl::PCLBase< PointInT >::operator[] ( size_t pos ) [inline, inherited]

Override PointCloud operator[] to shorten code.

Note:: this method can be called instead of (*input_)[(*indices_)[pos]] or input_->points[(*indices_)[pos]]

Parameters:

pos	position in indices_ vector

Definition at line 197 of file pcl_base.h.

void pcl::PCLBase< PointInT >::setIndices ( const IndicesPtr & indices ) [inline, inherited]

Provide a pointer to the vector of indices that represents the input data.

Parameters:

indices a pointer to the vector of indices that represents the input data.

Definition at line 113 of file pcl_base.h.

void pcl::PCLBase< PointInT >::setIndices ( const IndicesConstPtr & indices ) [inline, inherited]

Provide a pointer to the vector of indices that represents the input data.

Parameters:

indices a pointer to the vector of indices that represents the input data.

Definition at line 124 of file pcl_base.h.

void pcl::PCLBase< PointInT >::setIndices ( const PointIndicesConstPtr & indices ) [inline, inherited]

Provide a pointer to the vector of indices that represents the input data.

Parameters:

indices a pointer to the vector of indices that represents the input data.

Definition at line 135 of file pcl_base.h.

void pcl::PCLBase< PointInT >::setIndices	(	size_t	row_start,
		size_t	col_start,
		size_t	nb_rows,
		size_t	nb_cols
	)		`[inline, inherited]`

Set the indices for the points laying within an interest region of the point cloud.

Note:: you shouldn't call this method on unorganized point clouds!

Parameters:

row_start	the offset on rows
col_start	the offset on columns
nb_rows	the number of rows to be considered row_start included
nb_cols	the number of columns to be considered col_start included

Definition at line 151 of file pcl_base.h.

virtual void pcl::PCLBase< PointInT >::setInputCloud ( const PointCloudConstPtr & cloud ) [inline, virtual, inherited]

Provide a pointer to the input dataset.

Parameters:

cloud the const boost shared pointer to a PointCloud message

Definition at line 103 of file pcl_base.h.

void pcl::Feature< PointInT, pcl::MomentInvariants >::setKSearch ( int k ) [inline, inherited]

Set the number of k nearest neighbors to use for the feature estimation.

Parameters:

[in] k the number of k-nearest neighbors

Definition at line 182 of file feature.h.

void pcl::Feature< PointInT, pcl::MomentInvariants >::setRadiusSearch ( double radius ) [inline, inherited]

Set the sphere radius that is to be used for determining the nearest neighbors used for the feature estimation.

Parameters:

[in] radius the sphere radius used as the maximum distance to consider a point a neighbor

Definition at line 196 of file feature.h.

void pcl::Feature< PointInT, pcl::MomentInvariants >::setSearchMethod ( const KdTreePtr & tree ) [inline, inherited]

Provide a pointer to the search object.

Parameters:

[in] tree a pointer to the spatial search object.

Definition at line 162 of file feature.h.

void pcl::Feature< PointInT, pcl::MomentInvariants >::setSearchSurface ( const PointCloudInConstPtr & cloud ) [inline, inherited]

Provide a pointer to a dataset to add additional information to estimate the features for every point in the input dataset.

This is optional, if this is not set, it will only use the data in the input cloud to estimate the features. This is useful when you only need to compute the features for a downsampled cloud.

Parameters:

[in] cloud a pointer to a PointCloud message

Definition at line 144 of file feature.h.

The documentation for this class was generated from the following files:

/usr/src/RPM/BUILD/PCL-1.6.0-Source/features/include/pcl/features/moment_invariants.h
/usr/src/RPM/BUILD/PCL-1.6.0-Source/features/include/pcl/features/impl/moment_invariants.hpp

Public Types

Public Member Functions

Detailed Description

template<typename PointInT> class pcl::MomentInvariantsEstimation< PointInT, Eigen::MatrixXf >

Member Typedef Documentation

Member Function Documentation

template<typename PointInT>
class pcl::MomentInvariantsEstimation< PointInT, Eigen::MatrixXf >