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

SampleConsensus represents the base class. More...

#include <pcl/sample_consensus/sac.h>

List of all members.

Public Types

typedef boost::shared_ptr
< SampleConsensus
Ptr
typedef boost::shared_ptr
< const SampleConsensus
ConstPtr

Public Member Functions

 SampleConsensus (const SampleConsensusModelPtr &model)
 Constructor for base SAC.
 SampleConsensus (const SampleConsensusModelPtr &model, double threshold)
 Constructor for base SAC.
virtual ~SampleConsensus ()
 Destructor for base SAC.
void setDistanceThreshold (double threshold)
 Set the distance to model threshold.
double getDistanceThreshold ()
 Get the distance to model threshold, as set by the user.
void setMaxIterations (int max_iterations)
 Set the maximum number of iterations.
int getMaxIterations ()
 Get the maximum number of iterations, as set by the user.
void setProbability (double probability)
 Set the desired probability of choosing at least one sample free from outliers.
double getProbability ()
 Obtain the probability of choosing at least one sample free from outliers, as set by the user.
virtual bool computeModel (int debug_verbosity_level=0)=0
 Compute the actual model.
void getRandomSamples (const boost::shared_ptr< std::vector< int > > &indices, size_t nr_samples, std::set< int > &indices_subset)
 Get a set of randomly selected indices.
void getModel (std::vector< int > &model)
 Return the best model found so far.
void getInliers (std::vector< int > &inliers)
 Return the best set of inliers found so far for this model.
void getModelCoefficients (Eigen::VectorXf &model_coefficients)
 Return the model coefficients of the best model found so far.

Detailed Description

SampleConsensus represents the base class.

All sample consensus methods must inherit from this class.

Author:
Radu Bogdan Rusu

Member Typedef Documentation

typedef boost::shared_ptr<const SampleConsensus> pcl::SampleConsensus::ConstPtr

Definition at line 63 of file sac.h.

typedef boost::shared_ptr<SampleConsensus> pcl::SampleConsensus::Ptr

Definition at line 59 of file sac.h.


Constructor & Destructor Documentation

pcl::SampleConsensus::SampleConsensus ( const SampleConsensusModelPtr &  model) [inline]

Constructor for base SAC.

Parameters:
modela Sample Consensus model

Definition at line 68 of file sac.h.

pcl::SampleConsensus::SampleConsensus ( const SampleConsensusModelPtr &  model,
double  threshold 
) [inline]

Constructor for base SAC.

Parameters:
modela Sample Consensus model
thresholddistance to model threshold

Definition at line 76 of file sac.h.

virtual pcl::SampleConsensus::~SampleConsensus ( ) [inline, virtual]

Destructor for base SAC.

Definition at line 83 of file sac.h.


Member Function Documentation

virtual bool pcl::SampleConsensus::computeModel ( int  debug_verbosity_level = 0) [pure virtual]
double pcl::SampleConsensus::getDistanceThreshold ( ) [inline]

Get the distance to model threshold, as set by the user.

Definition at line 91 of file sac.h.

void pcl::SampleConsensus::getInliers ( std::vector< int > &  inliers) [inline]

Return the best set of inliers found so far for this model.

Parameters:
inliersthe resultant set of inliers

Definition at line 136 of file sac.h.

int pcl::SampleConsensus::getMaxIterations ( ) [inline]

Get the maximum number of iterations, as set by the user.

Definition at line 99 of file sac.h.

void pcl::SampleConsensus::getModel ( std::vector< int > &  model) [inline]

Return the best model found so far.

Parameters:
modelthe resultant model

Definition at line 131 of file sac.h.

void pcl::SampleConsensus::getModelCoefficients ( Eigen::VectorXf &  model_coefficients) [inline]

Return the model coefficients of the best model found so far.

Parameters:
model_coefficientsthe resultant model coefficients

Definition at line 141 of file sac.h.

double pcl::SampleConsensus::getProbability ( ) [inline]

Obtain the probability of choosing at least one sample free from outliers, as set by the user.

Definition at line 108 of file sac.h.

void pcl::SampleConsensus::getRandomSamples ( const boost::shared_ptr< std::vector< int > > &  indices,
size_t  nr_samples,
std::set< int > &  indices_subset 
) [inline]

Get a set of randomly selected indices.

Parameters:
indicesthe input indices vector
nr_samplesthe desired number of point indices to randomly select
indices_subsetthe resultant output set of randomly selected indices

Reimplemented in pcl::ProgressiveSampleConsensus.

Definition at line 119 of file sac.h.

void pcl::SampleConsensus::setDistanceThreshold ( double  threshold) [inline]

Set the distance to model threshold.

Parameters:
thresholddistance to model threshold

Definition at line 88 of file sac.h.

void pcl::SampleConsensus::setMaxIterations ( int  max_iterations) [inline]

Set the maximum number of iterations.

Parameters:
max_iterationsmaximum number of iterations

Definition at line 96 of file sac.h.

void pcl::SampleConsensus::setProbability ( double  probability) [inline]

Set the desired probability of choosing at least one sample free from outliers.

Parameters:
probabilitythe desired probability of choosing at least one sample free from outliers
Note:
internally, the probability is set to 99% (0.99) by default.

Definition at line 105 of file sac.h.


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