OpenCVForUnity.Features2dModule.Feature2D Class Reference

Abstract base class for 2D image feature detectors and descriptor extractors. More...

Public Member Functions
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 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.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.CoreModule.Algorithm
Package Attributes inherited from OpenCVForUnity.DisposableOpenCVObject
Properties inherited from OpenCVForUnity.DisposableObject
bool	IsDisposed [get, protected set]
bool	IsEnabledDispose [get, set]

Detailed Description

Abstract base class for 2D image feature detectors and descriptor extractors.

Member Function Documentation

__fromPtr__()

static new Feature2D OpenCVForUnity.Features2dModule.Feature2D.__fromPtr__ ( IntPtr addr )

static

compute() [1/2]

void OpenCVForUnity.Features2dModule.Feature2D.compute	(	List< Mat >	images,
		List< MatOfKeyPoint >	keypoints,
		List< Mat >	descriptors )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

images	Image set.
keypoints	Input collection of keypoints. Keypoints for which a descriptor cannot be computed are removed. Sometimes new keypoints can be added, for example: SIFT duplicates keypoint with several dominant orientations (for each orientation).
descriptors	Computed descriptors. In the second variant of the method descriptors[i] are descriptors computed for a keypoints[i]. Row j is the keypoints (or keypoints[i]) is the descriptor for keypoint j-th keypoint.

compute() [2/2]

void OpenCVForUnity.Features2dModule.Feature2D.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).

Parameters

image	Image.
keypoints	Input collection of keypoints. Keypoints for which a descriptor cannot be computed are removed. Sometimes new keypoints can be added, for example: SIFT duplicates keypoint with several dominant orientations (for each orientation).
descriptors	Computed descriptors. In the second variant of the method descriptors[i] are descriptors computed for a keypoints[i]. Row j is the keypoints (or keypoints[i]) is the descriptor for keypoint j-th keypoint.

defaultNorm()

int OpenCVForUnity.Features2dModule.Feature2D.defaultNorm

(

)

descriptorSize()

int OpenCVForUnity.Features2dModule.Feature2D.descriptorSize

(

)

descriptorType()

int OpenCVForUnity.Features2dModule.Feature2D.descriptorType

(

)

detect() [1/4]

void OpenCVForUnity.Features2dModule.Feature2D.detect	(	List< Mat >	images,
		List< MatOfKeyPoint >	keypoints )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

images	Image set.
keypoints	The detected keypoints. In the second variant of the method keypoints[i] is a set of keypoints detected in images[i] .
masks	Masks for each input image specifying where to look for keypoints (optional). masks[i] is a mask for images[i].

detect() [2/4]

void OpenCVForUnity.Features2dModule.Feature2D.detect	(	List< Mat >	images,
		List< MatOfKeyPoint >	keypoints,
		List< Mat >	masks )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

images	Image set.
keypoints	The detected keypoints. In the second variant of the method keypoints[i] is a set of keypoints detected in images[i] .
masks	Masks for each input image specifying where to look for keypoints (optional). masks[i] is a mask for images[i].

detect() [3/4]

void OpenCVForUnity.Features2dModule.Feature2D.detect	(	Mat	image,
		MatOfKeyPoint	keypoints )

Detects keypoints in an image (first variant) or image set (second variant).

Parameters

image	Image.
keypoints	The detected keypoints. In the second variant of the method keypoints[i] is a set of keypoints detected in images[i] .
mask	Mask specifying where to look for keypoints (optional). It must be a 8-bit integer matrix with non-zero values in the region of interest.

detect() [4/4]

void OpenCVForUnity.Features2dModule.Feature2D.detect	(	Mat	image,
		MatOfKeyPoint	keypoints,
		Mat	mask )

Detects keypoints in an image (first variant) or image set (second variant).

Parameters

image	Image.
keypoints	The detected keypoints. In the second variant of the method keypoints[i] is a set of keypoints detected in images[i] .
mask	Mask specifying where to look for keypoints (optional). It must be a 8-bit integer matrix with non-zero values in the region of interest.

detectAndCompute() [1/2]

void OpenCVForUnity.Features2dModule.Feature2D.detectAndCompute	(	Mat	image,
		Mat	mask,
		MatOfKeyPoint	keypoints,
		Mat	descriptors )

Detects keypoints and computes the descriptors

detectAndCompute() [2/2]

void OpenCVForUnity.Features2dModule.Feature2D.detectAndCompute	(	Mat	image,
		Mat	mask,
		MatOfKeyPoint	keypoints,
		Mat	descriptors,
		bool	useProvidedKeypoints )

Detects keypoints and computes the descriptors

Dispose()

override void OpenCVForUnity.Features2dModule.Feature2D.Dispose ( bool disposing )

protectedvirtual

Reimplemented from OpenCVForUnity.CoreModule.Algorithm.

Reimplemented in OpenCVForUnity.Features2dModule.GFTTDetector, OpenCVForUnity.Features2dModule.KAZE, OpenCVForUnity.Features2dModule.MSER, OpenCVForUnity.Features2dModule.ORB, OpenCVForUnity.Features2dModule.SIFT, OpenCVForUnity.Features2dModule.SimpleBlobDetector, OpenCVForUnity.Xfeatures2dModule.FREAK, OpenCVForUnity.Xfeatures2dModule.HarrisLaplaceFeatureDetector, OpenCVForUnity.Xfeatures2dModule.LATCH, OpenCVForUnity.Xfeatures2dModule.LUCID, OpenCVForUnity.Xfeatures2dModule.MSDDetector, OpenCVForUnity.Xfeatures2dModule.StarDetector, OpenCVForUnity.Xfeatures2dModule.TBMR, OpenCVForUnity.Xfeatures2dModule.TEBLID, and OpenCVForUnity.Xfeatures2dModule.VGG.

empty()

override bool OpenCVForUnity.Features2dModule.Feature2D.empty ( )

virtual

Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read.

Reimplemented from OpenCVForUnity.CoreModule.Algorithm.

getDefaultName()

override string OpenCVForUnity.Features2dModule.Feature2D.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.

Reimplemented in OpenCVForUnity.Features2dModule.GFTTDetector, OpenCVForUnity.Features2dModule.KAZE, OpenCVForUnity.Features2dModule.MSER, OpenCVForUnity.Features2dModule.ORB, OpenCVForUnity.Features2dModule.SIFT, OpenCVForUnity.Features2dModule.SimpleBlobDetector, OpenCVForUnity.Xfeatures2dModule.FREAK, OpenCVForUnity.Xfeatures2dModule.HarrisLaplaceFeatureDetector, OpenCVForUnity.Xfeatures2dModule.LATCH, OpenCVForUnity.Xfeatures2dModule.LUCID, OpenCVForUnity.Xfeatures2dModule.MSDDetector, OpenCVForUnity.Xfeatures2dModule.StarDetector, OpenCVForUnity.Xfeatures2dModule.TEBLID, and OpenCVForUnity.Xfeatures2dModule.VGG.

read()

void OpenCVForUnity.Features2dModule.Feature2D.read

(

string

fileName

)

write()

void OpenCVForUnity.Features2dModule.Feature2D.write

(

string

fileName

)

---

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

• OpenCVForUnity/Assets/OpenCVForUnity/org/opencv/features2d/Feature2D.cs