Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Types
pcl::LabeledEuclideanClusterExtraction< PointT > Class Template Reference

LabeledEuclideanClusterExtraction represents a segmentation class for cluster extraction in an Euclidean sense, with label info. More...

#include <extract_labeled_clusters.h>

Inheritance diagram for pcl::LabeledEuclideanClusterExtraction< PointT >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef pcl::search::Search
< PointT
KdTree
typedef pcl::search::Search
< PointT >::Ptr 
KdTreePtr
typedef pcl::PointCloud< PointTPointCloud
typedef PointCloud::ConstPtr PointCloudConstPtr
typedef PointCloud::Ptr PointCloudPtr
typedef PointIndices::ConstPtr PointIndicesConstPtr
typedef PointIndices::Ptr PointIndicesPtr

Public Member Functions

void extract (std::vector< std::vector< PointIndices > > &labeled_clusters)
 Cluster extraction in a PointCloud given by <setInputCloud (), setIndices ()>
double getClusterTolerance () const
 Get the spatial cluster tolerance as a measure in the L2 Euclidean space.
int getMaxClusterSize () const
 Get the maximum number of points that a cluster needs to contain in order to be considered valid.
unsigned int getMaxLabels () const
 Get the maximum number of labels.
int getMinClusterSize () const
 Get the minimum number of points that a cluster needs to contain in order to be considered valid.
KdTreePtr getSearchMethod () const
 Get a pointer to the search method used.
 LabeledEuclideanClusterExtraction ()
 Empty constructor.
void setClusterTolerance (double tolerance)
 Set the spatial cluster tolerance as a measure in the L2 Euclidean space.
void setMaxClusterSize (int max_cluster_size)
 Set the maximum number of points that a cluster needs to contain in order to be considered valid.
void setMaxLabels (unsigned int max_label)
 Set the maximum number of labels in the cloud.
void setMinClusterSize (int min_cluster_size)
 Set the minimum number of points that a cluster needs to contain in order to be considered valid.
void setSearchMethod (const KdTreePtr &tree)
 Provide a pointer to the search object.

Protected Member Functions

virtual std::string getClassName () const
 Class getName method.

Protected Attributes

double cluster_tolerance_
 The spatial cluster tolerance as a measure in the L2 Euclidean space.
unsigned int max_label_
 The maximum number of labels we can find in this pointcloud (default = MAXINT)
int max_pts_per_cluster_
 The maximum number of points that a cluster needs to contain in order to be considered valid (default = MAXINT).
int min_pts_per_cluster_
 The minimum number of points that a cluster needs to contain in order to be considered valid (default = 1).
KdTreePtr tree_
 A pointer to the spatial search object.

Private Types

typedef PCLBase< PointTBasePCLBase

Detailed Description

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

LabeledEuclideanClusterExtraction represents a segmentation class for cluster extraction in an Euclidean sense, with label info.

Author:
Koen Buys

Definition at line 71 of file extract_labeled_clusters.h.


Member Typedef Documentation

template<typename PointT >
typedef PCLBase<PointT> pcl::LabeledEuclideanClusterExtraction< PointT >::BasePCLBase [private]

Definition at line 73 of file extract_labeled_clusters.h.

Definition at line 80 of file extract_labeled_clusters.h.

Definition at line 81 of file extract_labeled_clusters.h.

Reimplemented from pcl::PCLBase< PointT >.

Definition at line 76 of file extract_labeled_clusters.h.

Reimplemented from pcl::PCLBase< PointT >.

Definition at line 78 of file extract_labeled_clusters.h.

Reimplemented from pcl::PCLBase< PointT >.

Definition at line 77 of file extract_labeled_clusters.h.

Reimplemented from pcl::PCLBase< PointT >.

Definition at line 84 of file extract_labeled_clusters.h.

Reimplemented from pcl::PCLBase< PointT >.

Definition at line 83 of file extract_labeled_clusters.h.


Constructor & Destructor Documentation

Empty constructor.

Definition at line 88 of file extract_labeled_clusters.h.


Member Function Documentation

template<typename PointT >
void pcl::LabeledEuclideanClusterExtraction< PointT >::extract ( std::vector< std::vector< PointIndices > > &  labeled_clusters)

Cluster extraction in a PointCloud given by <setInputCloud (), setIndices ()>

Parameters:
[out]labeled_clustersthe resultant point clusters

Definition at line 123 of file extract_labeled_clusters.hpp.

template<typename PointT >
virtual std::string pcl::LabeledEuclideanClusterExtraction< PointT >::getClassName ( ) const [inline, protected, virtual]

