OpenCVForUnity.Xfeatures2dModule.TEBLID Class Reference

Class implementing TEBLID (Triplet-based Efficient Binary Local Image Descriptor), described in [Suarez2021TEBLID]. More...

Public Member Functions
override string	getDefaultName ()
Public Member Functions inherited from OpenCVForUnity.Features2dModule.Feature2D
void	compute (List< Mat > images, List< MatOfKeyPoint > keypoints, List< Mat > descriptors)
void	compute (Mat image, MatOfKeyPoint keypoints, Mat descriptors)
	Computes the descriptors for a set of keypoints detected in an image (first variant) or image set (second variant).
int	defaultNorm ()
int	descriptorSize ()
int	descriptorType ()
void	detect (List< Mat > images, List< MatOfKeyPoint > keypoints)
void	detect (List< Mat > images, List< MatOfKeyPoint > keypoints, List< Mat > masks)
void	detect (Mat image, MatOfKeyPoint keypoints)
	Detects keypoints in an image (first variant) or image set (second variant).
void	detect (Mat image, MatOfKeyPoint keypoints, Mat mask)
	Detects keypoints in an image (first variant) or image set (second variant).
void	detectAndCompute (Mat image, Mat mask, MatOfKeyPoint keypoints, Mat descriptors)
void	detectAndCompute (Mat image, Mat mask, MatOfKeyPoint keypoints, Mat descriptors, bool useProvidedKeypoints)
override bool	empty ()
	Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read.
void	read (string fileName)
void	write (string fileName)
Public Member Functions inherited from OpenCVForUnity.CoreModule.Algorithm
virtual void	clear ()
	Clears the algorithm state.
IntPtr	getNativeObjAddr ()
void	save (string filename)
Public Member Functions inherited from OpenCVForUnity.DisposableObject
void	Dispose ()
void	ThrowIfDisposed ()

Static Public Member Functions
static new TEBLID	__fromPtr__ (IntPtr addr)
static TEBLID	create (float scale_factor)
	Creates the TEBLID descriptor.
static TEBLID	create (float scale_factor, int n_bits)
	Creates the TEBLID descriptor.
Static Public Member Functions inherited from OpenCVForUnity.Features2dModule.Feature2D
static new Feature2D	__fromPtr__ (IntPtr addr)
Static Public Member Functions inherited from OpenCVForUnity.CoreModule.Algorithm
static Algorithm	__fromPtr__ (IntPtr addr)
Static Public Member Functions inherited from OpenCVForUnity.DisposableObject
static IntPtr	ThrowIfNullIntPtr (IntPtr ptr)

Static Public Attributes
const int	SIZE_256_BITS = 102
const int	SIZE_512_BITS = 103

Protected Member Functions
override void	Dispose (bool disposing)
Protected Member Functions inherited from OpenCVForUnity.Features2dModule.Feature2D
Protected Member Functions inherited from OpenCVForUnity.CoreModule.Algorithm
Protected Member Functions inherited from OpenCVForUnity.DisposableOpenCVObject
	DisposableOpenCVObject ()
	DisposableOpenCVObject (bool isEnabledDispose)
	DisposableOpenCVObject (IntPtr ptr)
	DisposableOpenCVObject (IntPtr ptr, bool isEnabledDispose)
Protected Member Functions inherited from OpenCVForUnity.DisposableObject
	DisposableObject ()
	DisposableObject (bool isEnabledDispose)

Additional Inherited Members
Package Functions inherited from OpenCVForUnity.Features2dModule.Feature2D
Package Functions inherited from OpenCVForUnity.CoreModule.Algorithm
Package Attributes inherited from OpenCVForUnity.DisposableOpenCVObject
Properties inherited from OpenCVForUnity.DisposableObject
bool	IsDisposed [get, protected set]
bool	IsEnabledDispose [get, set]

Detailed Description

Class implementing TEBLID (Triplet-based Efficient Binary Local Image Descriptor), described in [Suarez2021TEBLID].

TEBLID stands for Triplet-based Efficient Binary Local Image Descriptor, although originally it was called BAD [Suarez2021TEBLID]. It is an improvement over BEBLID [Suarez2020BEBLID], that uses triplet loss, hard negative mining, and anchor swap to improve the image matching results. It is able to describe keypoints from any detector just by changing the scale_factor parameter. TEBLID is as efficient as ORB, BEBLID or BRISK, but the triplet-based training objective selected more discriminative features that explain the accuracy gain. It is also more compact than BEBLID, when running the AKAZE example with 10000 keypoints detected by ORB, BEBLID obtains 561 inliers (75%) with 512 bits, whereas TEBLID obtains 621 (75.2%) with 256 bits. ORB obtains only 493 inliers (63%).

If you find this code useful, please add a reference to the following paper: <BLOCKQUOTE> Iago Suárez, José M. Buenaposada, and Luis Baumela. Revisiting Binary Local Image Description for Resource Limited Devices. IEEE Robotics and Automation Letters, vol. 6, no. 4, pp. 8317-8324, Oct. 2021. </BLOCKQUOTE>

The descriptor was trained in Liberty split of the UBC datasets [winder2007learning] .

Member Function Documentation

__fromPtr__()

static new TEBLID OpenCVForUnity.Xfeatures2dModule.TEBLID.__fromPtr__ ( IntPtr addr )

static

create() [1/2]

static TEBLID OpenCVForUnity.Xfeatures2dModule.TEBLID.create ( float scale_factor )

static

Creates the TEBLID descriptor.

Parameters

scale_factor	Adjust the sampling window around detected keypoints: <b> 1.00f </b> should be the scale for ORB keypoints <b> 6.75f </b> should be the scale for SIFT detected keypoints <b> 6.25f </b> is default and fits for KAZE, SURF detected keypoints <b> 5.00f </b> should be the scale for AKAZE, MSD, AGAST, FAST, BRISK keypoints
n_bits	Determine the number of bits in the descriptor. Should be either TEBLID.SIZE_256_BITS or TEBLID.SIZE_512_BITS.

create() [2/2]

static TEBLID OpenCVForUnity.Xfeatures2dModule.TEBLID.create ( float scale_factor, int n_bits )

static

Creates the TEBLID descriptor.

Parameters

scale_factor	Adjust the sampling window around detected keypoints: <b> 1.00f </b> should be the scale for ORB keypoints <b> 6.75f </b> should be the scale for SIFT detected keypoints <b> 6.25f </b> is default and fits for KAZE, SURF detected keypoints <b> 5.00f </b> should be the scale for AKAZE, MSD, AGAST, FAST, BRISK keypoints
n_bits	Determine the number of bits in the descriptor. Should be either TEBLID.SIZE_256_BITS or TEBLID.SIZE_512_BITS.

Dispose()

override void OpenCVForUnity.Xfeatures2dModule.TEBLID.Dispose ( bool disposing )

protectedvirtual

Reimplemented from OpenCVForUnity.Features2dModule.Feature2D.

getDefaultName()

override string OpenCVForUnity.Xfeatures2dModule.TEBLID.getDefaultName ( )

virtual

Returns the algorithm string identifier. This string is used as top level xml/yml node tag when the object is saved to a file or string.

Reimplemented from OpenCVForUnity.Features2dModule.Feature2D.

Member Data Documentation

SIZE_256_BITS

const int OpenCVForUnity.Xfeatures2dModule.TEBLID.SIZE_256_BITS = 102

static

SIZE_512_BITS

const int OpenCVForUnity.Xfeatures2dModule.TEBLID.SIZE_512_BITS = 103

static

---

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

• OpenCVForUnity/Assets/OpenCVForUnity/org/opencv_contrib/xfeatures2d/TEBLID.cs