pcl::SampleConsensusModelCircle2D< PointT > Class Template Reference

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

#include <sac_model_circle.h>

Inheritance diagram for pcl::SampleConsensusModelCircle2D< PointT >:

Public Types
typedef SampleConsensusModel < PointT >::PointCloud	PointCloud
typedef SampleConsensusModel < PointT >::PointCloudConstPtr	PointCloudConstPtr
typedef SampleConsensusModel < PointT >::PointCloudPtr	PointCloudPtr
typedef boost::shared_ptr < SampleConsensusModelCircle2D >	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.
bool	doSamplesVerifyModel (const std::set< int > &indices, const Eigen::VectorXf &model_coefficients, double threshold)
	Verify whether a subset of indices verifies the given 2d circle model coefficients.
void	getDistancesToModel (const Eigen::VectorXf &model_coefficients, std::vector< double > &distances)
	Compute all distances from the cloud data to a given 2D circle model.
pcl::SacModel	getModelType () const
	Return an unique id for this model (SACMODEL_CIRCLE2D).
void	getSamples (int &iterations, std::vector< int > &samples)
	Get 3 random non-collinear points as data samples and return them as point indices.
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.
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.
	SampleConsensusModelCircle2D (const PointCloudConstPtr &cloud, const std::vector< int > &indices)
	Constructor for base SampleConsensusModelCircle2D.
	SampleConsensusModelCircle2D (const PointCloudConstPtr &cloud)
	Constructor for base SampleConsensusModelCircle2D.
void	selectWithinDistance (const Eigen::VectorXf &model_coefficients, double threshold, std::vector< int > &inliers)
	Compute all distances from the cloud data to a given 2D circle model.
Protected Member Functions
bool	isModelValid (const Eigen::VectorXf &model_coefficients)
	Check whether a model is valid given the user constraints.
Static Private Member Functions
static int	functionToOptimize (void p, int m, int n, const double x, double *fvec, int iflag)
	Cost function to be minimized.
Private Attributes
const std::vector< int > *	tmp_inliers_
	Temporary pointer to a list of given indices for optimizeModelCoefficients ().
boost::mutex	tmp_mutex_
	Temporary boost mutex for tmp_inliers_.
Static Private Attributes
static const int	MAX_ITERATIONS_COLLINEAR = 1000
	Define the maximum number of iterations for collinearity checks.

Detailed Description

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

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

Author:: Radu Bogdan Rusu

Definition at line 53 of file sac_model_circle.h.

Member Typedef Documentation

template<typename PointT>

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

Reimplemented from pcl::SampleConsensusModel< PointT >.

Definition at line 61 of file sac_model_circle.h.

template<typename PointT>

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

Reimplemented from pcl::SampleConsensusModel< PointT >.

Definition at line 63 of file sac_model_circle.h.

template<typename PointT>

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

Reimplemented from pcl::SampleConsensusModel< PointT >.

Definition at line 62 of file sac_model_circle.h.

template<typename PointT>

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

Reimplemented from pcl::SampleConsensusModel< PointT >.

Definition at line 65 of file sac_model_circle.h.

Constructor & Destructor Documentation

template<typename PointT>

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

Constructor for base SampleConsensusModelCircle2D.

Parameters:

cloud

the input point cloud dataset

Definition at line 70 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:

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

Definition at line 76 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
	)			`[inline, 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:

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

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 121 of file sac_model_circle.hpp.

template<typename PointT >

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

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

Parameters:

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

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 367 of file sac_model_circle.hpp.

template<typename PointT >

int pcl::SampleConsensusModelCircle2D< PointT >::functionToOptimize	(	void *	p,
		int	m,
		int	n,
		const double *	x,
		double *	fvec,
		int	iflag
	)			`[inline, static, private]`

Cost function to be minimized.

Parameters:

	p	a pointer to our data structure array
	m	the number of functions
	n	the number of variables
	x	a pointer to the variables array
	fvec	a pointer to the resultant functions evaluations
	iflag	set to -1 inside the function to terminate execution

Definition at line 288 of file sac_model_circle.hpp.

template<typename PointT >

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

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

Parameters:

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

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 157 of file sac_model_circle.hpp.

template<typename PointT>

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

Return an unique id for this model (SACMODEL_CIRCLE2D).

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 130 of file sac_model_circle.h.

template<typename PointT >

void pcl::SampleConsensusModelCircle2D< PointT >::getSamples	(	int &	iterations,
		std::vector< int > &	samples
	)			`[inline, virtual]`

Get 3 random non-collinear points as data samples and return them as point indices.

Parameters:

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

Note:: assumes unique points!

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 45 of file sac_model_circle.hpp.

template<typename PointT >

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

Check whether a model is valid given the user constraints.

Parameters:

model_coefficients

the set of model coefficients

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 393 of file sac_model_circle.hpp.

template<typename PointT >

void pcl::SampleConsensusModelCircle2D< PointT >::optimizeModelCoefficients	(	const std::vector< int > &	inliers,
		const Eigen::VectorXf &	model_coefficients,
		Eigen::VectorXf &	optimized_coefficients
	)			`[inline, 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:

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

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 233 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`
	)			`[inline, virtual]`

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

Parameters:

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

Todo:: implement this.

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 306 of file sac_model_circle.hpp.

template<typename PointT >

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

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

Parameters:

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

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 189 of file sac_model_circle.hpp.

Member Data Documentation

template<typename PointT>

const int pcl::SampleConsensusModelCircle2D< PointT >::MAX_ITERATIONS_COLLINEAR = 1000 [static, private]

Define the maximum number of iterations for collinearity checks.

Definition at line 147 of file sac_model_circle.h.

template<typename PointT>

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

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

Definition at line 144 of file sac_model_circle.h.

template<typename PointT>

boost::mutex pcl::SampleConsensusModelCircle2D< PointT >::tmp_mutex_ [private]

Temporary boost mutex for tmp_inliers_.

Definition at line 141 of file sac_model_circle.h.

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

pcl::SampleConsensusModelCircle2D< PointT > Class Template Reference

Public Types

Public Member Functions

Protected Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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