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 | Public Attributes
pcl::FPFHEstimationOMP< PointInT, PointNT, PointOutT > Class Template Reference

FPFHEstimationOMP estimates the Fast Point Feature Histogram (FPFH) descriptor for a given point cloud dataset containing points and normals, in parallel, using the OpenMP standard. More...

#include <pcl/features/fpfh_omp.h>

Inheritance diagram for pcl::FPFHEstimationOMP< PointInT, PointNT, PointOutT >:
Inheritance graph
[legend]
Collaboration diagram for pcl::FPFHEstimationOMP< PointInT, PointNT, PointOutT >:
Collaboration graph
[legend]

Public Types

typedef Feature< PointInT,
PointOutT >::PointCloudOut 
PointCloudOut
 
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
 
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

 FPFHEstimationOMP ()
 Empty constructor. More...
 
 FPFHEstimationOMP (unsigned int nr_threads)
 Initialize the scheduler and set the number of threads to use. More...
 
void setNumberOfThreads (unsigned int nr_threads)
 Initialize the scheduler and set the number of threads to use. More...
 
bool computePairFeatures (const pcl::PointCloud< PointInT > &cloud, const pcl::PointCloud< PointNT > &normals, int p_idx, int q_idx, float &f1, float &f2, float &f3, float &f4)
 Compute the 4-tuple representation containing the three angles and one distance between two points represented by Cartesian coordinates and normals. More...
 
void computePointSPFHSignature (const pcl::PointCloud< PointInT > &cloud, const pcl::PointCloud< PointNT > &normals, int p_idx, int row, const std::vector< int > &indices, Eigen::MatrixXf &hist_f1, Eigen::MatrixXf &hist_f2, Eigen::MatrixXf &hist_f3)
 Estimate the SPFH (Simple Point Feature Histograms) individual signatures of the three angular (f1, f2, f3) features for a given point based on its spatial neighborhood of 3D points with normals. More...
 
void weightPointSPFHSignature (const Eigen::MatrixXf &hist_f1, const Eigen::MatrixXf &hist_f2, const Eigen::MatrixXf &hist_f3, const std::vector< int > &indices, const std::vector< float > &dists, Eigen::VectorXf &fpfh_histogram)
 Weight the SPFH (Simple Point Feature Histograms) individual histograms to create the final FPFH (Fast Point Feature Histogram) for a given point based on its 3D spatial neighborhood. More...
 
void setNrSubdivisions (int nr_bins_f1, int nr_bins_f2, int nr_bins_f3)
 Set the number of subdivisions for each angular feature interval. More...
 
void getNrSubdivisions (int &nr_bins_f1, int &nr_bins_f2, int &nr_bins_f3)
 Get the number of subdivisions for each angular feature interval. 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...
 

Public Attributes

int nr_bins_f1_
 The number of subdivisions for each angular feature interval. More...
 
int nr_bins_f2_
 
int nr_bins_f3_
 

Detailed Description

template<typename PointInT, typename PointNT, typename PointOutT>
class pcl::FPFHEstimationOMP< PointInT, PointNT, PointOutT >

FPFHEstimationOMP estimates the Fast Point Feature Histogram (FPFH) descriptor for a given point cloud dataset containing points and normals, in parallel, using the OpenMP standard.

Note
If you use this code in any academic work, please cite:
  • R.B. Rusu, N. Blodow, M. Beetz. Fast Point Feature Histograms (FPFH) for 3D Registration. In Proceedings of the IEEE International Conference on Robotics and Automation (ICRA), Kobe, Japan, May 12-17 2009.
  • R.B. Rusu, A. Holzbach, N. Blodow, M. Beetz. Fast Geometric Point Labeling using Conditional Random Fields. In Proceedings of the 22nd IEEE/RSJ International Conference on Intelligent Robots and Systems (IROS), St. Louis, MO, USA, October 11-15 2009.
