SolAR::api::reloc::IRegression Class Reference

learn and define a set of 3D world coordinates corresponding to a set of 2D descriptors. UUID: 6741d3ed-0d19-4117-8a66-501704a7ad04 More...

#include <IRegression.h>

Inheritance diagram for SolAR::api::reloc::IRegression:

Collaboration diagram for SolAR::api::reloc::IRegression:

Public Member Functions
	IRegression ()=default
	IRegression default constructor.
virtual	~IRegression ()=default
	IRegression default destructor.
virtual void	setCameraParameters (const SolAR::datastructure::CamCalibration &intrinsicParams, const SolAR::datastructure::CamDistortion &distorsionParams)=0
	this method is used to set intrinsic parameters and distorsion of the camera More...
virtual FrameworkReturnCode	add (const std::vector< SRef< SolAR::datastructure::DescriptorBuffer > > &descriptors, const std::vector< SolAR::datastructure::Point3Df > &points3D)=0
	Add 2D descriptor and 3D location correspondences. More...
virtual FrameworkReturnCode	regress (const SRef< SolAR::datastructure::Frame > &frame, std::vector< SolAR::datastructure::Point2Df > &points2D, std::vector< SolAR::datastructure::Point3Df > &points3D)=0
	Regress a set of descriptors to define 2D-3D point correspondences. More...
virtual FrameworkReturnCode	update (std::vector< bool > &inliers, SolAR::datastructure::Transform3Df &cameraPose)=0
	Update regression model. More...
virtual FrameworkReturnCode	loadModel ()=0
	Load regression model. More...
virtual std::vector< int >	getTrainingStatus ()=0
	Get the current training status. More...
virtual int	getNumActiveLeaves ()=0
	Get number of active leaves. More...
virtual int	getNumPassiveLeaves ()=0
	Get number of passive leaves. More...

Detailed Description

learn and define a set of 3D world coordinates corresponding to a set of 2D descriptors. UUID: 6741d3ed-0d19-4117-8a66-501704a7ad04

This class provides a solution to learn and define a set of 3D world coordinates corresponding to a set of 2D descriptors.

Member Function Documentation

add()

virtual FrameworkReturnCode SolAR::api::reloc::IRegression::add ( const std::vector< SRef< SolAR::datastructure::DescriptorBuffer > > &  descriptors, const std::vector< SolAR::datastructure::Point3Df > &  points3D  )

pure virtual

Add 2D descriptor and 3D location correspondences.

Parameters

[in]	descriptors	a set of descriptors
[in]	points3D	a set of corresponding 3D locations

Returns

FrameworkReturnCode::SUCCESS if adding succeed, else FrameworkReturnCode::_ERROR

getNumActiveLeaves()

virtual int SolAR::api::reloc::IRegression::getNumActiveLeaves ( )

pure virtual

Get number of active leaves.

Returns

Nb of active leaves as integer.

getNumPassiveLeaves()

virtual int SolAR::api::reloc::IRegression::getNumPassiveLeaves ( )

pure virtual

Get number of passive leaves.

Returns

Nb of passive leaves as integer.

getTrainingStatus()

virtual std::vector< int > SolAR::api::reloc::IRegression::getTrainingStatus ( )

pure virtual

Get the current training status.

Returns

Vector where first value is the size of the current training data, and second is the maximum nb of training data.

loadModel()

virtual FrameworkReturnCode SolAR::api::reloc::IRegression::loadModel ( )

pure virtual

Load regression model.

Returns

FrameworkReturnCode::SUCCESS if the regression succeed, else FrameworkReturnCode::_ERROR

regress()

virtual FrameworkReturnCode SolAR::api::reloc::IRegression::regress ( const SRef< SolAR::datastructure::Frame > &  frame, std::vector< SolAR::datastructure::Point2Df > &  points2D, std::vector< SolAR::datastructure::Point3Df > &  points3D  )

pure virtual

Regress a set of descriptors to define 2D-3D point correspondences.

Parameters

[in]	frame	the frame contains descriptors for regression.
[out]	points2D	a set of 2D points
[out]	points3D	a set of 3D points

Returns

FrameworkReturnCode::SUCCESS if the regression succeed, else FrameworkReturnCode::_ERROR

setCameraParameters()

virtual void SolAR::api::reloc::IRegression::setCameraParameters ( const SolAR::datastructure::CamCalibration &  intrinsicParams, const SolAR::datastructure::CamDistortion &  distorsionParams  )

pure virtual

this method is used to set intrinsic parameters and distorsion of the camera

Parameters

[in]	intrinsicParams	camera calibration matrix parameters.
[in]	distorsionParams	camera distorsion parameters.

update()

virtual FrameworkReturnCode SolAR::api::reloc::IRegression::update ( std::vector< bool > &  inliers, SolAR::datastructure::Transform3Df &  cameraPose  )

pure virtual

Update regression model.

Parameters

[in]	inliers	inliers and outliers are defined for each 2D point
[in]	cameraPose	camera pose of the current frame

Returns

FrameworkReturnCode::SUCCESS if the regression succeed, else FrameworkReturnCode::_ERROR

---

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

• interfaces/api/reloc/IRegression.h