Point Cloud Library (PCL)  1.3.1
Public Types | Public Member Functions | Friends
pcl::SampleConsensusModelPlane Class Reference

SampleConsensusModelPlane defines a model for 3D plane segmentation. More...

#include <pcl/sample_consensus/sac_model_plane.h>

Inheritance diagram for pcl::SampleConsensusModelPlane:
Inheritance graph
[legend]
Collaboration diagram for pcl::SampleConsensusModelPlane:
Collaboration graph
[legend]

List of all members.

Public Types

typedef SampleConsensusModel
< PointT >::PointCloud 
PointCloud
typedef SampleConsensusModel
< PointT >::PointCloudPtr 
PointCloudPtr
typedef SampleConsensusModel
< PointT >::PointCloudConstPtr 
PointCloudConstPtr
typedef boost::shared_ptr
< SampleConsensusModelPlane
Ptr
typedef boost::shared_ptr
< const SampleConsensusModel
ConstPtr

Public Member Functions

 SampleConsensusModelPlane (const PointCloudConstPtr &cloud)
 Constructor for base SampleConsensusModelPlane.
 SampleConsensusModelPlane (const PointCloudConstPtr &cloud, const std::vector< int > &indices)
 Constructor for base SampleConsensusModelPlane.
bool computeModelCoefficients (const std::vector< int > &samples, Eigen::VectorXf &model_coefficients)
 Check whether the given index samples can form a valid plane model, compute the model coefficients from these samples and store them internally in model_coefficients_.
void getDistancesToModel (const Eigen::VectorXf &model_coefficients, std::vector< double > &distances)
 Compute all distances from the cloud data to a given plane model.
void selectWithinDistance (const Eigen::VectorXf &model_coefficients, const double threshold, std::vector< int > &inliers)
 Select all the points which respect the given model coefficients as inliers.
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 plane 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 plane 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 plane model coefficients.
pcl::SacModel getModelType () const
 Return an unique id for this model (SACMODEL_PLANE).
void getSamples (int &iterations, std::vector< int > &samples)
 Get a set of random data samples and return them as point indices.
virtual void projectPoints (const std::vector< int > &inliers, const Eigen::VectorXf &model_coefficients, PointCloud &projected_points, bool copy_data_fields=true)=0
 Create a new point cloud with inliers projected onto the model.
virtual void setInputCloud (const PointCloudConstPtr &cloud)
 Provide a pointer to the input dataset.
PointCloudConstPtr getInputCloud () const
 Get a pointer to the input point cloud dataset.
void setIndices (const boost::shared_ptr< std::vector< int > > &indices)
 Provide a pointer to the vector of indices that represents the input data.
void setIndices (const std::vector< int > &indices)
 Provide the vector of indices that represents the input data.
boost::shared_ptr< std::vector
< int > > 
getIndices () const
 Get a pointer to the vector of indices used.
unsigned int getSampleSize () const
 Return the size of a sample from which a model is computed.
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)
void getRadiusLimits (double &min_radius, double &max_radius)
 Get the minimum and maximum allowable radius limits for the model as set by the user.

Friends

class ProgressiveSampleConsensus< PointT >

Detailed Description

SampleConsensusModelPlane defines a model for 3D plane segmentation.

The model coefficients are defined as:

Author:
Radu Bogdan Rusu

Member Typedef Documentation

typedef boost::shared_ptr<const SampleConsensusModel> pcl::SampleConsensusModel::ConstPtr [inherited]

Definition at line 72 of file sac_model.h.


Constructor & Destructor Documentation

pcl::SampleConsensusModelPlane::SampleConsensusModelPlane ( const PointCloudConstPtr cloud) [inline]

Constructor for base SampleConsensusModelPlane.

Parameters:
[in]cloudthe input point cloud dataset

Definition at line 151 of file sac_model_plane.h.

pcl::SampleConsensusModelPlane::SampleConsensusModelPlane ( const PointCloudConstPtr cloud,
const std::vector< int > &  indices 
) [inline]

Constructor for base SampleConsensusModelPlane.

Parameters:
[in]cloudthe input point cloud dataset
[in]indicesa vector of point indices to be used from cloud

Definition at line 157 of file sac_model_plane.h.


Member Function Documentation

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

Check whether the given index samples can form a valid plane model, compute the model coefficients from these samples and store them internally in model_coefficients_.

The plane coefficients are: a, b, c, d (ax+by+cz+d=0)

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 65 of file sac_model_plane.hpp.

int pcl::SampleConsensusModelPlane::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 >.

Reimplemented in pcl::SampleConsensusModelNormalParallelPlane, pcl::SampleConsensusModelPerpendicularPlane, pcl::SampleConsensusModelParallelPlane, and pcl::SampleConsensusModelNormalPlane.

Definition at line 173 of file sac_model_plane.hpp.

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

Verify whether a subset of indices verifies the given plane model coefficients.