Attention
The convention for FPFH features is:
  • if a query point's nearest neighbors cannot be estimated, the FPFH feature will be set to NaN (not a number)
  • it is impossible to estimate a FPFH descriptor 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 FPFH feature property set to NaN.
Author
Radu B. Rusu

Definition at line 72 of file fpfh_omp.h.

Member Typedef Documentation

template<typename PointInT, typename PointOutT>
typedef PCLBase<PointInT> pcl::Feature< PointInT, PointOutT >::BaseClass
inherited

Definition at line 110 of file feature.h.

template<typename PointInT, typename PointNT, typename PointOutT>
typedef boost::shared_ptr< const FeatureFromNormals<PointInT, PointNT, PointOutT> > pcl::FeatureFromNormals< PointInT, PointNT, PointOutT >::ConstPtr
inherited

Definition at line 333 of file feature.h.

template<typename PointInT, typename PointOutT>
typedef pcl::search::Search<PointInT> pcl::Feature< PointInT, PointOutT >::KdTree
inherited

Definition at line 115 of file feature.h.

template<typename PointInT, typename PointOutT>
typedef pcl::search::Search<PointInT>::Ptr pcl::Feature< PointInT, PointOutT >::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.

template<typename PointInT, typename PointNT, typename PointOutT>
typedef pcl::PointCloud<PointNT> pcl::FeatureFromNormals< PointInT, PointNT, PointOutT >::PointCloudN
inherited

Definition at line 328 of file feature.h.

template<typename PointInT, typename PointNT, typename PointOutT>
typedef PointCloudN::ConstPtr pcl::FeatureFromNormals< PointInT, PointNT, PointOutT >::PointCloudNConstPtr
inherited

Definition at line 330 of file feature.h.

template<typename PointInT, typename PointNT, typename PointOutT>
typedef PointCloudN::Ptr pcl::FeatureFromNormals< PointInT, PointNT, PointOutT >::PointCloudNPtr
inherited

Definition at line 329 of file feature.h.

template<typename PointInT , typename PointNT , typename PointOutT >
typedef Feature<PointInT, PointOutT>::PointCloudOut pcl::FPFHEstimationOMP< PointInT, PointNT, PointOutT >::PointCloudOut

Definition at line 88 of file fpfh_omp.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.

template<typename PointInT, typename PointNT, typename PointOutT>
typedef boost::shared_ptr< FeatureFromNormals<PointInT, PointNT, PointOutT> > pcl::FeatureFromNormals< PointInT, PointNT, PointOutT >::Ptr
inherited

Definition at line 332 of file feature.h.

template<typename PointInT, typename PointOutT>
typedef boost::function<int (size_t, double, std::vector<int> &, std::vector<float> &)> pcl::Feature< PointInT, PointOutT >::SearchMethod
inherited

Definition at line 124 of file feature.h.

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

Definition at line 125 of file feature.h.

Constructor & Destructor Documentation

template<typename PointInT , typename PointNT , typename PointOutT >
pcl::FPFHEstimationOMP< PointInT, PointNT, PointOutT >::FPFHEstimationOMP ( )
inline

Empty constructor.

Definition at line 91 of file fpfh_omp.h.

template<typename PointInT , typename PointNT , typename PointOutT >
pcl::FPFHEstimationOMP< PointInT, PointNT, PointOutT >::FPFHEstimationOMP ( unsigned int  nr_threads)
inline

Initialize the scheduler and set the number of threads to use.

Parameters
[in]nr_threadsthe number of hardware threads to use (-1 sets the value back to automatic)

Definition at line 99 of file fpfh_omp.h.

Member Function Documentation

template<typename PointInT , typename PointOutT >
void pcl::Feature< PointInT, PointOutT >::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

Definition at line 188 of file feature.hpp.

template<typename PointInT , typename PointOutT >
void pcl::Feature< PointInT, PointOutT >::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

Definition at line 224 of file feature.hpp.

