Classes | Public Types | Public Member Functions | Protected Member Functions | Private Attributes
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 >:
Inheritance graph
[legend]

List of all members.

Classes

struct  OptimizationFunctor
 Functor for the optimization function. More...

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.
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 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).
SampleConsensusModelCircle2Doperator= (const SampleConsensusModelCircle2D &source)
 Copy constructor.
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, bool random=false)
 Constructor for base SampleConsensusModelCircle2D.
 SampleConsensusModelCircle2D (const PointCloudConstPtr &cloud, const std::vector< int > &indices, bool random=false)
 Constructor for base SampleConsensusModelCircle2D.
 SampleConsensusModelCircle2D (const SampleConsensusModelCircle2D &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 2D circle model.
virtual ~SampleConsensusModelCircle2D ()
 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::SampleConsensusModelCircle2D< PointT >

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

The model coefficients are defined as:

Author:
Radu B. Rusu

Definition at line 60 of file sac_model_circle.h.


Member Typedef Documentation

Reimplemented from pcl::SampleConsensusModel< PointT >.

Definition at line 69 of file sac_model_circle.h.

Reimplemented from pcl::SampleConsensusModel< PointT >.

Definition at line 71 of file sac_model_circle.h.

Reimplemented from pcl::SampleConsensusModel< PointT >.

Definition at line 70 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 73 of file sac_model_circle.h.


Constructor & Destructor Documentation

template<typename PointT>
pcl::SampleConsensusModelCircle2D< PointT >::SampleConsensusModelCircle2D ( const PointCloudConstPtr cloud,
bool  random = false 
) [inline]

Constructor for base SampleConsensusModelCircle2D.

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

Definition at line 79 of file sac_model_circle.h.

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

Constructor for base SampleConsensusModelCircle2D.

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

Definition at line 88 of file sac_model_circle.h.

template<typename PointT>
pcl::SampleConsensusModelCircle2D< PointT >::SampleConsensusModelCircle2D ( const SampleConsensusModelCircle2D< PointT > &  source) [inline]

Copy constructor.

Parameters:
[in]sourcethe model to copy into this

Definition at line 97 of file sac_model_circle.h.

template<typename PointT>
virtual pcl::SampleConsensusModelCircle2D< PointT >::~SampleConsensusModelCircle2D ( ) [inline, virtual]

Empty destructor.

Definition at line 104 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]samplesthe point indices found as possible good candidates for creating a valid model
[out]model_coefficientsthe resultant model coefficients

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 69 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_coefficientsthe coefficients of a model that we need to compute distances to
[in]thresholdmaximum admissible distance threshold for determining the inliers from the outliers
Returns:
the resultant number of inliers

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 170 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]indicesthe data indices that need to be tested against the 2d circle model
[in]model_coefficientsthe 2d circle model coefficients
[in]thresholda maximum admissible distance threshold for determining the inliers from the outliers

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 298 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_coefficientsthe coefficients of a 2D circle model that we need to compute distances to
[out]distancesthe resultant estimated distances

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 105 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 189 of file sac_model_circle.h.

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

Check whether a model is valid given the user constraints.

Parameters:
[in]model_coefficientsthe set of model coefficients

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 324 of file sac_model_circle.hpp.

template<typename PointT >
bool pcl::SampleConsensusModelCircle2D< 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]samplesthe resultant index samples

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 50 of file sac_model_circle.hpp.

template<typename PointT>
SampleConsensusModelCircle2D& pcl::SampleConsensusModelCircle2D< PointT >::operator= ( const SampleConsensusModelCircle2D< PointT > &  source) [inline]

Copy constructor.

Parameters:
[in]sourcethe model to copy into this

Definition at line 110 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]inliersthe data inliers found as supporting the model
[in]model_coefficientsthe initial guess for the optimization
[out]optimized_coefficientsthe resultant recomputed coefficients after non-linear optimization

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 198 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]inliersthe data inliers that we want to project on the 2d circle model
[in]model_coefficientsthe coefficients of a 2d circle model
[out]projected_pointsthe resultant projected points
[in]copy_data_fieldsset to true if we need to copy the other data fields

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 231 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_coefficientsthe coefficients of a 2D circle model that we need to compute distances to
[in]thresholda maximum admissible distance threshold for determining the inliers from the outliers
[out]inliersthe resultant model inliers

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 130 of file sac_model_circle.hpp.


Member Data Documentation

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 206 of file sac_model_circle.h.


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


pcl
Author(s): Open Perception
autogenerated on Wed Aug 26 2015 15:43:34