Point Cloud Library (PCL)  1.9.1-dev
List of all members | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
pcl::registration::CorrespondenceRejectorSampleConsensus< PointT > Class Template Reference

CorrespondenceRejectorSampleConsensus implements a correspondence rejection using Random Sample Consensus to identify inliers (and reject outliers) More...

#include <pcl/registration/correspondence_rejection_sample_consensus.h>

+ Inheritance diagram for pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >:

Public Types

using Ptr = boost::shared_ptr< CorrespondenceRejectorSampleConsensus< PointT > >
 
using ConstPtr = boost::shared_ptr< const CorrespondenceRejectorSampleConsensus< PointT > >
 
- Public Types inherited from pcl::registration::CorrespondenceRejector
using Ptr = boost::shared_ptr< CorrespondenceRejector >
 
using ConstPtr = boost::shared_ptr< const CorrespondenceRejector >
 

Public Member Functions

 CorrespondenceRejectorSampleConsensus ()
 Empty constructor. More...
 
 ~CorrespondenceRejectorSampleConsensus ()
 Empty destructor. More...
 
void getRemainingCorrespondences (const pcl::Correspondences &original_correspondences, pcl::Correspondences &remaining_correspondences) override
 Get a list of valid correspondences after rejection from the original set of correspondences. More...
 
virtual void setInputSource (const PointCloudConstPtr &cloud)
 Provide a source point cloud dataset (must contain XYZ data!) More...
 
PointCloudConstPtr const getInputSource ()
 Get a pointer to the input point cloud dataset target. More...
 
virtual void setInputTarget (const PointCloudConstPtr &cloud)
 Provide a target point cloud dataset (must contain XYZ data!) More...
 
PointCloudConstPtr const getInputTarget ()
 Get a pointer to the input point cloud dataset target. More...
 
bool requiresSourcePoints () const override
 See if this rejector requires source points. More...
 
void setSourcePoints (pcl::PCLPointCloud2::ConstPtr cloud2) override
 Blob method for setting the source cloud. More...
 
bool requiresTargetPoints () const override
 See if this rejector requires a target cloud. More...
 
void setTargetPoints (pcl::PCLPointCloud2::ConstPtr cloud2) override
 Method for setting the target cloud. More...
 
void setInlierThreshold (double threshold)
 Set the maximum distance between corresponding points. More...
 
double getInlierThreshold ()
 Get the maximum distance between corresponding points. More...
 
void setMaximumIterations (int max_iterations)
 Set the maximum number of iterations. More...
 
int getMaximumIterations ()
 Get the maximum number of iterations. More...
 
Eigen::Matrix4f getBestTransformation ()
 Get the best transformation after RANSAC rejection. More...
 
void setRefineModel (const bool refine)
 Specify whether the model should be refined internally using the variance of the inliers. More...
 
bool getRefineModel () const
 Get the internal refine parameter value as set by the user using setRefineModel. More...
 
void getInliersIndices (std::vector< int > &inlier_indices)
 Get the inlier indices found by the correspondence rejector. More...
 
void setSaveInliers (bool s)
 Set whether to save inliers or not. More...
 
bool getSaveInliers ()
 Get whether the rejector is configured to save inliers. More...
 
- Public Member Functions inherited from pcl::registration::CorrespondenceRejector
 CorrespondenceRejector ()
 Empty constructor. More...
 
virtual ~CorrespondenceRejector ()
 Empty destructor. More...
 
virtual void setInputCorrespondences (const CorrespondencesConstPtr &correspondences)
 Provide a pointer to the vector of the input correspondences. More...
 
CorrespondencesConstPtr getInputCorrespondences ()
 Get a pointer to the vector of the input correspondences. More...
 
void getCorrespondences (pcl::Correspondences &correspondences)
 Run correspondence rejection. More...
 
void getRejectedQueryIndices (const pcl::Correspondences &correspondences, std::vector< int > &indices)
 Determine the indices of query points of correspondences that have been rejected, i.e., the difference between the input correspondences (set via setInputCorrespondences) and the given correspondence vector. More...
 
const std::string & getClassName () const
 Get a string representation of the name of this class. More...
 
virtual bool requiresSourceNormals () const
 See if this rejector requires source normals. More...
 
virtual void setSourceNormals (pcl::PCLPointCloud2::ConstPtr)
 Abstract method for setting the source normals. More...
 
virtual bool requiresTargetNormals () const
 See if this rejector requires target normals. More...
 
virtual void setTargetNormals (pcl::PCLPointCloud2::ConstPtr)
 Abstract method for setting the target normals. More...
 

Protected Member Functions

void applyRejection (pcl::Correspondences &correspondences) override
 Apply the rejection algorithm. More...
 

Protected Attributes

double inlier_threshold_
 
int max_iterations_
 
PointCloudConstPtr input_
 
PointCloudPtr input_transformed_
 
PointCloudConstPtr target_
 
Eigen::Matrix4f best_transformation_
 
bool refine_
 
std::vector< int > inlier_indices_
 
bool save_inliers_
 
- Protected Attributes inherited from pcl::registration::CorrespondenceRejector
std::string rejection_name_
 The name of the rejection method. More...
 
CorrespondencesConstPtr input_correspondences_
 The input correspondences. More...
 

Detailed Description

template<typename PointT>
class pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >

CorrespondenceRejectorSampleConsensus implements a correspondence rejection using Random Sample Consensus to identify inliers (and reject outliers)

Author
Dirk Holz

Definition at line 61 of file correspondence_rejection_sample_consensus.h.

Member Typedef Documentation

◆ ConstPtr

Definition at line 73 of file correspondence_rejection_sample_consensus.h.

◆ Ptr

Definition at line 72 of file correspondence_rejection_sample_consensus.h.

Constructor & Destructor Documentation

◆ CorrespondenceRejectorSampleConsensus()

Empty constructor.

Sets the inlier threshold to 5cm (0.05m), and the maximum number of iterations to 1000.

Definition at line 78 of file correspondence_rejection_sample_consensus.h.

References pcl::registration::CorrespondenceRejector::rejection_name_.

◆ ~CorrespondenceRejectorSampleConsensus()

Member Function Documentation

◆ applyRejection()

template<typename PointT>
void pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::applyRejection ( pcl::Correspondences correspondences)
inlineoverrideprotectedvirtual

◆ getBestTransformation()

template<typename PointT>
Eigen::Matrix4f pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::getBestTransformation ( )
inline

◆ getInliersIndices()

template<typename PointT>
void pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::getInliersIndices ( std::vector< int > &  inlier_indices)
inline

Get the inlier indices found by the correspondence rejector.

This information is only saved if setSaveInliers(true) was called in advance.

Parameters
[out]inlier_indicesIndices for the inliers

Definition at line 204 of file correspondence_rejection_sample_consensus.h.

References pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::inlier_indices_.

◆ getInlierThreshold()

template<typename PointT>
double pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::getInlierThreshold ( )
inline

Get the maximum distance between corresponding points.

Returns
Distance threshold in the same dimension as source and target data sets.

Definition at line 164 of file correspondence_rejection_sample_consensus.h.

References pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::inlier_threshold_.

◆ getInputSource()

template<typename PointT>
PointCloudConstPtr const pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::getInputSource ( )
inline

Get a pointer to the input point cloud dataset target.

Definition at line 112 of file correspondence_rejection_sample_consensus.h.

References pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::input_.

◆ getInputTarget()

template<typename PointT>
PointCloudConstPtr const pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::getInputTarget ( )
inline

Get a pointer to the input point cloud dataset target.

Definition at line 122 of file correspondence_rejection_sample_consensus.h.

References pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::target_.

◆ getMaximumIterations()

template<typename PointT>
int pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::getMaximumIterations ( )
inline

Get the maximum number of iterations.

Returns
max_iterations Maximum number if iterations to run

Definition at line 176 of file correspondence_rejection_sample_consensus.h.

References pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::max_iterations_.

◆ getRefineModel()

template<typename PointT>
bool pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::getRefineModel ( ) const
inline

Get the internal refine parameter value as set by the user using setRefineModel.

Definition at line 195 of file correspondence_rejection_sample_consensus.h.

References pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::refine_.

◆ getRemainingCorrespondences()

