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

#include <pcl/segmentation/extract_labeled_clusters.h>

Inheritance diagram for pcl::LabeledEuclideanClusterExtraction< PointT >:

Public Types
typedef pcl::PointCloud< PointT >	PointCloud
typedef PointCloud::Ptr	PointCloudPtr
typedef PointCloud::ConstPtr	PointCloudConstPtr
typedef pcl::search::Search < PointT >	KdTree
typedef pcl::search::Search < PointT >::Ptr	KdTreePtr
typedef PointIndices::Ptr	PointIndicesPtr
typedef PointIndices::ConstPtr	PointIndicesConstPtr
Public Types inherited from pcl::PCLBase< PointT >
typedef pcl::PointCloud< PointT >	PointCloud
typedef PointCloud::Ptr	PointCloudPtr
typedef PointCloud::ConstPtr	PointCloudConstPtr
typedef boost::shared_ptr < PointIndices >	PointIndicesPtr
typedef boost::shared_ptr < PointIndices const >	PointIndicesConstPtr

Public Member Functions
	LabeledEuclideanClusterExtraction ()
	Empty constructor.
void	setSearchMethod (const KdTreePtr &tree)
	Provide a pointer to the search object.
KdTreePtr	getSearchMethod () const
	Get a pointer to the search method used.
void	setClusterTolerance (double tolerance)
	Set the spatial cluster tolerance as a measure in the L2 Euclidean space.
double	getClusterTolerance () const
	Get the spatial cluster tolerance as a measure in the L2 Euclidean space.
void	setMinClusterSize (int min_cluster_size)
	Set the minimum number of points that a cluster needs to contain in order to be considered valid.
int	getMinClusterSize () const
	Get the minimum number of points that a cluster needs to contain in order to be considered valid.
void	setMaxClusterSize (int max_cluster_size)
	Set the maximum number of points that a cluster needs to contain in order to be considered valid.
int	getMaxClusterSize () const
	Get 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.
unsigned int	getMaxLabels () const
	Get the maximum number of labels.
void	extract (std::vector< std::vector< PointIndices > > &labeled_clusters)
	Cluster extraction in a PointCloud given by <setInputCloud (), setIndices ()>
Public Member Functions inherited from pcl::PCLBase< PointT >
	PCLBase ()
	Empty constructor.
	PCLBase (const PCLBase &base)
	Copy constructor.
virtual	~PCLBase ()
	Destructor.
virtual void	setInputCloud (const PointCloudConstPtr &cloud)
	Provide a pointer to the input dataset.
PointCloudConstPtr const	getInputCloud () const
	Get a pointer to the input point cloud dataset.
virtual void	setIndices (const IndicesPtr &indices)
	Provide a pointer to the vector of indices that represents the input data.
virtual void	setIndices (const IndicesConstPtr &indices)
	Provide a pointer to the vector of indices that represents the input data.
virtual void	setIndices (const PointIndicesConstPtr &indices)
	Provide a pointer to the vector of indices that represents the input data.
virtual 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.
IndicesConstPtr const	getIndices () const
	Get a pointer to the vector of indices used.
const PointT &	operator[] (size_t pos) const
	Override PointCloud operator[] to shorten code.

Protected Member Functions
virtual std::string	getClassName () const
	Class getName method.
Protected Member Functions inherited from pcl::PCLBase< PointT >
bool	initCompute ()
	This method should get called before starting the actual computation.
bool	deinitCompute ()
	This method should get called after finishing the actual computation.

Protected Attributes
KdTreePtr	tree_
	A pointer to the spatial search object.
double	cluster_tolerance_
	The spatial cluster tolerance as a measure in the L2 Euclidean space.
int	min_pts_per_cluster_
	The minimum number of points that a cluster needs to contain in order to be considered valid (default = 1).
int	max_pts_per_cluster_
	The maximum number of points that a cluster needs to contain in order to be considered valid (default = MAXINT).
unsigned int	max_label_
	The maximum number of labels we can find in this pointcloud (default = MAXINT)
Protected Attributes inherited from pcl::PCLBase< PointT >
PointCloudConstPtr	input_
	The input point cloud dataset.
IndicesPtr	indices_
	A pointer to the vector of point indices to use.
bool	use_indices_
	Set to true if point indices are used.
bool	fake_indices_
	If no set of indices are given, we construct a set of fake indices that mimic the input PointCloud.

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 pcl::search::Search<PointT> pcl::LabeledEuclideanClusterExtraction< PointT >::KdTree

Definition at line 80 of file extract_labeled_clusters.h.

template<typename PointT >

typedef pcl::search::Search<PointT>::Ptr pcl::LabeledEuclideanClusterExtraction< PointT >::KdTreePtr

Definition at line 81 of file extract_labeled_clusters.h.

template<typename PointT >

typedef pcl::PointCloud<PointT> pcl::LabeledEuclideanClusterExtraction< PointT >::PointCloud

Definition at line 76 of file extract_labeled_clusters.h.

template<typename PointT >

typedef PointCloud::ConstPtr pcl::LabeledEuclideanClusterExtraction< PointT >::PointCloudConstPtr

Definition at line 78 of file extract_labeled_clusters.h.

template<typename PointT >

typedef PointCloud::Ptr pcl::LabeledEuclideanClusterExtraction< PointT >::PointCloudPtr

Definition at line 77 of file extract_labeled_clusters.h.

template<typename PointT >

typedef PointIndices::ConstPtr pcl::LabeledEuclideanClusterExtraction< PointT >::PointIndicesConstPtr

Definition at line 84 of file extract_labeled_clusters.h.

template<typename PointT >

typedef PointIndices::Ptr pcl::LabeledEuclideanClusterExtraction< PointT >::PointIndicesPtr

Definition at line 83 of file extract_labeled_clusters.h.

Constructor & Destructor Documentation

template<typename PointT >

pcl::LabeledEuclideanClusterExtraction< PointT >::LabeledEuclideanClusterExtraction ( )

inline

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_clusters the resultant point clusters

Definition at line 123 of file extract_labeled_clusters.hpp.

References pcl::comparePointClusters(), and pcl::extractLabeledEuclideanClusters().

template<typename PointT >

virtual std::string pcl::LabeledEuclideanClusterExtraction< PointT >::getClassName ( ) const

inlineprotectedvirtual

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.

References pcl::LabeledEuclideanClusterExtraction< PointT >::cluster_tolerance_.

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.

References pcl::LabeledEuclideanClusterExtraction< PointT >::max_pts_per_cluster_.

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.

References pcl::LabeledEuclideanClusterExtraction< PointT >::max_label_.

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.

References pcl::LabeledEuclideanClusterExtraction< PointT >::min_pts_per_cluster_.

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.

References pcl::LabeledEuclideanClusterExtraction< PointT >::tree_.

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] tolerance the spatial cluster tolerance as a measure in the L2 Euclidean space

Definition at line 110 of file extract_labeled_clusters.h.

References pcl::LabeledEuclideanClusterExtraction< PointT >::cluster_tolerance_.

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_size the maximum cluster size

Definition at line 130 of file extract_labeled_clusters.h.

References pcl::LabeledEuclideanClusterExtraction< PointT >::max_pts_per_cluster_.

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_label the maximum

Definition at line 140 of file extract_labeled_clusters.h.

References pcl::LabeledEuclideanClusterExtraction< PointT >::max_label_.

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_size the minimum cluster size

Definition at line 120 of file extract_labeled_clusters.h.

References pcl::LabeledEuclideanClusterExtraction< PointT >::min_pts_per_cluster_.

template<typename PointT >

void pcl::LabeledEuclideanClusterExtraction< PointT >::setSearchMethod ( const KdTreePtr & tree )

inline

Provide a pointer to the search object.

Parameters

[in] tree a pointer to the spatial search object.

Definition at line 100 of file extract_labeled_clusters.h.

References pcl::LabeledEuclideanClusterExtraction< PointT >::tree_.

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.

Referenced by pcl::LabeledEuclideanClusterExtraction< PointT >::getClusterTolerance(), and pcl::LabeledEuclideanClusterExtraction< PointT >::setClusterTolerance().

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.

Referenced by pcl::LabeledEuclideanClusterExtraction< PointT >::getMaxLabels(), and pcl::LabeledEuclideanClusterExtraction< PointT >::setMaxLabels().

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.

Referenced by pcl::LabeledEuclideanClusterExtraction< PointT >::getMaxClusterSize(), and pcl::LabeledEuclideanClusterExtraction< PointT >::setMaxClusterSize().

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.

Referenced by pcl::LabeledEuclideanClusterExtraction< PointT >::getMinClusterSize(), and pcl::LabeledEuclideanClusterExtraction< PointT >::setMinClusterSize().

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.

Referenced by pcl::LabeledEuclideanClusterExtraction< PointT >::getSearchMethod(), and pcl::LabeledEuclideanClusterExtraction< PointT >::setSearchMethod().

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

/tmp/buildd/pcl-1.7.2/segmentation/include/pcl/segmentation/extract_labeled_clusters.h
/tmp/buildd/pcl-1.7.2/segmentation/include/pcl/segmentation/impl/extract_labeled_clusters.hpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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