template<typename PointInT, typename PointNT, typename PointOutT >
bool pcl::FPFHEstimation< PointInT, PointNT, PointOutT >::computePairFeatures ( const pcl::PointCloud< PointInT > &  cloud,
const pcl::PointCloud< PointNT > &  normals,
int  p_idx,
int  q_idx,
float &  f1,
float &  f2,
float &  f3,
float &  f4 
)
inherited

Compute the 4-tuple representation containing the three angles and one distance between two points represented by Cartesian coordinates and normals.

Note
For explanations about the features, please see the literature mentioned above (the order of the features might be different).
Parameters
[in]cloudthe dataset containing the XYZ Cartesian coordinates of the two points
[in]normalsthe dataset containing the surface normals (assuming normalized vectors) at each point in cloud
[in]p_idxthe index of the first point (source)
[in]q_idxthe index of the second point (target)
[out]f1the first angular feature (angle between the projection of nq_idx and u)
[out]f2the second angular feature (angle between nq_idx and v)
[out]f3the third angular feature (angle between np_idx and |p_idx - q_idx|)
[out]f4the distance feature (p_idx - q_idx)

Definition at line 48 of file fpfh.hpp.

template<typename PointInT, typename PointNT, typename PointOutT >
void pcl::FPFHEstimation< PointInT, PointNT, PointOutT >::computePointSPFHSignature ( const pcl::PointCloud< PointInT > &  cloud,
const pcl::PointCloud< PointNT > &  normals,
int  p_idx,
int  row,
const std::vector< int > &  indices,
Eigen::MatrixXf &  hist_f1,
Eigen::MatrixXf &  hist_f2,
Eigen::MatrixXf &  hist_f3 
)
inherited

Estimate the SPFH (Simple Point Feature Histograms) individual signatures of the three angular (f1, f2, f3) features for a given point based on its spatial neighborhood of 3D points with normals.

Parameters
[in]cloudthe dataset containing the XYZ Cartesian coordinates of the two points
[in]normalsthe dataset containing the surface normals at each point in cloud
[in]p_idxthe index of the query point (source)
[in]rowthe index row in feature histogramms
[in]indicesthe k-neighborhood point indices in the dataset
[out]hist_f1the resultant SPFH histogram for feature f1
[out]hist_f2the resultant SPFH histogram for feature f2
[out]hist_f3the resultant SPFH histogram for feature f3

Definition at line 60 of file fpfh.hpp.

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.

template<typename PointInT, typename PointNT, typename PointOutT>
PointCloudNConstPtr pcl::FeatureFromNormals< PointInT, PointNT, PointOutT >::getInputNormals ( ) const
inlineinherited

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

Definition at line 355 of file feature.h.

template<typename PointInT, typename PointOutT>
int pcl::Feature< PointInT, PointOutT >::getKSearch ( ) const
inlineinherited

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

Definition at line 186 of file feature.h.

template<typename PointInT, typename PointNT, typename PointOutT = pcl::FPFHSignature33>
void pcl::FPFHEstimation< PointInT, PointNT, PointOutT >::getNrSubdivisions ( int &  nr_bins_f1,
int &  nr_bins_f2,
int &  nr_bins_f3 
)
inlineinherited

Get the number of subdivisions for each angular feature interval.

Parameters
[out]nr_bins_f1number of subdivisions for the first angular feature
[out]nr_bins_f2number of subdivisions for the second angular feature
[out]nr_bins_f3number of subdivisions for the third angular feature

Definition at line 172 of file fpfh.h.

template<typename PointInT, typename PointOutT>
double pcl::Feature< PointInT, PointOutT >::getRadiusSearch ( ) const
inlineinherited

Get the sphere radius used for determining the neighbors.

Definition at line 203 of file feature.h.

template<typename PointInT, typename PointOutT>
KdTreePtr pcl::Feature< PointInT, PointOutT >::getSearchMethod ( ) const
inlineinherited

Get a pointer to the search method used.

Definition at line 166 of file feature.h.

