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

#include <features2d.hpp>

Inheritance diagram for cv::Feature2D:

Public Member Functions
virtual	~Feature2D ()

virtual CV_WRAP void	detect (InputArray image, CV_OUT std::vector< KeyPoint > &keypoints, InputArray mask=noArray())
	Detects keypoints in an image (first variant) or image set (second variant). More...

virtual CV_WRAP void	detect (InputArrayOfArrays images, CV_OUT std::vector< std::vector< KeyPoint > > &keypoints, InputArrayOfArrays masks=noArray())

virtual CV_WRAP void	compute (InputArray image, CV_OUT CV_IN_OUT std::vector< KeyPoint > &keypoints, OutputArray descriptors)
	Computes the descriptors for a set of keypoints detected in an image (first variant) or image set (second variant). More...

virtual CV_WRAP void	compute (InputArrayOfArrays images, CV_OUT CV_IN_OUT std::vector< std::vector< KeyPoint > > &keypoints, OutputArrayOfArrays descriptors)

virtual CV_WRAP void	detectAndCompute (InputArray image, InputArray mask, CV_OUT std::vector< KeyPoint > &keypoints, OutputArray descriptors, bool useProvidedKeypoints=false)

virtual CV_WRAP int	descriptorSize () const

virtual CV_WRAP int	descriptorType () const

virtual CV_WRAP int	defaultNorm () const

CV_WRAP void	write (const String &fileName) const

CV_WRAP void	read (const String &fileName)

virtual void	write (FileStorage &) const CV_OVERRIDE
	Stores algorithm parameters in a file storage. More...

virtual CV_WRAP void	read (const FileNode &) CV_OVERRIDE
	Reads algorithm parameters from a file storage. More...

virtual CV_WRAP bool	empty () const CV_OVERRIDE
	Return true if detector object is empty. More...

virtual CV_WRAP String	getDefaultName () const CV_OVERRIDE

CV_WRAP void	write (FileStorage &fs, const String &name) const

void	write (const Ptr< FileStorage > &fs, const String &name) const

Public Member Functions inherited from cv::Algorithm
	Algorithm ()

virtual	~Algorithm ()

virtual CV_WRAP void	clear ()
	Clears the algorithm state. More...

CV_WRAP void	write (FileStorage &fs, const String &name) const

void	write (const Ptr< FileStorage > &fs, const String &name=String()) const

virtual CV_WRAP void	save (const String &filename) const

Additional Inherited Members
Static Public Member Functions inherited from cv::Algorithm
template<typename _Tp >
static Ptr< _Tp >	read (const FileNode &fn)
	Reads algorithm from the file node. More...

template<typename _Tp >
static Ptr< _Tp >	load (const String &filename, const String &objname=String())
	Loads algorithm from the file. More...

template<typename _Tp >
static Ptr< _Tp >	loadFromString (const String &strModel, const String &objname=String())
	Loads algorithm from a String. More...

Protected Member Functions inherited from cv::Algorithm
void	writeFormat (FileStorage &fs) const

Detailed Description

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

Constructor & Destructor Documentation

◆ ~Feature2D()

virtual cv::Feature2D::~Feature2D ( )

virtual

Member Function Documentation

◆ compute() [1/2]

virtual CV_WRAP void cv::Feature2D::compute	(	InputArray	image,
		CV_OUT CV_IN_OUT std::vector< KeyPoint > &	keypoints,
		OutputArray	descriptors
	)

virtual

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.

◆ compute() [2/2]

virtual CV_WRAP void cv::Feature2D::compute	(	InputArrayOfArrays	images,
		CV_OUT CV_IN_OUT std::vector< std::vector< KeyPoint > > &	keypoints,
		OutputArrayOfArrays	descriptors
	)

virtual

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.

◆ defaultNorm()

virtual CV_WRAP int cv::Feature2D::defaultNorm ( ) const

virtual

◆ descriptorSize()

virtual CV_WRAP int cv::Feature2D::descriptorSize ( ) const

virtual

◆ descriptorType()

virtual CV_WRAP int cv::Feature2D::descriptorType ( ) const

virtual

◆ detect() [1/2]

virtual CV_WRAP void cv::Feature2D::detect	(	InputArray	image,
		CV_OUT std::vector< KeyPoint > &	keypoints,
		InputArray	mask = `noArray()`
	)

virtual

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() [2/2]

virtual CV_WRAP void cv::Feature2D::detect	(	InputArrayOfArrays	images,
		CV_OUT std::vector< std::vector< KeyPoint > > &	keypoints,
		InputArrayOfArrays	masks = `noArray()`
	)

virtual

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].

◆ detectAndCompute()

virtual CV_WRAP void cv::Feature2D::detectAndCompute	(	InputArray	image,
		InputArray	mask,
		CV_OUT std::vector< KeyPoint > &	keypoints,
		OutputArray	descriptors,
		bool	useProvidedKeypoints = `false`
	)

virtual

Detects keypoints and computes the descriptors

◆ empty()

virtual CV_WRAP bool cv::Feature2D::empty ( ) const

virtual

Return true if detector object is empty.

Reimplemented from cv::Algorithm.

◆ getDefaultName()

virtual CV_WRAP String cv::Feature2D::getDefaultName ( ) const

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 cv::Algorithm.

Reimplemented in cv::AKAZE, cv::KAZE, cv::SimpleBlobDetector, cv::GFTTDetector, cv::AgastFeatureDetector, cv::FastFeatureDetector, cv::MSER, cv::ORB, cv::BRISK, cv::SIFT, and cv::AffineFeature.

◆ read() [1/2]

virtual CV_WRAP void cv::Feature2D::read ( const FileNode & fn )

virtual

Reads algorithm parameters from a file storage.

Reimplemented from cv::Algorithm.

◆ read() [2/2]

CV_WRAP void cv::Feature2D::read ( const String & fileName )

◆ write() [1/4]

void cv::Feature2D::write	(	const Ptr< FileStorage > &	fs,
		const String &	name
	)		const

inline

◆ write() [2/4]

CV_WRAP void cv::Feature2D::write ( const String & fileName ) const

◆ write() [3/4]

virtual void cv::Feature2D::write ( FileStorage & fs ) const

virtual

Stores algorithm parameters in a file storage.

Reimplemented from cv::Algorithm.

◆ write() [4/4]

CV_WRAP void cv::Feature2D::write	(	FileStorage &	fs,
		const String &	name
	)		const

inline

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

build/release/_deps/opencv-src/include/opencv4/opencv2/features2d.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~Feature2D()

Member Function Documentation

◆ compute() [1/2]

◆ compute() [2/2]

◆ defaultNorm()

◆ descriptorSize()

◆ descriptorType()

◆ detect() [1/2]

◆ detect() [2/2]

◆ detectAndCompute()

◆ empty()

◆ getDefaultName()

◆ read() [1/2]

◆ read() [2/2]

◆ write() [1/4]

◆ write() [2/4]

◆ write() [3/4]

◆ write() [4/4]