Point Cloud Library (PCL)  1.8.1-dev
List of all members | Public Types | Public Member Functions | Protected Member Functions
pcl::PrincipalCurvaturesEstimation< PointInT, PointNT, PointOutT > Class Template Reference

PrincipalCurvaturesEstimation estimates the directions (eigenvectors) and magnitudes (eigenvalues) of principal surface curvatures for a given point cloud dataset containing points and normals. More...

#include <pcl/features/principal_curvatures.h>

+ Inheritance diagram for pcl::PrincipalCurvaturesEstimation< PointInT, PointNT, PointOutT >:

Public Types

typedef boost::shared_ptr
< PrincipalCurvaturesEstimation
< PointInT, PointNT, PointOutT > > 
Ptr
 
typedef boost::shared_ptr
< const
PrincipalCurvaturesEstimation
< PointInT, PointNT, PointOutT > > 
ConstPtr
 
typedef Feature< PointInT,
PointOutT >::PointCloudOut 
PointCloudOut
 
typedef pcl::PointCloud< PointInT > PointCloudIn
 
- Public Types inherited from pcl::FeatureFromNormals< PointInT, PointNT, PointOutT >
typedef pcl::PointCloud< PointNT > PointCloudN
 
typedef PointCloudN::Ptr PointCloudNPtr
 
typedef PointCloudN::ConstPtr PointCloudNConstPtr
 
typedef boost::shared_ptr
< FeatureFromNormals< PointInT,
PointNT, PointOutT > > 
Ptr
 
typedef boost::shared_ptr
< const FeatureFromNormals
< PointInT, PointNT, PointOutT > > 
ConstPtr
 
- Public Types inherited from pcl::Feature< PointInT, PointOutT >
typedef PCLBase< PointInT > BaseClass
 
typedef boost::shared_ptr
< Feature< PointInT, PointOutT > > 
Ptr
 
typedef boost::shared_ptr
< const Feature< PointInT,
PointOutT > > 
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 pcl::PointCloud
< PointOutT > 
PointCloudOut
 
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
 
- Public Types inherited from pcl::PCLBase< PointInT >
typedef pcl::PointCloud< PointInT > PointCloud
 
typedef PointCloud::Ptr PointCloudPtr
 
typedef PointCloud::ConstPtr PointCloudConstPtr
 
typedef boost::shared_ptr
< PointIndices
PointIndicesPtr
 
typedef boost::shared_ptr
< PointIndices const > 
PointIndicesConstPtr
 

Public Member Functions

 PrincipalCurvaturesEstimation ()
 Empty constructor. More...
 
void computePointPrincipalCurvatures (const pcl::PointCloud< PointNT > &normals, int p_idx, const std::vector< int > &indices, float &pcx, float &pcy, float &pcz, float &pc1, float &pc2)
 Perform Principal Components Analysis (PCA) on the point normals of a surface patch in the tangent plane of the given point normal, and return the principal curvature (eigenvector of the max eigenvalue), along with both the max (pc1) and min (pc2) eigenvalues. More...
 
- Public Member Functions inherited from pcl::FeatureFromNormals< PointInT, PointNT, PointOutT >
 FeatureFromNormals ()
 Empty constructor. More...
 
virtual ~FeatureFromNormals ()
 Empty destructor. More...
 
void setInputNormals (const PointCloudNConstPtr &normals)
 Provide a pointer to the input dataset that contains the point normals of the XYZ dataset. More...
 
PointCloudNConstPtr getInputNormals () const
 Get a pointer to the normals of the input XYZ point cloud dataset. More...
 
- Public Member Functions inherited from pcl::Feature< PointInT, PointOutT >
 Feature ()
 Empty constructor. More...
 
virtual ~Feature ()
 Empty destructor. More...
 
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. More...
 
PointCloudInConstPtr getSearchSurface () const
 Get a pointer to the surface point cloud dataset. More...
 
void setSearchMethod (const KdTreePtr &tree)
 Provide a pointer to the search object. More...
 
KdTreePtr getSearchMethod () const
 Get a pointer to the search method used. More...
 
double getSearchParameter () const
 Get the internal search parameter. More...
 
void setKSearch (int k)
 Set the number of k nearest neighbors to use for the feature estimation. More...
 
int getKSearch () const
 get the number of k nearest neighbors used for the feature estimation. More...
 