Parameters:
[in]indicesthe data indices that need to be tested against the plane model
[in]model_coefficientsthe plane model coefficients
[in]thresholda maximum admissible distance threshold for determining the inliers from the outliers

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 334 of file sac_model_plane.hpp.

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

Compute all distances from the cloud data to a given plane model.

Parameters:
[in]model_coefficientsthe coefficients of a plane model that we need to compute distances to
[out]distancesthe resultant estimated distances

Implements pcl::SampleConsensusModel< PointT >.

Reimplemented in pcl::SampleConsensusModelNormalParallelPlane, pcl::SampleConsensusModelPerpendicularPlane, pcl::SampleConsensusModelParallelPlane, and pcl::SampleConsensusModelNormalPlane.

Definition at line 108 of file sac_model_plane.hpp.

boost::shared_ptr<std::vector<int> > pcl::SampleConsensusModel::getIndices ( ) const [inline, inherited]

Get a pointer to the vector of indices used.

Definition at line 277 of file sac_model.h.

PointCloudConstPtr pcl::SampleConsensusModel::getInputCloud ( ) const [inline, inherited]

Get a pointer to the input point cloud dataset.

Definition at line 253 of file sac_model.h.

pcl::SacModel pcl::SampleConsensusModelPlane::getModelType ( ) const [inline, virtual]
void pcl::SampleConsensusModel::getRadiusLimits ( double &  min_radius,
double &  max_radius 
) [inline, inherited]

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

Parameters:
[out]min_radiusthe resultant minimum radius model
[out]max_radiusthe resultant maximum radius model

Definition at line 313 of file sac_model.h.

void pcl::SampleConsensusModel::getSamples ( int &  iterations,
std::vector< int > &  samples 
) [inline, inherited]

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

Pure virtual.

Parameters:
[out]iterationsthe internal number of iterations used by SAC methods
[out]samplesthe resultant model samples

Reimplemented in pcl::SampleConsensusModelCylinder, pcl::SampleConsensusModelSphere, pcl::SampleConsensusModelStick, pcl::SampleConsensusModelCircle2D, and pcl::SampleConsensusModelLine.

Definition at line 116 of file sac_model.h.

unsigned int pcl::SampleConsensusModel::getSampleSize ( ) const [inline, inherited]

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

Definition at line 285 of file sac_model.h.

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

Recompute the plane coefficients using the given inlier set and return them to the user.

Note:
: these are the coefficients of the plane model after refinement (eg. after SVD)
Parameters:
[in]inliersthe data inliers found as supporting the model
[in]model_coefficientsthe initial guess for the model coefficients
[out]optimized_coefficientsthe resultant recomputed coefficients after non-linear optimization

Implements pcl::SampleConsensusModel< PointT >.

Definition at line 202 of file sac_model_plane.hpp.

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

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

Pure virtual.

Parameters:
[in]inliersthe data inliers that we want to project on the model
[in]model_coefficientsthe coefficients of a model
[out]projected_pointsthe resultant projected points
[in]copy_data_fieldsset to true (default) if we want the projected_points cloud to be an exact copy of the input dataset minus the point projections on the plane model
void pcl::SampleConsensusModelPlane::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 plane model.

Parameters:
[in]inliersthe data inliers that we want to project on the plane model
[in]model_coefficientsthe *normalized* coefficients of a plane model
[out]projected_pointsthe resultant projected points
[in]copy_data_fieldsset to true if we need to copy the other data fields

Definition at line 250 of file sac_model_plane.hpp.

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

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

Parameters:
[in]model_coefficientsthe coefficients of a plane 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 >.

Reimplemented in pcl::SampleConsensusModelNormalParallelPlane, pcl::SampleConsensusModelPerpendicularPlane, pcl::SampleConsensusModelParallelPlane, and pcl::SampleConsensusModelNormalPlane.

Definition at line 139 of file sac_model_plane.hpp.

void pcl::SampleConsensusModel::setIndices ( const boost::shared_ptr< std::vector< int > > &  indices) [inline, inherited]

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

Parameters:
[in]indicesa pointer to the vector of indices that represents the input data.

Definition at line 259 of file sac_model.h.

void pcl::SampleConsensusModel::setIndices ( const std::vector< int > &  indices) [inline, inherited]

Provide the vector of indices that represents the input data.

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

Definition at line 269 of file sac_model.h.

virtual void pcl::SampleConsensusModel::setInputCloud ( const PointCloudConstPtr cloud) [inline, virtual, inherited]

Provide a pointer to the input dataset.

Parameters:
[in]cloudthe const boost shared pointer to a PointCloud message

Definition at line 236 of file sac_model.h.

void pcl::SampleConsensusModel::setRadiusLimits ( const double &  min_radius,
const double &  max_radius 
) [inline, inherited]

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

Parameters:
[in]min_radiusthe minimum radius model
[in]max_radiusthe maximum radius model

Definition at line 300 of file sac_model.h.


Friends And Related Function Documentation

friend class ProgressiveSampleConsensus< PointT > [friend, inherited]

Definition at line 319 of file sac_model.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines