Point Cloud Library (PCL)  1.3.1
Public Types | Public Member Functions
pcl::NormalEstimation Class Reference

NormalEstimation estimates local surface properties at each 3D point, such as surface normals and curvatures. More...

#include <pcl/features/normal_3d.h>

Inheritance diagram for pcl::NormalEstimation:
Inheritance graph
[legend]
Collaboration diagram for pcl::NormalEstimation:
Collaboration graph
[legend]

List of all members.

Public Types

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

 NormalEstimation ()
 Empty constructor.
void computePointNormal (const pcl::PointCloud< PointInT > &cloud, const std::vector< int > &indices, Eigen::Vector4f &plane_parameters, float &curvature)
 Compute the Least-Squares plane fit for a given set of points, using their indices, and return the estimated plane parameters together with the surface curvature.
void computePointNormal (const pcl::PointCloud< PointInT > &cloud, const std::vector< int > &indices, float &nx, float &ny, float &nz, float &curvature)
 Compute the Least-Squares plane fit for a given set of points, using their indices, and return the estimated plane parameters together with the surface curvature.
void setViewPoint (float vpx, float vpy, float vpz)
 Set the viewpoint.
void getViewPoint (float &vpx, float &vpy, float &vpz)
 Get the viewpoint.
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 ()
 Get a pointer to the surface point cloud dataset.
void setSearchMethod (const KdTreePtr &tree)
 Provide a pointer to the search object.
KdTreePtr getSearchMethod ()
 Get a pointer to the search method used.
double getSearchParameter ()
 Get the internal search parameter.
void setKSearch (int k)
 Set the number of k nearest neighbors to use for the feature estimation.
int getKSearch ()
 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 ()
 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 ()
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.
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.

Detailed Description

NormalEstimation estimates local surface properties at each 3D point, such as surface normals and curvatures.

Note:
The code is stateful as we do not expect this class to be multicore parallelized. Please look at NormalEstimationOMP for a parallel implementation.
Author:
Radu Bogdan Rusu

Member Typedef Documentation

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

Definition at line 103 of file feature.h.

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

Reimplemented in pcl::FeatureFromNormals.

Definition at line 106 of file feature.h.

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

Definition at line 108 of file feature.h.

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

Definition at line 109 of file feature.h.

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

Definition at line 113 of file feature.h.

Definition at line 112 of file feature.h.

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

Reimplemented in pcl::NormalEstimationOMP.

Definition at line 198 of file normal_3d.h.

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

Reimplemented in pcl::FeatureFromNormals.

Definition at line 105 of file feature.h.

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

Definition at line 117 of file feature.h.

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

Definition at line 118 of file feature.h.


Constructor & Destructor Documentation

pcl::NormalEstimation::NormalEstimation ( ) [inline]

Empty constructor.

Definition at line 201 of file normal_3d.h.


Member Function Documentation

void pcl::Feature::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:
outputthe resultant point cloud model dataset containing the estimated features
void pcl::NormalEstimation::computePointNormal ( const pcl::PointCloud< PointInT > &  cloud,
const std::vector< int > &  indices,
Eigen::Vector4f &  plane_parameters,
float &  curvature 
) [inline]

Compute the Least-Squares plane fit for a given set of points, using their indices, and return the estimated plane parameters together with the surface curvature.

Parameters:
cloudthe input point cloud
indicesthe point cloud indices that need to be used
plane_parametersthe plane parameters as: a, b, c, d (ax + by + cz + d = 0)
curvaturethe estimated surface curvature as a measure of

\[ \lambda_0 / (\lambda_0 + \lambda_1 + \lambda_2) \]

Definition at line 217 of file normal_3d.h.

void pcl::NormalEstimation::computePointNormal ( const pcl::PointCloud< PointInT > &  cloud,
const std::vector< int > &  indices,
float &  nx,
float &  ny,
float &  nz,
float &  curvature 
) [inline]

Compute the Least-Squares plane fit for a given set of points, using their indices, and return the estimated plane parameters together with the surface curvature.

Parameters:
cloudthe input point cloud
indicesthe point cloud indices that need to be used
nxthe resultant X component of the plane normal
nythe resultant Y component of the plane normal
nzthe resultant Z component of the plane normal
curvaturethe estimated surface curvature as a measure of

\[ \lambda_0 / (\lambda_0 + \lambda_1 + \lambda_2) \]

Definition at line 248 of file normal_3d.h.

int pcl::Feature::getKSearch ( ) [inline, inherited]

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

Definition at line 166 of file feature.h.

double pcl::Feature::getRadiusSearch ( ) [inline, inherited]

Get the sphere radius used for determining the neighbors.

Definition at line 177 of file feature.h.

KdTreePtr pcl::Feature::getSearchMethod ( ) [inline, inherited]

Get a pointer to the search method used.

Definition at line 152 of file feature.h.

double pcl::Feature::getSearchParameter ( ) [inline, inherited]

Get the internal search parameter.

Definition at line 156 of file feature.h.

PointCloudInConstPtr pcl::Feature::getSearchSurface ( ) [inline, inherited]

Get a pointer to the surface point cloud dataset.

Definition at line 142 of file feature.h.

void pcl::NormalEstimation::getViewPoint ( float &  vpx,
float &  vpy,
float &  vpz 
) [inline]

Get the viewpoint.

Definition at line 280 of file normal_3d.h.

int pcl::Feature::searchForNeighbors ( size_t  index,
double  parameter,
std::vector< int > &  indices,
std::vector< float > &  distances 
) const [inline, inherited]

Search for k-nearest neighbors using the spatial locator from setSearchmethod, and the given surface from setSearchSurface.

Parameters:
indexthe index of the query point
parameterthe search parameter (either k or radius)
indicesthe resultant vector of indices representing the k-nearest neighbors
distancesthe resultant vector of distances representing the distances from the query point to the k-nearest neighbors

Definition at line 196 of file feature.h.

int pcl::Feature::searchForNeighbors ( const PointCloudIn cloud,
size_t  index,
double  parameter,
std::vector< int > &  indices,
std::vector< float > &  distances 
) const [inline, inherited]

Search for k-nearest neighbors using the spatial locator from setSearchmethod, and the given surface from setSearchSurface.

Parameters:
cloudthe query point cloud
indexthe index of the query point in cloud
parameterthe search parameter (either k or radius)
indicesthe resultant vector of indices representing the k-nearest neighbors
distancesthe resultant vector of distances representing the distances from the query point to the k-nearest neighbors

Definition at line 215 of file feature.h.

void pcl::Feature::setKSearch ( int  k) [inline, inherited]

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

Parameters:
kthe number of k-nearest neighbors

Definition at line 162 of file feature.h.

void pcl::Feature::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:
radiusthe sphere radius used as the maximum distance to consider a point a neighbor

Definition at line 173 of file feature.h.

void pcl::Feature::setSearchMethod ( const KdTreePtr tree) [inline, inherited]

Provide a pointer to the search object.

Parameters:
treea pointer to the spatial search object.

Definition at line 148 of file feature.h.

void pcl::Feature::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:
clouda pointer to a PointCloud message

Definition at line 133 of file feature.h.

void pcl::NormalEstimation::setViewPoint ( float  vpx,
float  vpy,
float  vpz 
) [inline]

Set the viewpoint.

Parameters:
vpxthe X coordinate of the viewpoint
vpythe Y coordinate of the viewpoint
vpzthe Z coordinate of the viewpoint

Definition at line 271 of file normal_3d.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines