Point Cloud Library (PCL)  1.6.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions
pcl::BoundaryEstimation< PointInT, PointNT, Eigen::MatrixXf > Class Template Reference

BoundaryEstimation estimates whether a set of points is lying on surface boundaries using an angle criterion. More...

#include <pcl/features/boundary.h>

Inheritance diagram for pcl::BoundaryEstimation< PointInT, PointNT, Eigen::MatrixXf >:
Inheritance graph
[legend]
Collaboration diagram for pcl::BoundaryEstimation< PointInT, PointNT, Eigen::MatrixXf >:
Collaboration graph
[legend]

Public Types

typedef Feature< PointInT,
pcl::Boundary >::PointCloudOut 
PointCloudOut
 
typedef pcl::PointCloud< PointNT > PointCloudN
 
typedef PointCloudN::Ptr PointCloudNPtr
 
typedef PointCloudN::ConstPtr PointCloudNConstPtr
 
typedef boost::shared_ptr
< FeatureFromNormals< PointInT,
PointNT, pcl::Boundary > > 
Ptr
 
typedef boost::shared_ptr
< const FeatureFromNormals
< PointInT, PointNT,
pcl::Boundary > > 
ConstPtr
 
typedef PCLBase< PointInT > BaseClass
 
typedef pcl::search::Search
< PointInT > 
KdTree
 
typedef pcl::search::Search
< PointInT >::Ptr 
KdTreePtr
 
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

bool isBoundaryPoint (const pcl::PointCloud< PointInT > &cloud, int q_idx, const std::vector< int > &indices, const Eigen::Vector4f &u, const Eigen::Vector4f &v, const float angle_threshold)
 Check whether a point is a boundary point in a planar patch of projected points given by indices. More...
 
bool isBoundaryPoint (const pcl::PointCloud< PointInT > &cloud, const PointInT &q_point, const std::vector< int > &indices, const Eigen::Vector4f &u, const Eigen::Vector4f &v, const float angle_threshold)
 Check whether a point is a boundary point in a planar patch of projected points given by indices. More...
 
void setAngleThreshold (float angle)
 Set the decision boundary (angle threshold) that marks points as boundary or regular. More...
 
float getAngleThreshold ()
 Get the decision boundary (angle threshold) as set by the user. More...
 
void getCoordinateSystemOnPlane (const PointNT &p_coeff, Eigen::Vector4f &u, Eigen::Vector4f &v)
 Get a u-v-n coordinate system that lies on a plane defined by its normal. 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...
 
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...
 
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 () More...
 
virtual void setInputCloud (const PointCloudConstPtr &cloud)
 Provide a pointer to the input dataset. More...
 
PointCloudConstPtr const getInputCloud ()
 Get a pointer to the input point cloud dataset. More...
 
void setIndices (const IndicesPtr &indices)
 Provide a pointer to the vector of indices that represents the input data. More...
 
void setIndices (const IndicesConstPtr &indices)
 Provide a pointer to the vector of indices that represents the input data. More...
 
void setIndices (const PointIndicesConstPtr &indices)
 Provide a pointer to the vector of indices that represents the input data. More...
 
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...
 
const PointInT & operator[] (size_t pos)
 Override PointCloud operator[] to shorten code. More...
 

Detailed Description

template<typename PointInT, typename PointNT>
class pcl::BoundaryEstimation< PointInT, PointNT, Eigen::MatrixXf >

BoundaryEstimation estimates whether a set of points is lying on surface boundaries using an angle criterion.

The code makes use of the estimated surface normals at each point in the input dataset.

Attention
The convention for Boundary features is:
  • if a query point's nearest neighbors cannot be estimated, the boundary feature property will be set to NaN (not a number)
  • it is impossible to estimate a boundary property for a point that doesn't have finite 3D coordinates. Therefore, any point that contains NaN data on x, y, or z, will have its boundary feature property set to NaN.
Author
Radu B. Rusu

Definition at line 200 of file boundary.h.

Member Typedef Documentation

typedef PCLBase<PointInT> pcl::Feature< PointInT, pcl::Boundary >::BaseClass
inherited

Definition at line 110 of file feature.h.