template<typename PointInT, typename PointOutT>
double pcl::Feature< PointInT, PointOutT >::getSearchParameter ( ) const
inlineinherited

Get the internal search parameter.

Definition at line 173 of file feature.h.

template<typename PointInT, typename PointOutT>
PointCloudInConstPtr pcl::Feature< PointInT, PointOutT >::getSearchSurface ( ) const
inlineinherited

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)
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::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.

template<typename PointInT, typename PointNT, typename PointOutT>
void pcl::FeatureFromNormals< PointInT, PointNT, PointOutT >::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.

template<typename PointInT, typename PointOutT>
void pcl::Feature< PointInT, PointOutT >::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.

template<typename PointInT, typename PointNT, typename PointOutT = pcl::FPFHSignature33>
void pcl::FPFHEstimation< PointInT, PointNT, PointOutT >::setNrSubdivisions ( int  nr_bins_f1,
int  nr_bins_f2,
int  nr_bins_f3 
)
inlineinherited

Set the number of subdivisions for each angular feature interval.

Parameters
[in]nr_bins_f1number of subdivisions for the first angular feature
[in]nr_bins_f2number of subdivisions for the second angular feature
[in]nr_bins_f3number of subdivisions for the third angular feature

Definition at line 159 of file fpfh.h.

template<typename PointInT , typename PointNT , typename PointOutT >
void pcl::FPFHEstimationOMP< PointInT, PointNT, PointOutT >::setNumberOfThreads ( unsigned int  nr_threads)
inline

Initialize the scheduler and set the number of threads to use.

Parameters
[in]nr_threadsthe number of hardware threads to use (-1 sets the value back to automatic)

Definition at line 108 of file fpfh_omp.h.

template<typename PointInT, typename PointOutT>
void pcl::Feature< PointInT, PointOutT >::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.

template<typename PointInT, typename PointOutT>
void pcl::Feature< PointInT, PointOutT >::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.

template<typename PointInT, typename PointOutT>
void pcl::Feature< PointInT, PointOutT >::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.

template<typename PointInT , typename PointNT , typename PointOutT >
void pcl::FPFHEstimation< PointInT, PointNT, PointOutT >::weightPointSPFHSignature ( const Eigen::MatrixXf &  hist_f1,
const Eigen::MatrixXf &  hist_f2,
const Eigen::MatrixXf &  hist_f3,
const std::vector< int > &  indices,
const std::vector< float > &  dists,
Eigen::VectorXf &  fpfh_histogram 
)
inherited

Weight the SPFH (Simple Point Feature Histograms) individual histograms to create the final FPFH (Fast Point Feature Histogram) for a given point based on its 3D spatial neighborhood.

Parameters
[in]hist_f1the histogram feature vector of f1 values over the given patch
[in]hist_f2the histogram feature vector of f2 values over the given patch
[in]hist_f3the histogram feature vector of f3 values over the given patch
[in]indicesthe point indices of p_idx's k-neighborhood in the point cloud
[in]diststhe distances from p_idx to all its k-neighbors
[out]fpfh_histogramthe resultant FPFH histogram representing the feature at the query point

Definition at line 105 of file fpfh.hpp.

Member Data Documentation

template<typename PointInT , typename PointNT , typename PointOutT >
int pcl::FPFHEstimationOMP< PointInT, PointNT, PointOutT >::nr_bins_f1_

The number of subdivisions for each angular feature interval.

Definition at line 126 of file fpfh_omp.h.

template<typename PointInT , typename PointNT , typename PointOutT >
int pcl::FPFHEstimationOMP< PointInT, PointNT, PointOutT >::nr_bins_f2_

Definition at line 126 of file fpfh_omp.h.

template<typename PointInT , typename PointNT , typename PointOutT >
int pcl::FPFHEstimationOMP< PointInT, PointNT, PointOutT >::nr_bins_f3_

Definition at line 126 of file fpfh_omp.h.


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