void setRadiusSearch (double radius)
 Set the sphere radius that is to be used for determining the nearest neighbors used for the feature estimation. More...
 
double getRadiusSearch () const
 Get the sphere radius used for determining the neighbors. More...
 
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 () More...
 
- Public Member Functions inherited from pcl::PCLBase< PointInT >
 PCLBase ()
 Empty constructor. More...
 
 PCLBase (const PCLBase &base)
 Copy constructor. More...
 
virtual ~PCLBase ()
 Destructor. More...
 
virtual void setInputCloud (const PointCloudConstPtr &cloud)
 Provide a pointer to the input dataset. More...
 
PointCloudConstPtr const getInputCloud () const
 Get a pointer to the input point cloud dataset. More...
 
virtual void setIndices (const IndicesPtr &indices)
 Provide a pointer to the vector of indices that represents the input data. More...
 
virtual void setIndices (const IndicesConstPtr &indices)
 Provide a pointer to the vector of indices that represents the input data. More...
 
virtual void setIndices (const PointIndicesConstPtr &indices)
 Provide a pointer to the vector of indices that represents the input data. More...
 
virtual 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. More...
 
IndicesPtr const getIndices ()
 Get a pointer to the vector of indices used. More...
 
IndicesConstPtr const getIndices () const
 Get a pointer to the vector of indices used. More...
 
const PointInT & operator[] (size_t pos) const
 Override PointCloud operator[] to shorten code. More...
 

Protected Member Functions

void computeFeature (PointCloudOut &output)
 Estimate the principal curvature (eigenvector of the max eigenvalue), along with both the max (pc1) and min (pc2) eigenvalues for all points given in <setInputCloud (), setIndices ()> using the surface in setSearchSurface () and the spatial locator in setSearchMethod () More...
 
- Protected Member Functions inherited from pcl::FeatureFromNormals< PointInT, PointNT, PointOutT >
virtual bool initCompute ()
 This method should get called before starting the actual computation. More...
 
- Protected Member Functions inherited from pcl::Feature< PointInT, PointOutT >
const std::string & getClassName () const
 Get a string representation of the name of this class. More...
 
virtual bool deinitCompute ()
 This method should get called after ending the actual computation. More...
 
int searchForNeighbors (size_t index, double parameter, std::vector< int > &indices, std::vector< float > &distances) const
 Search for k-nearest neighbors using the spatial locator from setSearchmethod, and the given surface from setSearchSurface. More...
 
int searchForNeighbors (const PointCloudIn &cloud, size_t index, double parameter, std::vector< int > &indices, std::vector< float > &distances) const
 Search for k-nearest neighbors using the spatial locator from setSearchmethod, and the given surface from setSearchSurface. More...
 
- Protected Member Functions inherited from pcl::PCLBase< PointInT >
bool initCompute ()
 This method should get called before starting the actual computation. More...
 
bool deinitCompute ()
 This method should get called after finishing the actual computation. More...
 

Additional Inherited Members

- Protected Attributes inherited from pcl::FeatureFromNormals< PointInT, PointNT, PointOutT >
PointCloudNConstPtr normals_
 A pointer to the input dataset that contains the point normals of the XYZ dataset. More...
 
- Protected Attributes inherited from pcl::Feature< PointInT, PointOutT >
std::string feature_name_
 The feature name. More...
 
SearchMethodSurface search_method_surface_
 The search method template for points. More...
 
PointCloudInConstPtr surface_
 An input point cloud describing the surface that is to be used for nearest neighbors estimation. More...
 
KdTreePtr tree_
 A pointer to the spatial search object. More...
 
double search_parameter_
 The actual search parameter (from either search_radius_ or k_). More...
 
double search_radius_
 The nearest neighbors search radius for each point. More...
 
int k_
 The number of K nearest neighbors to use for each point. More...
 
bool fake_surface_
 If no surface is given, we use the input PointCloud as the surface. More...
 
- Protected Attributes inherited from pcl::PCLBase< PointInT >
PointCloudConstPtr input_
 The input point cloud dataset. More...
 
IndicesPtr indices_
 A pointer to the vector of point indices to use. More...
 
bool use_indices_
 Set to true if point indices are used. More...
 
bool fake_indices_
 If no set of indices are given, we construct a set of fake indices that mimic the input PointCloud. More...
 

Detailed Description