typedef boost::shared_ptr< const FeatureFromNormals<PointInT, PointNT, pcl::Boundary > > pcl::FeatureFromNormals< PointInT, PointNT, pcl::Boundary >::ConstPtr
inherited

Definition at line 333 of file feature.h.

typedef pcl::search::Search<PointInT> pcl::Feature< PointInT, pcl::Boundary >::KdTree
inherited

Definition at line 115 of file feature.h.

typedef pcl::search::Search<PointInT>::Ptr pcl::Feature< PointInT, pcl::Boundary >::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

Definition at line 76 of file pcl_base.h.

typedef pcl::PointCloud<PointNT> pcl::FeatureFromNormals< PointInT, PointNT, pcl::Boundary >::PointCloudN
inherited

Definition at line 328 of file feature.h.

Definition at line 330 of file feature.h.

typedef PointCloudN::Ptr pcl::FeatureFromNormals< PointInT, PointNT, pcl::Boundary >::PointCloudNPtr
inherited

Definition at line 329 of file feature.h.

typedef Feature<PointInT, pcl::Boundary >::PointCloudOut pcl::BoundaryEstimation< PointInT, PointNT, pcl::Boundary >::PointCloudOut
inherited

Definition at line 94 of file boundary.h.

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

Definition at line 75 of file pcl_base.h.

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< FeatureFromNormals<PointInT, PointNT, pcl::Boundary > > pcl::FeatureFromNormals< PointInT, PointNT, pcl::Boundary >::Ptr
inherited

Definition at line 332 of file feature.h.

typedef boost::function<int (size_t, double, std::vector<int> &, std::vector<float> &)> pcl::Feature< PointInT, pcl::Boundary >::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::Boundary >::SearchMethodSurface
inherited

Definition at line 125 of file feature.h.

Member Function Documentation

void pcl::Feature< PointInT, pcl::Boundary >::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]outputthe resultant point cloud model dataset containing the estimated features
void pcl::Feature< PointInT, pcl::Boundary >::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]outputthe resultant point cloud model dataset containing the estimated features
float pcl::BoundaryEstimation< PointInT, PointNT, pcl::Boundary >::getAngleThreshold ( )
inlineinherited

Get the decision boundary (angle threshold) as set by the user.

Definition at line 146 of file boundary.h.

void pcl::BoundaryEstimation< PointInT, PointNT, pcl::Boundary >::getCoordinateSystemOnPlane ( const PointNT &  p_coeff,
Eigen::Vector4f &  u,
Eigen::Vector4f &  v 
)
inlineinherited

Get a u-v-n coordinate system that lies on a plane defined by its normal.

Parameters
[in]p_coeffthe plane coefficients (containing the plane normal)
[out]uthe resultant u direction
[out]vthe resultant v direction

Definition at line 157 of file boundary.h.

IndicesPtr const pcl::PCLBase< PointInT >::getIndices ( )
inlineinherited

Get a pointer to the vector of indices used.

Definition at line 190 of file pcl_base.h.

PointCloudConstPtr const pcl::PCLBase< PointInT >::getInputCloud ( )
inlineinherited

Get a pointer to the input point cloud dataset.

Definition at line 107 of file pcl_base.h.

PointCloudNConstPtr pcl::FeatureFromNormals< PointInT, PointNT, pcl::Boundary >::getInputNormals ( ) const
inlineinherited

Get a pointer to the normals of the input XYZ point cloud dataset.

Definition at line 355 of file feature.h.

int pcl::Feature< PointInT, pcl::Boundary >::getKSearch ( ) const
inlineinherited

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::Boundary >::getRadiusSearch ( ) const
inlineinherited

Get the sphere radius used for determining the neighbors.

Definition at line 203 of file feature.h.

KdTreePtr pcl::Feature< PointInT, pcl::Boundary >::getSearchMethod ( ) const
inlineinherited

Get a pointer to the search method used.

Definition at line 166 of file feature.h.

double pcl::Feature< PointInT, pcl::Boundary >::getSearchParameter ( ) const
inlineinherited

Get the internal search parameter.

Definition at line 173 of file feature.h.

PointCloudInConstPtr pcl::Feature< PointInT, pcl::Boundary >::getSearchSurface ( ) const
inlineinherited

Get a pointer to the surface point cloud dataset.

Definition at line 153 of file feature.h.

bool pcl::BoundaryEstimation< PointInT, PointNT, pcl::Boundary >::isBoundaryPoint ( const pcl::PointCloud< PointInT > &  cloud,
int  q_idx,
const std::vector< int > &  indices,
const Eigen::Vector4f &  u,
const Eigen::Vector4f &  v,
const float  angle_threshold 
)
inherited

Check whether a point is a boundary point in a planar patch of projected points given by indices.

Note
A coordinate system u-v-n must be computed a-priori using getCoordinateSystemOnPlane
Parameters
[in]clouda pointer to the input point cloud
[in]q_idxthe index of the query point in cloud
[in]indicesthe estimated point neighbors of the query point
[in]uthe u direction
[in]vthe v direction
[in]angle_thresholdthe threshold angle (default $\pi / 2.0$)
bool pcl::BoundaryEstimation< PointInT, PointNT, pcl::Boundary >::isBoundaryPoint ( const pcl::PointCloud< PointInT > &  cloud,
const PointInT &  q_point,
const std::vector< int > &  indices,
const Eigen::Vector4f &  u,
const Eigen::Vector4f &  v,
const float  angle_threshold 
)
inherited

Check whether a point is a boundary point in a planar patch of projected points given by indices.

Note
A coordinate system u-v-n must be computed a-priori using getCoordinateSystemOnPlane
Parameters
[in]clouda pointer to the input point cloud
[in]q_pointa pointer to the querry point
[in]indicesthe estimated point neighbors of the query point
[in]uthe u direction
[in]vthe v direction
[in]angle_thresholdthe threshold angle (default $\pi / 2.0$)
const PointInT & pcl::PCLBase< PointInT >::operator[] ( size_t  pos)
inlineinherited

Override PointCloud operator[] to shorten code.

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

Definition at line 197 of file pcl_base.h.

void pcl::BoundaryEstimation< PointInT, PointNT, pcl::Boundary >::setAngleThreshold ( float  angle)
inlineinherited

Set the decision boundary (angle threshold) that marks points as boundary or regular.

(default $\pi / 2.0$)

Parameters
[in]anglethe angle threshold

Definition at line 139 of file boundary.h.

void pcl::PCLBase< PointInT >::setIndices ( const IndicesPtr indices)
inlineinherited

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

Parameters
indicesa 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)
inlineinherited

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

Parameters
indicesa 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)
inlineinherited

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

Parameters
indicesa 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 
)
inlineinherited

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_startthe offset on rows
col_startthe offset on columns
nb_rowsthe number of rows to be considered row_start included
nb_colsthe 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)
inlinevirtualinherited

Provide a pointer to the input dataset.

Parameters
cloudthe const boost shared pointer to a PointCloud message

Definition at line 103 of file pcl_base.h.

void pcl::FeatureFromNormals< PointInT, PointNT, pcl::Boundary >::setInputNormals ( const PointCloudNConstPtr normals)
inlineinherited

Provide a pointer to the input dataset that contains the point normals of the XYZ dataset.

In case of search surface is set to be different from the input cloud, normals should correspond to the search surface, not the input cloud!

Parameters
[in]normalsthe const boost shared pointer to a PointCloud of normals. By convention, L2 norm of each normal should be 1.

Definition at line 351 of file feature.h.

void pcl::Feature< PointInT, pcl::Boundary >::setKSearch ( int  k)
inlineinherited

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

Parameters
[in]kthe number of k-nearest neighbors

Definition at line 182 of file feature.h.

void pcl::Feature< PointInT, pcl::Boundary >::setRadiusSearch ( double  radius)
inlineinherited

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

Parameters
[in]radiusthe 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::Boundary >::setSearchMethod ( const KdTreePtr tree)
inlineinherited

Provide a pointer to the search object.

Parameters
[in]treea pointer to the spatial search object.

Definition at line 162 of file feature.h.

void pcl::Feature< PointInT, pcl::Boundary >::setSearchSurface ( const PointCloudInConstPtr cloud)
inlineinherited

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]clouda pointer to a PointCloud message

Definition at line 144 of file feature.h.


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