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 | Protected Member Functions | List of all members
OpenCVForUnity.Xfeatures2dModule.VGG Class Reference

Class implementing VGG (Oxford Visual Geometry Group) descriptor trained end to end using "Descriptor Learning Using Convex Optimisation" (DLCO) aparatus described in [Simonyan14]. More...

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

Public Member Functions

override string getDefaultName ()
 
void setSigma (float isigma)
 
float getSigma ()
 
void setUseNormalizeImage (bool img_normalize)
 
bool getUseNormalizeImage ()
 
void setUseScaleOrientation (bool use_scale_orientation)
 
bool getUseScaleOrientation ()
 
void setScaleFactor (float scale_factor)
 
float getScaleFactor ()
 
void setUseNormalizeDescriptor (bool dsc_normalize)
 
bool getUseNormalizeDescriptor ()
 
- 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 VGG __fromPtr__ (IntPtr addr)
 
static VGG create (int desc, float isigma, bool img_normalize, bool use_scale_orientation, float scale_factor, bool dsc_normalize)
 
static VGG create (int desc, float isigma, bool img_normalize, bool use_scale_orientation, float scale_factor)
 
static VGG create (int desc, float isigma, bool img_normalize, bool use_scale_orientation)
 
static VGG create (int desc, float isigma, bool img_normalize)
 
static VGG create (int desc, float isigma)
 
static VGG create (int desc)
 
static VGG create ()
 
- 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.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 VGG (Oxford Visual Geometry Group) descriptor trained end to end using "Descriptor Learning Using Convex Optimisation" (DLCO) aparatus described in [Simonyan14].

desc type of descriptor to use, VGG::VGG_120 is default (120 dimensions float) Available types are VGG::VGG_120, VGG::VGG_80, VGG::VGG_64, VGG::VGG_48 isigma gaussian kernel value for image blur (default is 1.4f) img_normalize use image sample intensity normalization (enabled by default) use_orientation sample patterns using keypoints orientation, enabled by default scale_factor adjust the sampling window of detected keypoints to 64.0f (VGG sampling window) 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

dsc_normalize clamp descriptors to 255 and convert to uchar CV_8UC1 (disabled by default)

Member Function Documentation

◆ __fromPtr__()

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

◆ create() [1/7]

static VGG OpenCVForUnity.Xfeatures2dModule.VGG.create ( int  desc,
float  isigma,
bool  img_normalize,
bool  use_scale_orientation,
float  scale_factor,
bool  dsc_normalize 
)
static

◆ create() [2/7]

static VGG OpenCVForUnity.Xfeatures2dModule.VGG.create ( int  desc,
float  isigma,
bool  img_normalize,
bool  use_scale_orientation,
float  scale_factor 
)
static

◆ create() [3/7]

static VGG OpenCVForUnity.Xfeatures2dModule.VGG.create ( int  desc,
float  isigma,
bool  img_normalize,
bool  use_scale_orientation 
)
static

◆ create() [4/7]

static VGG OpenCVForUnity.Xfeatures2dModule.VGG.create ( int  desc,
float  isigma,
bool  img_normalize 
)
static

◆ create() [5/7]

static VGG OpenCVForUnity.Xfeatures2dModule.VGG.create ( int  desc,
float  isigma 
)
static

◆ create() [6/7]

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

◆ create() [7/7]

static VGG OpenCVForUnity.Xfeatures2dModule.VGG.create ( )
static

◆ Dispose()

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

◆ getDefaultName()

override string OpenCVForUnity.Xfeatures2dModule.VGG.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.VGG.getScaleFactor ( )

◆ getSigma()

float OpenCVForUnity.Xfeatures2dModule.VGG.getSigma ( )

◆ getUseNormalizeDescriptor()

bool OpenCVForUnity.Xfeatures2dModule.VGG.getUseNormalizeDescriptor ( )

◆ getUseNormalizeImage()

bool OpenCVForUnity.Xfeatures2dModule.VGG.getUseNormalizeImage ( )

◆ getUseScaleOrientation()

bool OpenCVForUnity.Xfeatures2dModule.VGG.getUseScaleOrientation ( )

◆ setScaleFactor()

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

◆ setSigma()

void OpenCVForUnity.Xfeatures2dModule.VGG.setSigma ( float  isigma)

◆ setUseNormalizeDescriptor()

void OpenCVForUnity.Xfeatures2dModule.VGG.setUseNormalizeDescriptor ( bool  dsc_normalize)

◆ setUseNormalizeImage()

void OpenCVForUnity.Xfeatures2dModule.VGG.setUseNormalizeImage ( bool  img_normalize)

◆ setUseScaleOrientation()

void OpenCVForUnity.Xfeatures2dModule.VGG.setUseScaleOrientation ( bool  use_scale_orientation)

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