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

Extracts descriptors from a set of keypoints. UUID: c0e49ff1-0696-4fe6-85a8-9b2c1e155d2e More...

#include <IDescriptorsExtractor.h>

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

Public Types

enum class  DescriptorsExtractorType {
  UNKNOWN_TYPE =-1 , SURF , ORB , SIFT ,
  DAISY , LATCH , AKAZE , AKAZEUP ,
  BRISK , BRIEF
}
 The DescriptorsExtractorType enum.
 

Public Member Functions

 IDescriptorsExtractor ()=default
 IDescriptorsExtractor default constructor.
 
virtual ~IDescriptorsExtractor ()
 IDescriptorsExtractor default destructor.
 
virtual std::string getTypeString ()=0
 getType More...
 
virtual void extract (const SRef< SolAR::datastructure::Image > image, const std::vector< SolAR::datastructure::Keypoint > &keypoints, SRef< SolAR::datastructure::DescriptorBuffer > &descriptors)=0
 extract the descriptors for a set of keypoints More...
 

Detailed Description

Extracts descriptors from a set of keypoints. UUID: c0e49ff1-0696-4fe6-85a8-9b2c1e155d2e

This class provides a method to extract descriptors from a set of keypoints

Member Function Documentation

◆ extract()

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

extract the descriptors for a set of keypoints

Parameters
[in]imageThe image on which the keypoints have been detected
[in]keypointsThe set of keypoints on which the descriptors are extracted
[out]descriptorsThe extracted descriptors. The nth descriptor corresponds to the nth keypoint of the second argument.

◆ getTypeString()

virtual std::string SolAR::api::features::IDescriptorsExtractor::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: