#include <pcl/segmentation/seeded_hue_segmentation.h>

Inheritance diagram for pcl::SeededHueSegmentation:

Public Types
using	PointCloud = pcl::PointCloud<PointXYZRGB>
using	PointCloudPtr = PointCloud::Ptr
using	PointCloudConstPtr = PointCloud::ConstPtr
using	KdTree = pcl::search::Search<PointXYZRGB>
using	KdTreePtr = pcl::search::Search<PointXYZRGB>::Ptr
using	PointIndicesPtr = PointIndices::Ptr
using	PointIndicesConstPtr = PointIndices::ConstPtr
Public Types inherited from pcl::PCLBase< PointXYZRGB >
using	PointCloud
using	PointCloudPtr
using	PointCloudConstPtr
using	PointIndicesPtr
using	PointIndicesConstPtr

Public Member Functions
	SeededHueSegmentation ()=default
	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	setDeltaHue (float delta_hue)
	Set the tolerance on the hue.
float	getDeltaHue () const
	Get the tolerance on the hue.
void	segment (PointIndices &indices_in, PointIndices &indices_out)
	Cluster extraction in a PointCloud given by <setInputCloud (), setIndices ()>.
Public Member Functions inherited from pcl::PCLBase< PointXYZRGB >
	PCLBase ()
	Empty constructor.
	PCLBase (const PCLBase &base)
	Copy constructor.
virtual	~PCLBase ()=default
	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 (std::size_t row_start, std::size_t col_start, std::size_t nb_rows, std::size_t nb_cols)
	Set the indices for the points laying within an interest region of the point cloud.
IndicesPtr	getIndices ()
	Get a pointer to the vector of indices used.
IndicesConstPtr const	getIndices () const
	Get a pointer to the vector of indices used.
const PointXYZRGB &	operator[] (std::size_t pos) const
	Override PointCloud operator[] to shorten code.

Protected Member Functions
virtual std::string	getClassName () const
	Class getName method.
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 Member Functions inherited from pcl::PCLBase< PointXYZRGB >
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_ {nullptr}
	A pointer to the spatial search object.
double	cluster_tolerance_ {0.0}
	The spatial cluster tolerance as a measure in the L2 Euclidean space.
float	delta_hue_ {0.0f}
	The allowed difference on the hue.
PointCloudConstPtr	input_
	The input point cloud dataset.
IndicesPtr	indices_
	A pointer to the vector of point indices to use.
Protected Attributes inherited from pcl::PCLBase< PointXYZRGB >
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

SeededHueSegmentation.

Author: Koen Buys

Definition at line 93 of file seeded_hue_segmentation.h.

Member Typedef Documentation

◆ KdTree

using pcl::SeededHueSegmentation::KdTree = pcl::search::Search<PointXYZRGB>

Definition at line 102 of file seeded_hue_segmentation.h.

◆ KdTreePtr

using pcl::SeededHueSegmentation::KdTreePtr = pcl::search::Search<PointXYZRGB>::Ptr

Definition at line 103 of file seeded_hue_segmentation.h.

◆ PointCloud

using pcl::SeededHueSegmentation::PointCloud = pcl::PointCloud<PointXYZRGB>

Definition at line 98 of file seeded_hue_segmentation.h.

◆ PointCloudConstPtr

using pcl::SeededHueSegmentation::PointCloudConstPtr = PointCloud::ConstPtr

Definition at line 100 of file seeded_hue_segmentation.h.

◆ PointCloudPtr

using pcl::SeededHueSegmentation::PointCloudPtr = PointCloud::Ptr

Definition at line 99 of file seeded_hue_segmentation.h.

◆ PointIndicesConstPtr

using pcl::SeededHueSegmentation::PointIndicesConstPtr = PointIndices::ConstPtr

Definition at line 106 of file seeded_hue_segmentation.h.

◆ PointIndicesPtr

using pcl::SeededHueSegmentation::PointIndicesPtr = PointIndices::Ptr

Definition at line 105 of file seeded_hue_segmentation.h.

Constructor & Destructor Documentation

◆ SeededHueSegmentation()

pcl::SeededHueSegmentation::SeededHueSegmentation ( )

default

Empty constructor.

Member Function Documentation

◆ deinitCompute()

bool pcl::PCLBase< PointXYZRGB >::deinitCompute ( )

protected

This method should get called after finishing the actual computation.

Referenced by segment().

◆ getClassName()