template<typename PointT >
void pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::getRemainingCorrespondences ( const pcl::Correspondences original_correspondences,
pcl::Correspondences remaining_correspondences 
)
inlineoverridevirtual

◆ getSaveInliers()

template<typename PointT>
bool pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::getSaveInliers ( )
inline

Get whether the rejector is configured to save inliers.

Definition at line 214 of file correspondence_rejection_sample_consensus.h.

References pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::save_inliers_.

◆ requiresSourcePoints()

template<typename PointT>
bool pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::requiresSourcePoints ( ) const
inlineoverridevirtual

See if this rejector requires source points.

Reimplemented from pcl::registration::CorrespondenceRejector.

Definition at line 127 of file correspondence_rejection_sample_consensus.h.

◆ requiresTargetPoints()

template<typename PointT>
bool pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::requiresTargetPoints ( ) const
inlineoverridevirtual

See if this rejector requires a target cloud.

Reimplemented from pcl::registration::CorrespondenceRejector.

Definition at line 141 of file correspondence_rejection_sample_consensus.h.

◆ setInlierThreshold()

template<typename PointT>
void pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::setInlierThreshold ( double  threshold)
inline

Set the maximum distance between corresponding points.

Correspondences with distances below the threshold are considered as inliers.

Parameters
[in]thresholdDistance threshold in the same dimension as source and target data sets.

Definition at line 158 of file correspondence_rejection_sample_consensus.h.

References pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::inlier_threshold_.

Referenced by pcl::GeometricConsistencyGrouping< PointModelT, PointSceneT >::clusterCorrespondences(), and pcl::Hough3DGrouping< PointModelT, PointSceneT, PointModelRfT, PointSceneRfT >::clusterCorrespondences().

◆ setInputSource()

template<typename PointT>
virtual void pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::setInputSource ( const PointCloudConstPtr &  cloud)
inlinevirtual

◆ setInputTarget()

template<typename PointT>
virtual void pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::setInputTarget ( const PointCloudConstPtr &  cloud)
inlinevirtual

◆ setMaximumIterations()

template<typename PointT>
void pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::setMaximumIterations ( int  max_iterations)
inline

◆ setRefineModel()

template<typename PointT>
void pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::setRefineModel ( const bool  refine)
inline

Specify whether the model should be refined internally using the variance of the inliers.

Parameters
[in]refinetrue if the model should be refined, false otherwise

Definition at line 188 of file correspondence_rejection_sample_consensus.h.

References pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::refine_.

◆ setSaveInliers()

template<typename PointT>
void pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::setSaveInliers ( bool  s)
inline

Set whether to save inliers or not.

Parameters
[in]sTrue to save inliers / False otherwise

Definition at line 210 of file correspondence_rejection_sample_consensus.h.

References pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::save_inliers_.

◆ setSourcePoints()

template<typename PointT>
void pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::setSourcePoints ( pcl::PCLPointCloud2::ConstPtr  cloud2)
inlineoverridevirtual

◆ setTargetPoints()

template<typename PointT>
void pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::setTargetPoints ( pcl::PCLPointCloud2::ConstPtr  cloud2)
inlineoverridevirtual

Member Data Documentation

◆ best_transformation_

template<typename PointT>
Eigen::Matrix4f pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::best_transformation_
protected

◆ inlier_indices_

template<typename PointT>
std::vector<int> pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::inlier_indices_
protected

◆ inlier_threshold_

template<typename PointT>
double pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::inlier_threshold_
protected

◆ input_

template<typename PointT>
PointCloudConstPtr pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::input_
protected

◆ input_transformed_

template<typename PointT>
PointCloudPtr pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::input_transformed_
protected

Definition at line 233 of file correspondence_rejection_sample_consensus.h.

◆ max_iterations_

template<typename PointT>
int pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::max_iterations_
protected

◆ refine_

template<typename PointT>
bool pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::refine_
protected

◆ save_inliers_

template<typename PointT>
bool pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::save_inliers_
protected

◆ target_

template<typename PointT>
PointCloudConstPtr pcl::registration::CorrespondenceRejectorSampleConsensus< PointT >::target_
protected

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