SampleConsensusModelCircle2D defines a model for 2D circle segmentation on the X-Y plane. More...

#include <pcl/sample_consensus/sac_model_circle.h>

Inheritance diagram for pcl::SampleConsensusModelCircle2D< PointT >:

Collaboration diagram for pcl::SampleConsensusModelCircle2D< PointT >:

Public Types
typedef SampleConsensusModel < PointT >::PointCloud	PointCloud

typedef SampleConsensusModel < PointT >::PointCloudPtr	PointCloudPtr

typedef SampleConsensusModel < PointT >::PointCloudConstPtr	PointCloudConstPtr

typedef boost::shared_ptr < SampleConsensusModelCircle2D >	Ptr

typedef pcl::search::Search < PointT >::Ptr	SearchPtr

typedef boost::shared_ptr < const SampleConsensusModel >	ConstPtr

Public Member Functions
	SampleConsensusModelCircle2D (const PointCloudConstPtr &cloud)
	Constructor for base SampleConsensusModelCircle2D. More...

	SampleConsensusModelCircle2D (const PointCloudConstPtr &cloud, const std::vector< int > &indices)
	Constructor for base SampleConsensusModelCircle2D. More...

	SampleConsensusModelCircle2D (const SampleConsensusModelCircle2D &source)
	Copy constructor. More...

SampleConsensusModelCircle2D &	operator= (const SampleConsensusModelCircle2D &source)
	Copy constructor. More...

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. More...

void	getDistancesToModel (const Eigen::VectorXf &model_coefficients, std::vector< double > &distances)
	Compute all distances from the cloud data to a given 2D circle model. More...

void	selectWithinDistance (const Eigen::VectorXf &model_coefficients, const double threshold, std::vector< int > &inliers)
	Compute all distances from the cloud data to a given 2D circle model. More...

virtual int	countWithinDistance (const Eigen::VectorXf &model_coefficients, const double threshold)
	Count all the points which respect the given model coefficients as inliers. More...

void	optimizeModelCoefficients (const std::vector< int > &inliers, const Eigen::VectorXf &model_coefficients, Eigen::VectorXf &optimized_coefficients)
	Recompute the 2d circle coefficients using the given inlier set and return them to the user. More...

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 2d circle model. More...

bool	doSamplesVerifyModel (const std::set< int > &indices, const Eigen::VectorXf &model_coefficients, const double threshold)
	Verify whether a subset of indices verifies the given 2d circle model coefficients. More...

pcl::SacModel	getModelType () const
	Return an unique id for this model (SACMODEL_CIRCLE2D). More...

void	getSamples (int &iterations, std::vector< int > &samples)
	Get a set of random data samples and return them as point indices. More...

virtual void	setInputCloud (const PointCloudConstPtr &cloud)
	Provide a pointer to the input dataset. More...

PointCloudConstPtr	getInputCloud () const
	Get a pointer to the input point cloud dataset. More...

void	setIndices (const boost::shared_ptr< std::vector< int > > &indices)
	Provide a pointer to the vector of indices that represents the input data. More...

void	setIndices (const std::vector< int > &indices)
	Provide the vector of indices that represents the input data. More...

boost::shared_ptr< std::vector < int > >	getIndices () const
	Get a pointer to the vector of indices used. More...

unsigned int	getSampleSize () const
	Return the size of a sample from which a model is computed. More...

void	setRadiusLimits (const double &min_radius, const double &max_radius)
	Set the minimum and maximum allowable radius limits for the model (applicable to models that estimate a radius) More...

void	getRadiusLimits (double &min_radius, double &max_radius)
	Get the minimum and maximum allowable radius limits for the model as set by the user. More...

void	setSamplesMaxDist (const double &radius, SearchPtr search)
	Set the maximum distance allowed when drawing random samples. More...

void	getSamplesMaxDist (double &radius)
	Get maximum distance allowed when drawing random samples. More...

Detailed Description

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

SampleConsensusModelCircle2D defines a model for 2D circle segmentation on the X-Y plane.

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
radius : the circle's radius