template<typename PointInT, typename PointNT, typename PointOutT = pcl::PrincipalCurvatures>
class pcl::PrincipalCurvaturesEstimation< PointInT, PointNT, PointOutT >

PrincipalCurvaturesEstimation estimates the directions (eigenvectors) and magnitudes (eigenvalues) of principal surface curvatures for a given point cloud dataset containing points and normals.

The recommended PointOutT is pcl::PrincipalCurvatures.

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, Jared Glover

Definition at line 61 of file principal_curvatures.h.

Member Typedef Documentation

template<typename PointInT , typename PointNT , typename PointOutT = pcl::PrincipalCurvatures>
typedef boost::shared_ptr<const PrincipalCurvaturesEstimation<PointInT, PointNT, PointOutT> > pcl::PrincipalCurvaturesEstimation< PointInT, PointNT, PointOutT >::ConstPtr

Definition at line 65 of file principal_curvatures.h.

template<typename PointInT , typename PointNT , typename PointOutT = pcl::PrincipalCurvatures>
typedef pcl::PointCloud<PointInT> pcl::PrincipalCurvaturesEstimation< PointInT, PointNT, PointOutT >::PointCloudIn

Definition at line 76 of file principal_curvatures.h.

template<typename PointInT , typename PointNT , typename PointOutT = pcl::PrincipalCurvatures>
typedef Feature<PointInT, PointOutT>::PointCloudOut pcl::PrincipalCurvaturesEstimation< PointInT, PointNT, PointOutT >::PointCloudOut

Definition at line 75 of file principal_curvatures.h.

template<typename PointInT , typename PointNT , typename PointOutT = pcl::PrincipalCurvatures>
typedef boost::shared_ptr<PrincipalCurvaturesEstimation<PointInT, PointNT, PointOutT> > pcl::PrincipalCurvaturesEstimation< PointInT, PointNT, PointOutT >::Ptr

Definition at line 64 of file principal_curvatures.h.

Constructor & Destructor Documentation

template<typename PointInT , typename PointNT , typename PointOutT = pcl::PrincipalCurvatures>
pcl::PrincipalCurvaturesEstimation< PointInT, PointNT, PointOutT >::PrincipalCurvaturesEstimation ( )
inline

Empty constructor.

Definition at line 79 of file principal_curvatures.h.

References pcl::Feature< PointInT, PointOutT >::feature_name_.

Member Function Documentation

template<typename PointInT , typename PointNT , typename PointOutT >
void pcl::PrincipalCurvaturesEstimation< PointInT, PointNT, PointOutT >::computeFeature ( PointCloudOut output)
protectedvirtual

Estimate the principal curvature (eigenvector of the max eigenvalue), along with both the max (pc1) and min (pc2) eigenvalues for all points given in <setInputCloud (), setIndices ()> using the surface in setSearchSurface () and the spatial locator in setSearchMethod ()

Parameters
[out]outputthe resultant point cloud model dataset that contains the principal curvature estimates

Implements pcl::Feature< PointInT, PointOutT >.

Definition at line 114 of file principal_curvatures.hpp.

References pcl::PointCloud< T >::is_dense, pcl::isFinite(), and pcl::PointCloud< T >::points.

template<typename PointInT , typename PointNT , typename PointOutT >
void pcl::PrincipalCurvaturesEstimation< PointInT, PointNT, PointOutT >::computePointPrincipalCurvatures ( const pcl::PointCloud< PointNT > &  normals,
int  p_idx,
const std::vector< int > &  indices,
float &  pcx,
float &  pcy,
float &  pcz,
float &  pc1,
float &  pc2 
)

Perform Principal Components Analysis (PCA) on the point normals of a surface patch in the tangent plane of the given point normal, and return the principal curvature (eigenvector of the max eigenvalue), along with both the max (pc1) and min (pc2) eigenvalues.

Parameters
[in]normalsthe point cloud normals
[in]p_idxthe query point at which the least-squares plane was estimated
[in]indicesthe point cloud indices that need to be used
[out]pcxthe principal curvature X direction
[out]pcythe principal curvature Y direction
[out]pczthe principal curvature Z direction
[out]pc1the max eigenvalue of curvature
[out]pc2the min eigenvalue of curvature

Definition at line 48 of file principal_curvatures.hpp.

References pcl::computeCorrespondingEigenVector(), pcl::eigen33(), pcl::EIGEN_ALIGN16, and pcl::PointCloud< T >::points.


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