SampleConsensusModelCircle3D defines a model for 3D circle segmentation. More...

#include <sac_model_circle3d.h>

Inheritance diagram for pcl::SampleConsensusModelCircle3D< PointT >:

Classes
struct	OptimizationFunctor
	Functor for the optimization function. More...
Public Types
typedef boost::shared_ptr < const SampleConsensusModelCircle3D < PointT > >	ConstPtr
typedef SampleConsensusModel < PointT >::PointCloud	PointCloud
typedef SampleConsensusModel < PointT >::PointCloudConstPtr	PointCloudConstPtr
typedef SampleConsensusModel < PointT >::PointCloudPtr	PointCloudPtr
typedef boost::shared_ptr < SampleConsensusModelCircle3D < PointT > >	Ptr
Public Member Functions
bool	computeModelCoefficients (const std::vector< int > &samples, Eigen::VectorXf &model_coefficients)
	Check whether the given index samples can form a valid 2D circle model, compute the model coefficients from these samples and store them in model_coefficients. The circle coefficients are: x, y, R.
virtual int	countWithinDistance (const Eigen::VectorXf &model_coefficients, const double threshold)
	Count all the points which respect the given model coefficients as inliers.
bool	doSamplesVerifyModel (const std::set< int > &indices, const Eigen::VectorXf &model_coefficients, const double threshold)
	Verify whether a subset of indices verifies the given 3d circle model coefficients.
void	getDistancesToModel (const Eigen::VectorXf &model_coefficients, std::vector< double > &distances)
	Compute all distances from the cloud data to a given 3D circle model.
pcl::SacModel	getModelType () const
	Return an unique id for this model (SACMODEL_CIRCLE3D).
SampleConsensusModelCircle3D &	operator= (const SampleConsensusModelCircle3D &source)
	Copy constructor.
void	optimizeModelCoefficients (const std::vector< int > &inliers, const Eigen::VectorXf &model_coefficients, Eigen::VectorXf &optimized_coefficients)
	Recompute the 3d circle coefficients using the given inlier set and return them to the user.
void	projectPoints (const std::vector< int > &inliers, const Eigen::VectorXf &model_coefficients, PointCloud &projected_points, bool copy_data_fields=true)
	Create a new point cloud with inliers projected onto the 3d circle model.
	SampleConsensusModelCircle3D (const PointCloudConstPtr &cloud, bool random=false)
	Constructor for base SampleConsensusModelCircle3D.
	SampleConsensusModelCircle3D (const PointCloudConstPtr &cloud, const std::vector< int > &indices, bool random=false)
	Constructor for base SampleConsensusModelCircle3D.
	SampleConsensusModelCircle3D (const SampleConsensusModelCircle3D &source)
	Copy constructor.
void	selectWithinDistance (const Eigen::VectorXf &model_coefficients, const double threshold, std::vector< int > &inliers)
	Compute all distances from the cloud data to a given 3D circle model.
virtual	~SampleConsensusModelCircle3D ()
	Empty destructor.
Protected Member Functions
bool	isModelValid (const Eigen::VectorXf &model_coefficients)
	Check whether a model is valid given the user constraints.
bool	isSampleGood (const std::vector< int > &samples) const
	Check if a sample of indices results in a good sample of points indices.
Private Attributes
const std::vector< int > *	tmp_inliers_
	Temporary pointer to a list of given indices for optimizeModelCoefficients ()

Detailed Description

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

SampleConsensusModelCircle3D defines a model for 3D circle segmentation.

The model coefficients are defined as:

center.x : the X coordinate of the circle's center
center.y : the Y coordinate of the circle's center
center.z : the Z coordinate of the circle's center
radius : the circle's radius
normal.x : the X coordinate of the normal's direction
normal.y : the Y coordinate of the normal's direction
normal.z : the Z coordinate of the normal's direction

Author:: Raoul Hoffmann, Karol Hausman, Radu B. Rusu

Definition at line 61 of file sac_model_circle3d.h.

Member Typedef Documentation

template<typename PointT>

typedef boost::shared_ptr<const SampleConsensusModelCircle3D<PointT> > pcl::SampleConsensusModelCircle3D< PointT >::ConstPtr

Reimplemented from pcl::SampleConsensusModel< PointT >.

Definition at line 74 of file sac_model_circle3d.h.

