SolAR::api::pipeline::IRelocalizationPipeline Class Reference

Defines a relocalization pipeline. UUID: ef2a631d-93c9-4979-ad1e-5fa16d5d00ef More...

#include <IRelocalizationPipeline.h>

Inheritance diagram for SolAR::api::pipeline::IRelocalizationPipeline:

Collaboration diagram for SolAR::api::pipeline::IRelocalizationPipeline:

Public Member Functions
	IRelocalizationPipeline ()=default
	IRelocalizationPipeline default constructor.
virtual	~IRelocalizationPipeline ()=default
	IRelocalizationPipeline default destructor.
virtual FrameworkReturnCode	setCameraParameters (const SolAR::datastructure::CameraParameters &cameraParams)=0
	Set the camera parameters. More...
virtual FrameworkReturnCode	getCameraParameters (SolAR::datastructure::CameraParameters &cameraParams) const =0
	Get the camera parameters. More...
virtual FrameworkReturnCode	relocalizeProcessRequest (const SRef< SolAR::datastructure::Image > image, SolAR::datastructure::Transform3Df &pose, float_t &confidence)=0
	Request the relocalization pipeline to process a new image to calculate the corresponding pose. More...
virtual FrameworkReturnCode	getMapRequest (SRef< SolAR::datastructure::Map > &map) const =0
	Request to the relocalization pipeline to get the map. More...
Public Member Functions inherited from SolAR::api::pipeline::IPipeline
virtual FrameworkReturnCode	init ()=0
	Initialization of the pipeline. More...
virtual FrameworkReturnCode	start ()=0
	Start the pipeline. More...
virtual FrameworkReturnCode	stop ()=0
	Stop the pipeline. More...

Detailed Description

Defines a relocalization pipeline. UUID: ef2a631d-93c9-4979-ad1e-5fa16d5d00ef

This class provides the interface to define a relocalization processing pipeline.

Member Function Documentation

getCameraParameters()

virtual FrameworkReturnCode SolAR::api::pipeline::IRelocalizationPipeline::getCameraParameters ( SolAR::datastructure::CameraParameters &  cameraParams ) const

pure virtual

Get the camera parameters.

Parameters

[out]

cameraParams

the camera parameters (its resolution and its focal)

Returns

FrameworkReturnCode::SUCCESS if the camera parameters are correctly returned, else FrameworkReturnCode::_ERROR

getMapRequest()

virtual FrameworkReturnCode SolAR::api::pipeline::IRelocalizationPipeline::getMapRequest ( SRef< SolAR::datastructure::Map > &  map ) const

pure virtual

Request to the relocalization pipeline to get the map.

Parameters

[out]

map

the output map

Returns

FrameworkReturnCode::SUCCESS if the map is available, else FrameworkReturnCode::_ERROR

relocalizeProcessRequest()

virtual FrameworkReturnCode SolAR::api::pipeline::IRelocalizationPipeline::relocalizeProcessRequest ( const SRef< SolAR::datastructure::Image >  image, SolAR::datastructure::Transform3Df &  pose, float_t &  confidence  )

pure virtual

Request the relocalization pipeline to process a new image to calculate the corresponding pose.

Parameters

[in]	image	the image to process
[out]	pose	the new calculated pose
[out]	confidence	the confidence score

Returns

FrameworkReturnCode::SUCCESS if the processing is successful, else FrameworkReturnCode::_ERROR

setCameraParameters()

virtual FrameworkReturnCode SolAR::api::pipeline::IRelocalizationPipeline::setCameraParameters ( const SolAR::datastructure::CameraParameters &  cameraParams )

pure virtual

Set the camera parameters.

Parameters

[in]

cameraParams

the camera parameters (its resolution and its focal)

Returns

FrameworkReturnCode::SUCCESS if the camera parameters are correctly set, else FrameworkReturnCode::_ERROR

---

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

• interfaces/api/pipeline/IRelocalizationPipeline.h