OpenCV for Unity  2.6.3
Enox Software / Please refer to OpenCV official document ( http://docs.opencv.org/4.10.0/index.html ) for the details of the argument of the method.
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | List of all members
OpenCVForUnity.Xfeatures2dModule.BEBLID Class Reference

Class implementing BEBLID (Boosted Efficient Binary Local Image Descriptor), described in [Suarez2020BEBLID] . More...

Inheritance diagram for OpenCVForUnity.Xfeatures2dModule.BEBLID:
OpenCVForUnity.Features2dModule.Feature2D OpenCVForUnity.CoreModule.Algorithm OpenCVForUnity.DisposableOpenCVObject OpenCVForUnity.DisposableObject

Public Member Functions

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

Static Public Member Functions

static new BEBLID __fromPtr__ (IntPtr addr)
 
static BEBLID create (float scale_factor, int n_bits)
 Creates the BEBLID descriptor. More...
 
static BEBLID create (float scale_factor)
 Creates the BEBLID descriptor. More...
 
- 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)
 

Public Attributes

const int SIZE_512_BITS = 100
 
const int SIZE_256_BITS = 101
 

Protected Member Functions

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

Additional Inherited Members

- Properties inherited from OpenCVForUnity.DisposableObject
bool IsDisposed [get, protected set]
 
bool IsEnabledDispose [get, set]
 

Detailed Description

Class implementing BEBLID (Boosted Efficient Binary Local Image Descriptor), described in [Suarez2020BEBLID] .

BEBLID [Suarez2020BEBLID] is a efficient binary descriptor learned with boosting. It is able to describe keypoints from any detector just by changing the scale_factor parameter. In several benchmarks it has proved to largely improve other binary descriptors like ORB or BRISK with the same efficiency. BEBLID describes using the difference of mean gray values in different regions of the image around the KeyPoint, the descriptor is specifically optimized for image matching and patch retrieval addressing the asymmetries of these problems.

If you find this code useful, please add a reference to the following paper: <BLOCKQUOTE> Iago Suárez, Ghesn Sfeir, José M. Buenaposada, and Luis Baumela. BEBLID: Boosted efficient binary local image descriptor. Pattern Recognition Letters, 133:366–372, 2020. </BLOCKQUOTE>

The descriptor was trained using 1 million of randomly sampled pairs of patches (20% positives and 80% negatives) from the Liberty split of the UBC datasets [winder2007learning] as described in the paper [Suarez2020BEBLID]. You can check in the AKAZE example how well BEBLID works. Detecting 10000 keypoints with ORB and describing with BEBLID obtains 561 inliers (75%) whereas describing with ORB obtains only 493 inliers (63%).

Member Function Documentation

◆ __fromPtr__()

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

◆ create() [1/2]

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

Creates the BEBLID descriptor.

Parameters
scale_factorAdjust 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_bitsDetermine the number of bits in the descriptor. Should be either BEBLID::SIZE_512_BITS or BEBLID::SIZE_256_BITS.

◆ create() [2/2]

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

Creates the BEBLID descriptor.

Parameters
scale_factorAdjust 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_bitsDetermine the number of bits in the descriptor. Should be either BEBLID::SIZE_512_BITS or BEBLID::SIZE_256_BITS.

◆ Dispose()

override void OpenCVForUnity.Xfeatures2dModule.BEBLID.Dispose ( bool  disposing)
protectedvirtual

◆ getDefaultName()

override string OpenCVForUnity.Xfeatures2dModule.BEBLID.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.

◆ getScaleFactor()

float OpenCVForUnity.Xfeatures2dModule.BEBLID.getScaleFactor ( )

◆ setScaleFactor()

void OpenCVForUnity.Xfeatures2dModule.BEBLID.setScaleFactor ( float  scale_factor)

Member Data Documentation

◆ SIZE_256_BITS

const int OpenCVForUnity.Xfeatures2dModule.BEBLID.SIZE_256_BITS = 101

◆ SIZE_512_BITS

const int OpenCVForUnity.Xfeatures2dModule.BEBLID.SIZE_512_BITS = 100

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