Point Cloud Library (PCL)  1.7.0
Public Types | Public Member Functions | Protected Member Functions
pcl::CropHull< PointT > Class Template Reference

Filter points that lie inside or outside a 3D closed surface or 2D closed polygon, as generated by the ConvexHull or ConcaveHull classes. More...

#include <pcl/filters/crop_hull.h>

+ Inheritance diagram for pcl::CropHull< PointT >:

List of all members.

Public Types

typedef boost::shared_ptr
< CropHull< PointT > > 
Ptr
typedef boost::shared_ptr
< const CropHull< PointT > > 
ConstPtr

Public Member Functions

 CropHull ()
 Empty Constructor.
void setHullIndices (const std::vector< Vertices > &polygons)
 Set the vertices of the hull used to filter points.
std::vector< VerticesgetHullIndices () const
 Get the vertices of the hull used to filter points.
void setHullCloud (PointCloudPtr points)
 Set the point cloud that the hull indices refer to.
PointCloudPtr getHullCloud () const
 Get the point cloud that the hull indices refer to.
void setDim (int dim)
 Set the dimensionality of the hull to be used.
void setCropOutside (bool crop_outside)
 Remove points outside the hull (default), or those inside the hull.

Protected Member Functions

void applyFilter (PointCloud &output)
 Filter the input points using the 2D or 3D polygon hull.
void applyFilter (std::vector< int > &indices)
 Filter the input points using the 2D or 3D polygon hull.

Detailed Description

template<typename PointT>
class pcl::CropHull< PointT >

Filter points that lie inside or outside a 3D closed surface or 2D closed polygon, as generated by the ConvexHull or ConcaveHull classes.

Author:
James Crosby

Definition at line 53 of file crop_hull.h.


Member Typedef Documentation

template<typename PointT >
typedef boost::shared_ptr< const CropHull<PointT> > pcl::CropHull< PointT >::ConstPtr

Reimplemented from pcl::FilterIndices< PointT >.

Definition at line 66 of file crop_hull.h.

template<typename PointT >
typedef boost::shared_ptr< CropHull<PointT> > pcl::CropHull< PointT >::Ptr

Reimplemented from pcl::FilterIndices< PointT >.

Definition at line 65 of file crop_hull.h.


Constructor & Destructor Documentation

template<typename PointT >
pcl::CropHull< PointT >::CropHull ( ) [inline]

Empty Constructor.

Definition at line 69 of file crop_hull.h.

References pcl::Filter< PointT >::filter_name_.


Member Function Documentation

template<typename PointT >
void pcl::CropHull< PointT >::applyFilter ( PointCloud output) [protected, virtual]

Filter the input points using the 2D or 3D polygon hull.

Parameters:
[out]outputThe set of points that passed the filter

Implements pcl::Filter< PointT >.

Definition at line 45 of file crop_hull.hpp.

template<typename PointT >
void pcl::CropHull< PointT >::applyFilter ( std::vector< int > &  indices) [protected, virtual]

Filter the input points using the 2D or 3D polygon hull.

Parameters:
[out]indicesthe indices of the set of points that passed the filter.

Implements pcl::FilterIndices< PointT >.

Definition at line 70 of file crop_hull.hpp.

template<typename PointT >
PointCloudPtr pcl::CropHull< PointT >::getHullCloud ( ) const [inline]

Get the point cloud that the hull indices refer to.

Definition at line 107 of file crop_hull.h.

template<typename PointT >
std::vector<Vertices> pcl::CropHull< PointT >::getHullIndices ( ) const [inline]

Get the vertices of the hull used to filter points.

Definition at line 91 of file crop_hull.h.

template<typename PointT >
void pcl::CropHull< PointT >::setCropOutside ( bool  crop_outside) [inline]

Remove points outside the hull (default), or those inside the hull.

Parameters:
[in]crop_outsideIf true, the filter will remove points outside the hull. If false, those inside will be removed.

Definition at line 129 of file crop_hull.h.

template<typename PointT >
void pcl::CropHull< PointT >::setDim ( int  dim) [inline]

Set the dimensionality of the hull to be used.

This should be set to correspond to the dimensionality of the convex/concave hull produced by the pcl::ConvexHull and pcl::ConcaveHull classes.

Parameters:
[in]dimDimensionailty of the hull used to filter points.

Definition at line 119 of file crop_hull.h.

template<typename PointT >
void pcl::CropHull< PointT >::setHullCloud ( PointCloudPtr  points) [inline]

Set the point cloud that the hull indices refer to.

Parameters:
[in]pointsthe point cloud that the hull indices refer to

Definition at line 100 of file crop_hull.h.

template<typename PointT >
void pcl::CropHull< PointT >::setHullIndices ( const std::vector< Vertices > &  polygons) [inline]

Set the vertices of the hull used to filter points.

Parameters:
[in]polygonsVector of polygons (Vertices structures) forming the hull used for filtering points.

Definition at line 83 of file crop_hull.h.


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