Public Types | Public Member Functions

pcl::ConvexHull< PointInT > Class Template Reference
[Module surface]

ConvexHull using libqhull library. More...

#include <pcl/surface/convex_hull.h>

Inheritance diagram for pcl::ConvexHull< PointInT >:
Inheritance graph
[legend]
Collaboration diagram for pcl::ConvexHull< PointInT >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef pcl::PointCloud< PointInT > PointCloud
typedef PointCloud::Ptr PointCloudPtr
typedef PointCloud::ConstPtr PointCloudConstPtr
typedef PointIndices::Ptr PointIndicesPtr
typedef PointIndices::ConstPtr PointIndicesConstPtr

Public Member Functions

 ConvexHull ()
 Empty constructor.
void reconstruct (PointCloud &points, std::vector< pcl::Vertices > &polygons)
 Compute a convex hull for all points given.
void reconstruct (PointCloud &output)
 Compute a convex hull for all points given.
void setKeepInformation (bool value)
 If keep_information_is set to true the convex hull points keep other information like rgb, normals, ...
void setComputeAreaVolume (bool value)
 If set to true, the qhull library is called to compute the total area and volume of the convex hull.
double getTotalArea ()
 Returns the total area of the convex hull.
double getTotalVolume ()
 Returns the total volume of the convex hull.
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 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::ConvexHull< PointInT >

ConvexHull using libqhull library.

Author:
Aitor Aldoma

Definition at line 72 of file convex_hull.h.


Member Typedef Documentation

template<typename PointInT>
typedef pcl::PointCloud<PointInT> pcl::ConvexHull< PointInT >::PointCloud

Reimplemented from pcl::PCLBase< PointInT >.

Definition at line 80 of file convex_hull.h.

template<typename PointInT>
typedef PointCloud::ConstPtr pcl::ConvexHull< PointInT >::PointCloudConstPtr

Reimplemented from pcl::PCLBase< PointInT >.

Definition at line 82 of file convex_hull.h.

template<typename PointInT>
typedef PointCloud::Ptr pcl::ConvexHull< PointInT >::PointCloudPtr

Reimplemented from pcl::PCLBase< PointInT >.

Definition at line 81 of file convex_hull.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.


Constructor & Destructor Documentation

template<typename PointInT>
pcl::ConvexHull< PointInT >::ConvexHull (  )  [inline]

Empty constructor.

Definition at line 85 of file convex_hull.h.


Member Function Documentation

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

Get a pointer to the vector of indices used.

Definition at line 171 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 99 of file pcl_base.h.

template<typename PointInT>
double pcl::ConvexHull< PointInT >::getTotalArea (  )  [inline]

Returns the total area of the convex hull.

Definition at line 130 of file convex_hull.h.

template<typename PointInT>
double pcl::ConvexHull< PointInT >::getTotalVolume (  )  [inline]

Returns the total volume of the convex hull.

Only valid for 3-dimensional sets. For 2D-sets volume is zero.

Definition at line 139 of file convex_hull.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 178 of file pcl_base.h.

template<typename PointInT >
void pcl::ConvexHull< PointInT >::reconstruct ( PointCloud points,
std::vector< pcl::Vertices > &  polygons 
)

Compute a convex hull for all points given.

Parameters:
points the resultant points lying on the convex hull
polygons the resultant convex hull polygons, as a set of vertices. The Vertices structure contains an array of point indices.

Definition at line 420 of file convex_hull.hpp.

template<typename PointInT >
void pcl::ConvexHull< PointInT >::reconstruct ( PointCloud output  ) 

Compute a convex hull for all points given.

Parameters:
output the resultant convex hull vertices

Definition at line 398 of file convex_hull.hpp.

template<typename PointInT>
void pcl::ConvexHull< PointInT >::setComputeAreaVolume ( bool  value  )  [inline]

If set to true, the qhull library is called to compute the total area and volume of the convex hull.

NOTE: When this option is activated, the qhull library produces output to the console.

Parameters:
value wheter to compute the area and the volume, default is false

Definition at line 122 of file convex_hull.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 132 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 105 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 116 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 95 of file pcl_base.h.

template<typename PointInT>
void pcl::ConvexHull< PointInT >::setKeepInformation ( bool  value  )  [inline]

If keep_information_is set to true the convex hull points keep other information like rgb, normals, ...

Parameters:
value whether to keep information or not, default is false

Definition at line 112 of file convex_hull.h.


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