Solar
Public Member Functions | List of all members
SolAR::api::features::IDescriptorsExtractorFromImage Class Referenceabstract

Detect keypoints and compute the descriptors from an image. UUID: 1cd4f5f1-6b74-413b-9725-69653aee48ef More...

#include <IDescriptorsExtractorFromImage.h>

Inheritance diagram for SolAR::api::features::IDescriptorsExtractorFromImage:
Inheritance graph
[legend]
Collaboration diagram for SolAR::api::features::IDescriptorsExtractorFromImage:
Collaboration graph
[legend]

Public Member Functions

 IDescriptorsExtractorFromImage ()=default
 IDescriptorsExtractorFromImage default constructor.
 
virtual ~IDescriptorsExtractorFromImage ()
 IDescriptorsExtractorFromImage default destructor.
 
virtual std::string getTypeString ()=0
 getType More...
 
virtual FrameworkReturnCode extract (const SRef< SolAR::datastructure::Image > image, std::vector< SolAR::datastructure::Keypoint > &keypoints, SRef< SolAR::datastructure::DescriptorBuffer > &descriptors)=0
 detect keypoints and compute the descriptors. More...
 

Detailed Description

Detect keypoints and compute the descriptors from an image. UUID: 1cd4f5f1-6b74-413b-9725-69653aee48ef

This class provides a method to extract descriptors directly from an image

Member Function Documentation

◆ extract()

virtual FrameworkReturnCode SolAR::api::features::IDescriptorsExtractorFromImage::extract ( const SRef< SolAR::datastructure::Image image,
std::vector< SolAR::datastructure::Keypoint > &  keypoints,
SRef< SolAR::datastructure::DescriptorBuffer > &  descriptors 
)
pure virtual

detect keypoints and compute the descriptors.

Parameters
[in]imageimage on which the keypoint and their descriptor will be detected and extracted.
[out]keypointsThe keypoints detected in the input image.
[out]descriptorsThe descriptors of keypoints of the input image.
Returns
FrameworkReturnCode::SUCCESS if images are well matched, else FrameworkReturnCode::_ERROR

◆ getTypeString()

virtual std::string SolAR::api::features::IDescriptorsExtractorFromImage::getTypeString ( )
pure virtual

getType

Returns
a string describing the type of descriptor used during extraction.

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