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

Detects the keypoints from an image. UUID: 0eadc8b7-1265-434c-a4c6-6da8a028e06e More...

#include <IKeypointDetector.h>

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

Public Types

enum class  KeypointDetectorType {
  SURF , ORB , SIFT , DAISY ,
  LATCH , AKAZE , AKAZE2 , AKAZEUP ,
  BRISK , BRIEF , FEATURE_TO_TRACK
}
 KeypointDetectorType enum This enum is used to define the type of an IKeypointDetector object.
 

Public Member Functions

 IKeypointDetector ()=default
 IKeypointDetector default constructor.
 
virtual ~IKeypointDetector ()=default
 IKeypointDetector default destructor.
 
virtual void setType (KeypointDetectorType type)=0
 Set the type of method used to detect keypoints in the image. More...
 
virtual KeypointDetectorType getType ()=0
 Get the type of method used to detect keypoints in the image. More...
 
virtual void detect (const SRef< SolAR::datastructure::Image > image, std::vector< SolAR::datastructure::Keypoint > &keypoints)=0
 This method detects keypoints in an input Image. More...
 

Detailed Description

Detects the keypoints from an image. UUID: 0eadc8b7-1265-434c-a4c6-6da8a028e06e

This class provides a method to detect the keypoint from an image using different kind of method (SURF, ORB, SIFT, etc.).

Member Function Documentation

◆ detect()

virtual void SolAR::api::features::IKeypointDetector::detect ( const SRef< SolAR::datastructure::Image image,
std::vector< SolAR::datastructure::Keypoint > &  keypoints 
)
pure virtual

This method detects keypoints in an input Image.

Parameters
[in]imageinput image on which we are extracting keypoints.
[out]keypointsThe keypoints detected from the image passed as first argument.

◆ getType()

virtual KeypointDetectorType SolAR::api::features::IKeypointDetector::getType ( )
pure virtual

Get the type of method used to detect keypoints in the image.

Returns
The type of method used to detect keypoints.

◆ setType()

virtual void SolAR::api::features::IKeypointDetector::setType ( KeypointDetectorType  type)
pure virtual

Set the type of method used to detect keypoints in the image.

Parameters
[in]typeThe type of method used to detect keypoints.

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