Author: Radu B. Rusu

Definition at line 59 of file sac_model_circle.h.

Member Typedef Documentation

template<typename PointT>

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

inherited

Definition at line 74 of file sac_model.h.

template<typename PointT>

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

Definition at line 67 of file sac_model_circle.h.

template<typename PointT>

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

Definition at line 69 of file sac_model_circle.h.

template<typename PointT>

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

Definition at line 68 of file sac_model_circle.h.

template<typename PointT>

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

Definition at line 71 of file sac_model_circle.h.

template<typename PointT>

typedef pcl::search::Search<PointT>::Ptr pcl::SampleConsensusModel< PointT >::SearchPtr

inherited

Definition at line 71 of file sac_model.h.

Constructor & Destructor Documentation

template<typename PointT>

pcl::SampleConsensusModelCircle2D< PointT >::SampleConsensusModelCircle2D ( const PointCloudConstPtr & cloud)

inline

Constructor for base SampleConsensusModelCircle2D.

Parameters

[in] cloud the input point cloud dataset

Definition at line 76 of file sac_model_circle.h.

template<typename PointT>

pcl::SampleConsensusModelCircle2D< PointT >::SampleConsensusModelCircle2D	(	const PointCloudConstPtr &	cloud,
		const std::vector< int > &	indices
	)

inline

Constructor for base SampleConsensusModelCircle2D.

Parameters

[in]	cloud	the input point cloud dataset
[in]	indices	a vector of point indices to be used from cloud

Definition at line 84 of file sac_model_circle.h.

template<typename PointT>

pcl::SampleConsensusModelCircle2D< PointT >::SampleConsensusModelCircle2D ( const SampleConsensusModelCircle2D< PointT > & source)

inline

Copy constructor.

Parameters

[in] source the model to copy into this

Definition at line 91 of file sac_model_circle.h.

Member Function Documentation

template<typename PointT >

bool pcl::SampleConsensusModelCircle2D< 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 66 of file sac_model_circle.hpp.

template<typename PointT >

int pcl::SampleConsensusModelCircle2D< 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 164 of file sac_model_circle.hpp.

template<typename PointT >

bool pcl::SampleConsensusModelCircle2D< 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 2d circle model coefficients.

Parameters

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

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 292 of file sac_model_circle.hpp.

template<typename PointT >

void pcl::SampleConsensusModelCircle2D< PointT >::getDistancesToModel	(	const Eigen::VectorXf &	model_coefficients,
		std::vector< double > &	distances
	)

virtual

Compute all distances from the cloud data to a given 2D 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 102 of file sac_model_circle.hpp.

template<typename PointT>

boost::shared_ptr<std::vector<int> > pcl::SampleConsensusModel< PointT >::getIndices ( ) const

inlineinherited

Get a pointer to the vector of indices used.

Definition at line 327 of file sac_model.h.

template<typename PointT>

PointCloudConstPtr pcl::SampleConsensusModel< PointT >::getInputCloud ( ) const

inlineinherited

Get a pointer to the input point cloud dataset.

Definition at line 303 of file sac_model.h.

template<typename PointT>

pcl::SacModel pcl::SampleConsensusModelCircle2D< PointT >::getModelType ( ) const

inlinevirtual

Return an unique id for this model (SACMODEL_CIRCLE2D).

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 180 of file sac_model_circle.h.

template<typename PointT>

void pcl::SampleConsensusModel< PointT >::getRadiusLimits	(	double &	min_radius,
		double &	max_radius
	)

inlineinherited

Get the minimum and maximum allowable radius limits for the model as set by the user.

Parameters

[out]	min_radius	the resultant minimum radius model
[out]	max_radius	the resultant maximum radius model

Definition at line 363 of file sac_model.h.

template<typename PointT>

void pcl::SampleConsensusModel< PointT >::getSamples	(	int &	iterations,
		std::vector< int > &	samples
	)

inlineinherited

Get a set of random data samples and return them as point indices.