virtual std::string pcl::SeededHueSegmentation::getClassName ( ) const

inlineprotectedvirtual

Class getName method.

Definition at line 166 of file seeded_hue_segmentation.h.

◆ getClusterTolerance()

double pcl::SeededHueSegmentation::getClusterTolerance ( ) const

inline

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

Definition at line 130 of file seeded_hue_segmentation.h.

References cluster_tolerance_.

◆ getDeltaHue()

float pcl::SeededHueSegmentation::getDeltaHue ( ) const

inline

Get the tolerance on the hue.

Definition at line 140 of file seeded_hue_segmentation.h.

References delta_hue_.

◆ getSearchMethod()

KdTreePtr pcl::SeededHueSegmentation::getSearchMethod ( ) const

inline

Get a pointer to the search method used.

Definition at line 120 of file seeded_hue_segmentation.h.

References tree_.

◆ initCompute()

bool pcl::PCLBase< PointXYZRGB >::initCompute ( )

protected

This method should get called before starting the actual computation.

Internally, initCompute() does the following:

checks if an input dataset is given, and returns false otherwise
checks whether a set of input indices has been given. Returns true if yes.
if no input indices have been given, a fake set is created, which will be used until:
- either a new set is given via setIndices(), or
- a new cloud is given that has a different set of points. This will trigger an update on the set of fake indices

Referenced by segment().

◆ segment()

void pcl::SeededHueSegmentation::segment	(	PointIndices &	indices_in,
		PointIndices &	indices_out )

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

Parameters

[in]	indices_in
[out]	indices_out

Definition at line 210 of file seeded_hue_segmentation.hpp.

References cluster_tolerance_, deinitCompute(), delta_hue_, pcl::PointIndices::indices, indices_, initCompute(), input_, pcl::seededHueSegmentation(), and tree_.

◆ setClusterTolerance()

void pcl::SeededHueSegmentation::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 126 of file seeded_hue_segmentation.h.

References cluster_tolerance_.

◆ setDeltaHue()

void pcl::SeededHueSegmentation::setDeltaHue ( float delta_hue )

inline

Set the tolerance on the hue.

Parameters

[in] delta_hue the new delta hue

Definition at line 136 of file seeded_hue_segmentation.h.

References delta_hue_.

◆ setSearchMethod()

void pcl::SeededHueSegmentation::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 116 of file seeded_hue_segmentation.h.

References tree_.

Member Data Documentation

◆ cluster_tolerance_

double pcl::SeededHueSegmentation::cluster_tolerance_ {0.0}

protected

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

Definition at line 160 of file seeded_hue_segmentation.h.

Referenced by getClusterTolerance(), segment(), and setClusterTolerance().

◆ delta_hue_

float pcl::SeededHueSegmentation::delta_hue_ {0.0f}

protected

The allowed difference on the hue.

Definition at line 163 of file seeded_hue_segmentation.h.

Referenced by getDeltaHue(), segment(), and setDeltaHue().

◆ indices_

IndicesPtr pcl::PCLBase< PointXYZRGB >::indices_

protected

A pointer to the vector of point indices to use.

Definition at line 150 of file pcl_base.h.

Referenced by segment().

◆ input_

PointCloudConstPtr pcl::PCLBase< PointXYZRGB >::input_

protected

The input point cloud dataset.

Definition at line 147 of file pcl_base.h.

Referenced by segment().

◆ tree_

KdTreePtr pcl::SeededHueSegmentation::tree_ {nullptr}

protected

A pointer to the spatial search object.

Definition at line 157 of file seeded_hue_segmentation.h.

Referenced by getSearchMethod(), segment(), and setSearchMethod().

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

pcl/segmentation/seeded_hue_segmentation.h
pcl/segmentation/impl/seeded_hue_segmentation.hpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ KdTree

◆ KdTreePtr

◆ PointCloud

◆ PointCloudConstPtr

◆ PointCloudPtr

◆ PointIndicesConstPtr

◆ PointIndicesPtr

Constructor & Destructor Documentation

◆ SeededHueSegmentation()

Member Function Documentation

◆ deinitCompute()

◆ getClassName()

◆ getClusterTolerance()

◆ getDeltaHue()

◆ getSearchMethod()

◆ initCompute()

◆ segment()

◆ setClusterTolerance()

◆ setDeltaHue()

◆ setSearchMethod()

Member Data Documentation

◆ cluster_tolerance_

◆ delta_hue_

◆ indices_

◆ input_

◆ tree_