SampleConsensusModelCircle3D defines a model for 3D circle segmentation. More...
#include <pcl/sample_consensus/sac_model_circle3d.h>
Classes | |
| struct | OptimizationFunctor |
| Functor for the optimization function. | |
Public Types | |
| typedef SampleConsensusModel < PointT >::PointCloud | PointCloud |
| typedef SampleConsensusModel < PointT >::PointCloudPtr | PointCloudPtr |
| typedef SampleConsensusModel < PointT >::PointCloudConstPtr | PointCloudConstPtr |
| typedef boost::shared_ptr < SampleConsensusModelCircle3D < PointT > > | Ptr |
| typedef boost::shared_ptr < const SampleConsensusModelCircle3D < PointT > > | ConstPtr |
Public Member Functions | |
| 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. | |
| virtual | ~SampleConsensusModelCircle3D () |
| Empty destructor. | |
| SampleConsensusModelCircle3D (const SampleConsensusModelCircle3D &source) | |
| Copy constructor. | |
| SampleConsensusModelCircle3D & | operator= (const SampleConsensusModelCircle3D &source) |
| Copy constructor. | |
| 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. | |
| void | getDistancesToModel (const Eigen::VectorXf &model_coefficients, std::vector< double > &distances) |
| Compute all distances from the cloud data to a given 3D circle model. | |
| 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 int | countWithinDistance (const Eigen::VectorXf &model_coefficients, const double threshold) |
| Count all the points which respect the given model coefficients as inliers. | |
| 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. | |
| 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. | |
| pcl::SacModel | getModelType () const |
| Return an unique id for this model (SACMODEL_CIRCLE3D). | |
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. | |
SampleConsensusModelCircle3D defines a model for 3D circle segmentation.
The model coefficients are defined as:
Definition at line 61 of file sac_model_circle3d.h.
| 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.
| typedef SampleConsensusModel<PointT>::PointCloud pcl::SampleConsensusModelCircle3D< PointT >::PointCloud |
Reimplemented from pcl::SampleConsensusModel< PointT >.
Definition at line 69 of file sac_model_circle3d.h.
| typedef SampleConsensusModel<PointT>::PointCloudConstPtr pcl::SampleConsensusModelCircle3D< PointT >::PointCloudConstPtr |
Reimplemented from pcl::SampleConsensusModel< PointT >.
Definition at line 71 of file sac_model_circle3d.h.
| typedef SampleConsensusModel<PointT>::PointCloudPtr pcl::SampleConsensusModelCircle3D< PointT >::PointCloudPtr |
Reimplemented from pcl::SampleConsensusModel< PointT >.
Definition at line 70 of file sac_model_circle3d.h.
| 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.
| pcl::SampleConsensusModelCircle3D< PointT >::SampleConsensusModelCircle3D | ( | const PointCloudConstPtr & | cloud, | |
| bool | random = false | |||
| ) | [inline] |
Constructor for base SampleConsensusModelCircle3D.
| [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.
| pcl::SampleConsensusModelCircle3D< PointT >::SampleConsensusModelCircle3D | ( | const PointCloudConstPtr & | cloud, | |
| const std::vector< int > & | indices, | |||
| bool | random = false | |||
| ) | [inline] |
Constructor for base SampleConsensusModelCircle3D.
| [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.
| virtual pcl::SampleConsensusModelCircle3D< PointT >::~SampleConsensusModelCircle3D | ( | ) | [inline, virtual] |
Empty destructor.
Definition at line 95 of file sac_model_circle3d.h.
| pcl::SampleConsensusModelCircle3D< PointT >::SampleConsensusModelCircle3D | ( | const SampleConsensusModelCircle3D< PointT > & | source | ) | [inline] |
Copy constructor.
| [in] | source | the model to copy into this |
Definition at line 100 of file sac_model_circle3d.h.
| bool pcl::SampleConsensusModelCircle3D< 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.
| [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.
References pcl::SampleConsensusModel< PointT >::input_.
| int pcl::SampleConsensusModelCircle3D< PointT >::countWithinDistance | ( | const Eigen::VectorXf & | model_coefficients, | |
| const double | threshold | |||
| ) | [inline, virtual] |
Count all the points which respect the given model coefficients as inliers.
| [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 |
Implements pcl::SampleConsensusModel< PointT >.
Definition at line 214 of file sac_model_circle3d.hpp.
References pcl::SampleConsensusModel< PointT >::indices_, pcl::SampleConsensusModel< PointT >::input_, pcl::SampleConsensusModelCircle3D< PointT >::isModelValid(), and pcl::K.
| bool pcl::SampleConsensusModelCircle3D< PointT >::doSamplesVerifyModel | ( | const std::set< int > & | indices, | |
| const Eigen::VectorXf & | model_coefficients, | |||
| const double | threshold | |||
| ) | [inline, virtual] |
Verify whether a subset of indices verifies the given 3d circle model coefficients.
| [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.
References pcl::SampleConsensusModel< PointT >::input_, and pcl::K.
| void pcl::SampleConsensusModelCircle3D< PointT >::getDistancesToModel | ( | const Eigen::VectorXf & | model_coefficients, | |
| std::vector< double > & | distances | |||
| ) | [inline, virtual] |
Compute all distances from the cloud data to a given 3D circle model.
| [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.
References pcl::SampleConsensusModel< PointT >::indices_, pcl::SampleConsensusModel< PointT >::input_, pcl::SampleConsensusModelCircle3D< PointT >::isModelValid(), and pcl::K.
| 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.
References pcl::SACMODEL_CIRCLE3D.
| bool pcl::SampleConsensusModelCircle3D< PointT >::isModelValid | ( | const Eigen::VectorXf & | model_coefficients | ) | [inline, protected, virtual] |
Check whether a model is valid given the user constraints.
| [in] | model_coefficients | the set of model coefficients |
Implements pcl::SampleConsensusModel< PointT >.
Definition at line 440 of file sac_model_circle3d.hpp.
References pcl::SampleConsensusModel< PointT >::radius_max_, and pcl::SampleConsensusModel< PointT >::radius_min_.
Referenced by pcl::SampleConsensusModelCircle3D< PointT >::countWithinDistance(), pcl::SampleConsensusModelCircle3D< PointT >::getDistancesToModel(), and pcl::SampleConsensusModelCircle3D< PointT >::selectWithinDistance().
| bool pcl::SampleConsensusModelCircle3D< PointT >::isSampleGood | ( | const std::vector< int > & | samples | ) | const [inline, protected, virtual] |
Check if a sample of indices results in a good sample of points indices.
| [in] | samples | the resultant index samples |
Implements pcl::SampleConsensusModel< PointT >.
Definition at line 48 of file sac_model_circle3d.hpp.
References pcl::SampleConsensusModel< PointT >::input_.
| SampleConsensusModelCircle3D& pcl::SampleConsensusModelCircle3D< PointT >::operator= | ( | const SampleConsensusModelCircle3D< PointT > & | source | ) | [inline] |
Copy constructor.
| [in] | source | the model to copy into this |
Definition at line 110 of file sac_model_circle3d.h.
| void pcl::SampleConsensusModelCircle3D< PointT >::optimizeModelCoefficients | ( | const std::vector< int > & | inliers, | |
| const Eigen::VectorXf & | model_coefficients, | |||
| Eigen::VectorXf & | optimized_coefficients | |||
| ) | [inline, virtual] |
Recompute the 3d circle coefficients using the given inlier set and return them to the user.
| [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.
| void pcl::SampleConsensusModelCircle3D< 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 3d circle model.
| [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.
References pcl::PointCloud< PointT >::header, pcl::PointCloud< PointT >::height, pcl::SampleConsensusModel< PointT >::input_, pcl::PointCloud< PointT >::is_dense, pcl::K, pcl::PointCloud< PointT >::points, and pcl::PointCloud< PointT >::width.
| void pcl::SampleConsensusModelCircle3D< PointT >::selectWithinDistance | ( | const Eigen::VectorXf & | model_coefficients, | |
| const double | threshold, | |||
| std::vector< int > & | inliers | |||
| ) | [inline, virtual] |
Compute all distances from the cloud data to a given 3D circle model.
| [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.
References pcl::SampleConsensusModel< PointT >::indices_, pcl::SampleConsensusModel< PointT >::input_, pcl::SampleConsensusModelCircle3D< PointT >::isModelValid(), and pcl::K.