Pure virtual.

Parameters

[out]	iterations	the internal number of iterations used by SAC methods
[out]	samples	the resultant model samples

Definition at line 163 of file sac_model.h.

template<typename PointT>

unsigned int pcl::SampleConsensusModel< PointT >::getSampleSize ( ) const

inlineinherited

Return the size of a sample from which a model is computed.

Definition at line 335 of file sac_model.h.

template<typename PointT>

void pcl::SampleConsensusModel< PointT >::getSamplesMaxDist ( double & radius)

inlineinherited

Get maximum distance allowed when drawing random samples.

Parameters

[out] radius the maximum distance (L2 norm)

Definition at line 384 of file sac_model.h.

template<typename PointT>

SampleConsensusModelCircle2D& pcl::SampleConsensusModelCircle2D< PointT >::operator= ( const SampleConsensusModelCircle2D< PointT > & source)

inline

Copy constructor.

Parameters

[in] source the model to copy into this

Definition at line 101 of file sac_model_circle.h.

template<typename PointT >

void pcl::SampleConsensusModelCircle2D< PointT >::optimizeModelCoefficients	(	const std::vector< int > &	inliers,
		const Eigen::VectorXf &	model_coefficients,
		Eigen::VectorXf &	optimized_coefficients
	)

virtual

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

Note: : these are the coefficients of the 2d 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 192 of file sac_model_circle.hpp.

template<typename PointT >

void pcl::SampleConsensusModelCircle2D< 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 2d circle model.

Parameters

[in]	inliers	the data inliers that we want to project on the 2d circle model
[in]	model_coefficients	the coefficients of a 2d 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 225 of file sac_model_circle.hpp.

template<typename PointT >

void pcl::SampleConsensusModelCircle2D< 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 2D circle model.

Parameters

[in]	model_coefficients	the coefficients of a 2D 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 127 of file sac_model_circle.hpp.

template<typename PointT>

void pcl::SampleConsensusModel< PointT >::setIndices ( const boost::shared_ptr< std::vector< int > > & indices)

inlineinherited

Provide a pointer to the vector of indices that represents the input data.

Parameters

[in] indices a pointer to the vector of indices that represents the input data.

Definition at line 309 of file sac_model.h.

template<typename PointT>

void pcl::SampleConsensusModel< PointT >::setIndices ( const std::vector< int > & indices)

inlineinherited

Provide the vector of indices that represents the input data.

Parameters

[out] indices the vector of indices that represents the input data.

Definition at line 319 of file sac_model.h.

template<typename PointT>

virtual void pcl::SampleConsensusModel< PointT >::setInputCloud ( const PointCloudConstPtr & cloud)

inlinevirtualinherited

Provide a pointer to the input dataset.

Parameters

[in] cloud the const boost shared pointer to a PointCloud message

Reimplemented in pcl::SampleConsensusModelRegistration< PointT >.

Definition at line 286 of file sac_model.h.

template<typename PointT>

void pcl::SampleConsensusModel< PointT >::setRadiusLimits	(	const double &	min_radius,
		const double &	max_radius
	)

inlineinherited

Set the minimum and maximum allowable radius limits for the model (applicable to models that estimate a radius)

Parameters

[in]	min_radius	the minimum radius model
[in]	max_radius	the maximum radius model

Definition at line 350 of file sac_model.h.

template<typename PointT>

void pcl::SampleConsensusModel< PointT >::setSamplesMaxDist	(	const double &	radius,
		SearchPtr	search
	)

inlineinherited

Set the maximum distance allowed when drawing random samples.

Parameters

[in] radius the maximum distance (L2 norm)

Definition at line 373 of file sac_model.h.

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

/builddir/build/BUILD/PCL-1.6.0-Source/sample_consensus/include/pcl/sample_consensus/sac_model_circle.h
/builddir/build/BUILD/PCL-1.6.0-Source/sample_consensus/include/pcl/sample_consensus/impl/sac_model_circle.hpp

Public Types

Public Member Functions

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

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