template<typename PointT>

typedef SampleConsensusModel<PointT>::PointCloud pcl::SampleConsensusModelCircle3D< PointT >::PointCloud

Reimplemented from pcl::SampleConsensusModel< PointT >.

Definition at line 69 of file sac_model_circle3d.h.

template<typename PointT>

typedef SampleConsensusModel<PointT>::PointCloudConstPtr pcl::SampleConsensusModelCircle3D< PointT >::PointCloudConstPtr

Reimplemented from pcl::SampleConsensusModel< PointT >.

Definition at line 71 of file sac_model_circle3d.h.

template<typename PointT>

typedef SampleConsensusModel<PointT>::PointCloudPtr pcl::SampleConsensusModelCircle3D< PointT >::PointCloudPtr

Reimplemented from pcl::SampleConsensusModel< PointT >.

Definition at line 70 of file sac_model_circle3d.h.

template<typename PointT>

typedef boost::shared_ptr<SampleConsensusModelCircle3D<PointT> > pcl::SampleConsensusModelCircle3D< PointT >::Ptr

Reimplemented from pcl::SampleConsensusModel< PointT >.

Definition at line 73 of file sac_model_circle3d.h.

Constructor & Destructor Documentation

template<typename PointT>

pcl::SampleConsensusModelCircle3D< PointT >::SampleConsensusModelCircle3D	(	const PointCloudConstPtr &	cloud,
		bool	random = `false`
	)		`[inline]`

Constructor for base SampleConsensusModelCircle3D.

Parameters:

[in]	cloud	the input point cloud dataset
[in]	random	if true set the random seed to the current time, else set to 12345 (default: false)

Definition at line 80 of file sac_model_circle3d.h.

template<typename PointT>

pcl::SampleConsensusModelCircle3D< PointT >::SampleConsensusModelCircle3D	(	const PointCloudConstPtr &	cloud,
		const std::vector< int > &	indices,
		bool	random = `false`
	)		`[inline]`

Constructor for base SampleConsensusModelCircle3D.

Parameters:

[in]	cloud	the input point cloud dataset
[in]	indices	a vector of point indices to be used from cloud
[in]	random	if true set the random seed to the current time, else set to 12345 (default: false)

Definition at line 89 of file sac_model_circle3d.h.

template<typename PointT>

virtual pcl::SampleConsensusModelCircle3D< PointT >::~SampleConsensusModelCircle3D ( ) [inline, virtual]

Empty destructor.

Definition at line 95 of file sac_model_circle3d.h.

template<typename PointT>

pcl::SampleConsensusModelCircle3D< PointT >::SampleConsensusModelCircle3D ( const SampleConsensusModelCircle3D< PointT > & source ) [inline]

Copy constructor.

Parameters:

[in] source the model to copy into this

Definition at line 100 of file sac_model_circle3d.h.

Member Function Documentation

template<typename PointT >

bool pcl::SampleConsensusModelCircle3D< PointT >::computeModelCoefficients	(	const std::vector< int > &	samples,
		Eigen::VectorXf &	model_coefficients
	)		`[virtual]`

Check whether the given index samples can form a valid 2D circle model, compute the model coefficients from these samples and store them in model_coefficients. The circle coefficients are: x, y, R.

Parameters:

[in]	samples	the point indices found as possible good candidates for creating a valid model
[out]	model_coefficients	the resultant model coefficients

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 68 of file sac_model_circle3d.hpp.

template<typename PointT >

int pcl::SampleConsensusModelCircle3D< PointT >::countWithinDistance	(	const Eigen::VectorXf &	model_coefficients,
		const double	threshold
	)		`[virtual]`

Count all the points which respect the given model coefficients as inliers.

Parameters:

[in]	model_coefficients	the coefficients of a model that we need to compute distances to
[in]	threshold	maximum admissible distance threshold for determining the inliers from the outliers

Returns:: the resultant number of inliers

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 214 of file sac_model_circle3d.hpp.

template<typename PointT >

bool pcl::SampleConsensusModelCircle3D< PointT >::doSamplesVerifyModel	(	const std::set< int > &	indices,
		const Eigen::VectorXf &	model_coefficients,
		const double	threshold
	)		`[virtual]`

Verify whether a subset of indices verifies the given 3d circle model coefficients.

