OpenCVForUnity.Xfeatures2dModule.BoostDesc Class Reference

Class implementing BoostDesc (Learning Image Descriptors with Boosting), described in [Trzcinski13a] and [Trzcinski13b]. More...

Public Member Functions
override string	getDefaultName ()
float	getScaleFactor ()
bool	getUseScaleOrientation ()
void	setScaleFactor (float scale_factor)
void	setUseScaleOrientation (bool use_scale_orientation)
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.
override string	getDefaultName ()
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 BoostDesc	__fromPtr__ (IntPtr addr)
static BoostDesc	create ()
static BoostDesc	create (int desc)
static BoostDesc	create (int desc, bool use_scale_orientation)
static BoostDesc	create (int desc, bool use_scale_orientation, float scale_factor)
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)

Protected Member Functions
override void	Dispose (bool disposing)
Protected Member Functions inherited from OpenCVForUnity.Features2dModule.Feature2D
override void	Dispose (bool disposing)
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 BoostDesc (Learning Image Descriptors with Boosting), described in [Trzcinski13a] and [Trzcinski13b].

desc type of descriptor to use, BoostDesc::BINBOOST_256 is default (256 bit long dimension) Available types are: BoostDesc::BGM, BoostDesc::BGM_HARD, BoostDesc::BGM_BILINEAR, BoostDesc::LBGM, BoostDesc::BINBOOST_64, BoostDesc::BINBOOST_128, BoostDesc::BINBOOST_256 use_orientation sample patterns using keypoints orientation, enabled by default scale_factor adjust the sampling window of detected keypoints 6.25f is default and fits for KAZE, SURF detected keypoints window ratio 6.75f should be the scale for SIFT detected keypoints window ratio 5.00f should be the scale for AKAZE, MSD, AGAST, FAST, BRISK keypoints window ratio 0.75f should be the scale for ORB keypoints ratio 1.50f was the default in original implementation

Note

BGM is the base descriptor where each binary dimension is computed as the output of a single weak learner. BGM_HARD and BGM_BILINEAR refers to same BGM but use different type of gradient binning. In the BGM_HARD that use ASSIGN_HARD binning type the gradient is assigned to the nearest orientation bin. In the BGM_BILINEAR that use ASSIGN_BILINEAR binning type the gradient is assigned to the two neighbouring bins. In the BGM and all other modes that use ASSIGN_SOFT binning type the gradient is assigned to 8 nearest bins according to the cosine value between the gradient angle and the bin center. LBGM (alias FP-Boost) is the floating point extension where each dimension is computed as a linear combination of the weak learner responses. BINBOOST and subvariants are the binary extensions of LBGM where each bit is computed as a thresholded linear combination of a set of weak learners. BoostDesc header files (boostdesc_*.i) was exported from original binaries with export-boostdesc.py script from samples subfolder.

Member Function Documentation

__fromPtr__()

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

static

create() [1/4]

static BoostDesc OpenCVForUnity.Xfeatures2dModule.BoostDesc.create ( )

static

create() [2/4]

static BoostDesc OpenCVForUnity.Xfeatures2dModule.BoostDesc.create ( int desc )

static

create() [3/4]

static BoostDesc OpenCVForUnity.Xfeatures2dModule.BoostDesc.create ( int desc, bool use_scale_orientation )

static

create() [4/4]

static BoostDesc OpenCVForUnity.Xfeatures2dModule.BoostDesc.create ( int desc, bool use_scale_orientation, float scale_factor )

static

Dispose()

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

protectedvirtual

Reimplemented from OpenCVForUnity.CoreModule.Algorithm.

getDefaultName()

override string OpenCVForUnity.Xfeatures2dModule.BoostDesc.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.CoreModule.Algorithm.

getScaleFactor()

float OpenCVForUnity.Xfeatures2dModule.BoostDesc.getScaleFactor

(

)

getUseScaleOrientation()

bool OpenCVForUnity.Xfeatures2dModule.BoostDesc.getUseScaleOrientation

(

)

setScaleFactor()

void OpenCVForUnity.Xfeatures2dModule.BoostDesc.setScaleFactor

(

float

scale_factor

)

setUseScaleOrientation()

void OpenCVForUnity.Xfeatures2dModule.BoostDesc.setUseScaleOrientation

(

bool

use_scale_orientation

)

---

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

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