Class getName method.

Definition at line 175 of file extract_labeled_clusters.h.

template<typename PointT >
double pcl::LabeledEuclideanClusterExtraction< PointT >::getClusterTolerance ( ) const [inline]

Get the spatial cluster tolerance as a measure in the L2 Euclidean space.

Definition at line 114 of file extract_labeled_clusters.h.

template<typename PointT >
int pcl::LabeledEuclideanClusterExtraction< PointT >::getMaxClusterSize ( ) const [inline]

Get the maximum number of points that a cluster needs to contain in order to be considered valid.

Definition at line 134 of file extract_labeled_clusters.h.

template<typename PointT >
unsigned int pcl::LabeledEuclideanClusterExtraction< PointT >::getMaxLabels ( ) const [inline]

Get the maximum number of labels.

Definition at line 144 of file extract_labeled_clusters.h.

template<typename PointT >
int pcl::LabeledEuclideanClusterExtraction< PointT >::getMinClusterSize ( ) const [inline]

Get the minimum number of points that a cluster needs to contain in order to be considered valid.

Definition at line 124 of file extract_labeled_clusters.h.

template<typename PointT >
KdTreePtr pcl::LabeledEuclideanClusterExtraction< PointT >::getSearchMethod ( ) const [inline]

Get a pointer to the search method used.

Definition at line 104 of file extract_labeled_clusters.h.

template<typename PointT >
void pcl::LabeledEuclideanClusterExtraction< PointT >::setClusterTolerance ( double  tolerance) [inline]

Set the spatial cluster tolerance as a measure in the L2 Euclidean space.

Parameters:
[in]tolerancethe spatial cluster tolerance as a measure in the L2 Euclidean space

Definition at line 110 of file extract_labeled_clusters.h.

template<typename PointT >
void pcl::LabeledEuclideanClusterExtraction< PointT >::setMaxClusterSize ( int  max_cluster_size) [inline]

Set the maximum number of points that a cluster needs to contain in order to be considered valid.

Parameters:
[in]max_cluster_sizethe maximum cluster size

Definition at line 130 of file extract_labeled_clusters.h.

template<typename PointT >
void pcl::LabeledEuclideanClusterExtraction< PointT >::setMaxLabels ( unsigned int  max_label) [inline]

Set the maximum number of labels in the cloud.

Parameters:
[in]max_labelthe maximum

Definition at line 140 of file extract_labeled_clusters.h.

template<typename PointT >
void pcl::LabeledEuclideanClusterExtraction< PointT >::setMinClusterSize ( int  min_cluster_size) [inline]

Set the minimum number of points that a cluster needs to contain in order to be considered valid.

Parameters:
[in]min_cluster_sizethe minimum cluster size

Definition at line 120 of file extract_labeled_clusters.h.

template<typename PointT >
void pcl::LabeledEuclideanClusterExtraction< PointT >::setSearchMethod ( const KdTreePtr tree) [inline]

Provide a pointer to the search object.

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

Definition at line 100 of file extract_labeled_clusters.h.


Member Data Documentation

template<typename PointT >
double pcl::LabeledEuclideanClusterExtraction< PointT >::cluster_tolerance_ [protected]

The spatial cluster tolerance as a measure in the L2 Euclidean space.

Definition at line 163 of file extract_labeled_clusters.h.

template<typename PointT >
unsigned int pcl::LabeledEuclideanClusterExtraction< PointT >::max_label_ [protected]

The maximum number of labels we can find in this pointcloud (default = MAXINT)

Definition at line 172 of file extract_labeled_clusters.h.

template<typename PointT >
int pcl::LabeledEuclideanClusterExtraction< PointT >::max_pts_per_cluster_ [protected]

The maximum number of points that a cluster needs to contain in order to be considered valid (default = MAXINT).

Definition at line 169 of file extract_labeled_clusters.h.

template<typename PointT >
int pcl::LabeledEuclideanClusterExtraction< PointT >::min_pts_per_cluster_ [protected]

The minimum number of points that a cluster needs to contain in order to be considered valid (default = 1).

Definition at line 166 of file extract_labeled_clusters.h.

template<typename PointT >
KdTreePtr pcl::LabeledEuclideanClusterExtraction< PointT >::tree_ [protected]

A pointer to the spatial search object.

Definition at line 160 of file extract_labeled_clusters.h.


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


pcl
Author(s): Open Perception
autogenerated on Wed Aug 26 2015 15:42:11