Parameters:

[in]	indices	the data indices that need to be tested against the 3d circle model
[in]	model_coefficients	the 3d circle model coefficients
[in]	threshold	a maximum admissible distance threshold for determining the inliers from the outliers

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 395 of file sac_model_circle3d.hpp.

template<typename PointT >

void pcl::SampleConsensusModelCircle3D< PointT >::getDistancesToModel	(	const Eigen::VectorXf &	model_coefficients,
		std::vector< double > &	distances
	)		`[virtual]`

Compute all distances from the cloud data to a given 3D circle model.

Parameters:

[in]	model_coefficients	the coefficients of a 2D circle model that we need to compute distances to
[out]	distances	the resultant estimated distances

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 118 of file sac_model_circle3d.hpp.

template<typename PointT>

pcl::SacModel pcl::SampleConsensusModelCircle3D< PointT >::getModelType ( ) const [inline, virtual]

Return an unique id for this model (SACMODEL_CIRCLE3D).

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 189 of file sac_model_circle3d.h.

template<typename PointT >

bool pcl::SampleConsensusModelCircle3D< PointT >::isModelValid ( const Eigen::VectorXf & model_coefficients ) [protected, virtual]

Check whether a model is valid given the user constraints.

Parameters:

[in] model_coefficients the set of model coefficients

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 440 of file sac_model_circle3d.hpp.

template<typename PointT >

bool pcl::SampleConsensusModelCircle3D< PointT >::isSampleGood ( const std::vector< int > & samples ) const [protected, virtual]

Check if a sample of indices results in a good sample of points indices.

Parameters:

[in] samples the resultant index samples

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 48 of file sac_model_circle3d.hpp.

template<typename PointT>

SampleConsensusModelCircle3D& pcl::SampleConsensusModelCircle3D< PointT >::operator= ( const SampleConsensusModelCircle3D< PointT > & source ) [inline]

Copy constructor.

Parameters:

[in] source the model to copy into this

Definition at line 110 of file sac_model_circle3d.h.

template<typename PointT >

void pcl::SampleConsensusModelCircle3D< PointT >::optimizeModelCoefficients	(	const std::vector< int > &	inliers,
		const Eigen::VectorXf &	model_coefficients,
		Eigen::VectorXf &	optimized_coefficients
	)		`[virtual]`

Recompute the 3d circle coefficients using the given inlier set and return them to the user.

Note:: : these are the coefficients of the 3d circle model after refinement (eg. after SVD)

Parameters:

[in]	inliers	the data inliers found as supporting the model
[in]	model_coefficients	the initial guess for the optimization
[out]	optimized_coefficients	the resultant recomputed coefficients after non-linear optimization

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 255 of file sac_model_circle3d.hpp.

template<typename PointT >

void pcl::SampleConsensusModelCircle3D< PointT >::projectPoints	(	const std::vector< int > &	inliers,
		const Eigen::VectorXf &	model_coefficients,
		PointCloud &	projected_points,
		bool	copy_data_fields = `true`
	)		`[virtual]`

Create a new point cloud with inliers projected onto the 3d circle model.

Parameters:

[in]	inliers	the data inliers that we want to project on the 3d circle model
[in]	model_coefficients	the coefficients of a 3d circle model
[out]	projected_points	the resultant projected points
[in]	copy_data_fields	set to true if we need to copy the other data fields

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 293 of file sac_model_circle3d.hpp.

template<typename PointT >

void pcl::SampleConsensusModelCircle3D< PointT >::selectWithinDistance	(	const Eigen::VectorXf &	model_coefficients,
		const double	threshold,
		std::vector< int > &	inliers
	)		`[virtual]`

Compute all distances from the cloud data to a given 3D circle model.

Parameters:

[in]	model_coefficients	the coefficients of a 3D circle model that we need to compute distances to
[in]	threshold	a maximum admissible distance threshold for determining the inliers from the outliers
[out]	inliers	the resultant model inliers

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 165 of file sac_model_circle3d.hpp.

Member Data Documentation

template<typename PointT>

const std::vector<int>* pcl::SampleConsensusModelCircle3D< PointT >::tmp_inliers_ [private]

Temporary pointer to a list of given indices for optimizeModelCoefficients ()

Definition at line 206 of file sac_model_circle3d.h.

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

Classes

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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