RobWorkProject  23.9.11-
Public Types | Public Member Functions | Protected Attributes | Friends | List of all members
LineModel Class Reference

A line model. More...

#include <LineModel.hpp>

Inherits RANSACModel< LineModel, rw::math::Vector3D<> >.

Public Types

typedef rw::core::Ptr< LineModelPtr
 Smart pointer type to this class.
 
- Public Types inherited from RANSACModel< LineModel, rw::math::Vector3D<> >
typedef rw::core::Ptr< RANSACModel< LineModel, rw::math::Vector3D<> > > Ptr
 Smart pointer type to this class.
 

Public Member Functions

 LineModel ()
 Constructor.
 
 LineModel (const rw::geometry::Line &line)
 Constructor.
 
virtual ~LineModel ()
 Destructor.
 
virtual double fitError (const rw::math::Vector3D<> &sample) const
 Calculates the fitting error of a sample. More...
 
virtual bool invalid () const
 Checks whether the model is invalid. More...
 
virtual int getMinReqData () const
 Returns the number of samples required to create the model. More...
 
virtual double refit (const std::vector< rw::math::Vector3D<>> &samples)
 Recalculates the model based on provided samples. More...
 
virtual bool same (const LineModel &model, double threshold) const
 Tests whether the model is same to a threshold of another model. More...
 
rw::geometry::Line line () const
 Get line.
 
- Public Member Functions inherited from RANSACModel< LineModel, rw::math::Vector3D<> >
 RANSACModel ()
 Constructor.
 
virtual LineModel make (const std::vector< rw::math::Vector3D<> > &data) const
 Creates a new model of this type using provided data.
 
virtual ~RANSACModel ()
 Destructor.
 
bool operator< (const LineModel &model) const
 'Worse than' operator. More...
 
bool operator> (const LineModel &model) const
 'Better than' operator. More...
 
virtual bool belongsTo (const rw::math::Vector3D<> &sample, double threshold) const
 Check whether a sample belongs to the model. More...
 
virtual double refit (const std::vector< rw::math::Vector3D<> > &data)=0
 Recalculates the model based on provided samples. More...
 
size_t getNumberOfInliers () const
 Get the number of inliers.
 
double getQuality () const
 Get the model quality. More...
 
void setQuality (double quality)
 Set the model quality. More...
 
std::vector< rw::math::Vector3D<> > & getData ()
 Access data.
 
const std::vector< rw::math::Vector3D<> > & getData () const
 Access data.
 
std::vector< size_t > getInlierIndices () const
 Get the vector of inlier indices. More...
 

Protected Attributes

rw::geometry::Line _model
 
- Protected Attributes inherited from RANSACModel< LineModel, rw::math::Vector3D<> >
std::vector< rw::math::Vector3D<> > _data
 
double _quality
 
std::vector< size_t > _indices
 

Friends

std::ostream & operator<< (std::ostream &out, const LineModel &model)
 Streaming operator.
 

Additional Inherited Members

- Static Public Member Functions inherited from RANSACModel< LineModel, rw::math::Vector3D<> >
static std::vector< LineModelfindModels (const std::vector< rw::math::Vector3D<> > &data, int maxIterations, int dataRequired, double dataThreshold, double modelThreshold)
 Find models fitting a set of observations. More...
 
static LineModel bestModel (const std::vector< LineModel > &models)
 Select the model with the largest number of inliers. More...
 
static LineModel likelyModel (const std::vector< LineModel > &models)
 Select a model randomly, with a chance based on the number of inliers. More...
 

Detailed Description

A line model.

Member Function Documentation

◆ fitError()

virtual double fitError ( const rw::math::Vector3D<> &  sample) const
virtual

Calculates the fitting error of a sample.

Implements RANSACModel< LineModel, rw::math::Vector3D<> >.

◆ getMinReqData()

virtual int getMinReqData ( ) const
inlinevirtual

Returns the number of samples required to create the model.

No model will be found, if data size is less than this amount.

LineModel requires at least 2 sample.

Implements RANSACModel< LineModel, rw::math::Vector3D<> >.

◆ invalid()

virtual bool invalid ( ) const
virtual

Checks whether the model is invalid.

Implements RANSACModel< LineModel, rw::math::Vector3D<> >.

◆ refit()

virtual double refit ( const std::vector< rw::math::Vector3D<>> &  samples)
virtual

Recalculates the model based on provided samples.

Returns
Fit error on a set of provided samples.

◆ same()

virtual bool same ( const LineModel model,
double  threshold 
) const
virtual

Tests whether the model is same to a threshold of another model.

This is used to filter down (merge) similar models found in the course of RANSAC algorithm execution.

LineModels are the same when the distance between them, according to metric taking into account weighted sum of direction angle difference and the closest separation between lines is lower than specified threshold.

Implements RANSACModel< LineModel, rw::math::Vector3D<> >.


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