用于匹配关键点描述符的抽象基类。更多...

#include <opencv2/features2d.hpp>

cv::DescriptorMatcher 的协作图

类
类	DescriptorCollection

公开类型
enum	MatcherType { FLANNBASED = 1 , BRUTEFORCE = 2 , BRUTEFORCE_L1 = 3 , BRUTEFORCE_HAMMING = 4 , BRUTEFORCE_HAMMINGLUT = 5 , BRUTEFORCE_SL2 = 6 }

公开成员函数
virtual	~DescriptorMatcher ()

virtual void	add (InputArrayOfArrays descriptors)
	将描述符添加到训练用的 CPU(trainDescCollectionis) 或 GPU(utrainDescCollectionis) 描述符集合中。

virtual void	clear () CV_OVERRIDE
	清除训练描述符集合。

virtual CV_NODISCARD_STD Ptr< DescriptorMatcher >	clone (bool emptyTrainData=false) const =0
	克隆匹配器。

virtual bool	empty () const CV_OVERRIDE
	如果 CPU 和 GPU 描述符集合中都没有训练描述符，则返回 true。

const std::vector< Mat > &	getTrainDescriptors () const
	返回训练描述符集合 trainDescCollection 的常量引用。

virtual bool	isMaskSupported () const =0
	如果描述符匹配器支持遮罩允许匹配，则返回 true。

void	knnMatch (InputArray queryDescriptors, InputArray trainDescriptors, std::vector< std::vector< DMatch > > &matches, int k, InputArray mask=noArray(), bool compactResult=false) const
	为查询集中的每个描述符查找 k 个最佳匹配项。

void	knnMatch (InputArray queryDescriptors, std::vector< std::vector< DMatch > > &matches, int k, InputArrayOfArrays masks=noArray(), bool compactResult=false)

void	match (InputArray queryDescriptors, InputArray trainDescriptors, std::vector< DMatch > &matches, InputArray mask=noArray()) const
	为查询集中的每个描述符查找最佳匹配项。

void	match (InputArray queryDescriptors, std::vector< DMatch > &matches, InputArrayOfArrays masks=noArray())

void	radiusMatch (InputArray queryDescriptors, InputArray trainDescriptors, std::vector< std::vector< DMatch > > &matches, float maxDistance, InputArray mask=noArray(), bool compactResult=false) const
	对于每个查询描述符，查找距离不超过指定距离的训练描述符。

void	radiusMatch (InputArray queryDescriptors, std::vector< std::vector< DMatch > > &matches, float maxDistance, InputArrayOfArrays masks=noArray(), bool compactResult=false)

virtual void	read (const FileNode &) CV_OVERRIDE
	从文件存储中读取算法参数。

void	read (const String &fileName)

virtual void	训练 ()
	训练描述符匹配器。

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

void	write (const String &fileName) const

virtual void	write (FileStorage &) const CV_OVERRIDE
	将算法参数存储在文件存储中。

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

从 cv::Algorithm 继承的公共成员函数
	Algorithm ()

virtual	~Algorithm ()

virtual String	getDefaultName () const

virtual void	save (const String &filename) const

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

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

静态公开成员函数
static Ptr< DescriptorMatcher >	create (const DescriptorMatcher::MatcherType &matcherType)

static Ptr< DescriptorMatcher >	create (const String &descriptorMatcherType)
	使用默认参数（使用默认构造函数）创建一个指定类型的描述符匹配器。

从 cv::Algorithm 继承的静态公共成员函数
template<typename _Tp >
static Ptr< _Tp >	load (const String &filename, const String &objname=String())
	从文件中加载算法。

template<typename _Tp >
static Ptr< _Tp >	loadFromString (const String &strModel, const String &objname=String())
	从字符串中加载算法。

template<typename _Tp >
static Ptr< _Tp >	read (const FileNode &fn)
	从文件节点中读取算法。

保护成员函数
void	checkMasks (InputArrayOfArrays masks, int queryDescriptorsCount) const

virtual void	knnMatchImpl (InputArray queryDescriptors, std::vector< std::vector< DMatch > > &matches, int k, InputArrayOfArrays masks=noArray(), bool compactResult=false)=0

virtual void	radiusMatchImpl (InputArray queryDescriptors, std::vector< std::vector< DMatch > > &matches, float maxDistance, InputArrayOfArrays masks=noArray(), bool compactResult=false)=0

从 cv::Algorithm 继承的保护成员函数
void	writeFormat (FileStorage &fs) const

保护静态成员函数
static CV_NODISCARD_STD Mat	clone_op (Mat m)

static bool	isMaskedOut (InputArrayOfArrays masks, int queryIdx)

static bool	isPossibleMatch (InputArray mask, int queryIdx, int trainIdx)

保护属性
std::vector< Mat >	trainDescCollection
	训练图像的描述符集合。

std::vector< Mat >	utrainDescCollection

详细说明

匹配关键点描述符的抽象基类。

它有两个匹配方法组：用于将图像的描述符与另一图像或图像集进行匹配。

成员枚举文档

◆ MatcherType

enum cv::DescriptorMatcher::MatcherType

枚举值 (Enumerator)
FLANNBASED
BRUTEFORCE
BRUTEFORCE_L1
BRUTEFORCE_HAMMING
BRUTEFORCE_HAMMING LUT
BRUTEFORCE_SL2

构造函数与析构函数说明

◆ ~DescriptorMatcher()

virtual cv::DescriptorMatcher::~DescriptorMatcher ( )

virtual

成员函数说明

◆ add()

virtual void cv::DescriptorMatcher::add ( InputArrayOfArrays descriptors )

virtual

Python
	cv.DescriptorMatcher.add(	descriptors	) ->	None

将描述符添加到训练用的 CPU(trainDescCollectionis) 或 GPU(utrainDescCollectionis) 描述符集合中。

如果集合不为空，则新描述符将添加到现有训练描述符中。

参数

descriptors 要添加的描述符。每个 descriptors[i] 都是来自同一训练图像的一组描述符。

在 cv::FlannBasedMatcher 中重新实现。

◆ checkMasks()

void cv::DescriptorMatcher::checkMasks	(	InputArrayOfArrays	masks,
		int	queryDescriptorsCount ) const

保护

◆ clear()

virtual void cv::DescriptorMatcher::clear ( )

virtual

Python
	cv.DescriptorMatcher.clear(		) ->	None

清除训练描述符集合。

从 cv::Algorithm 重新实现。

在 cv::FlannBasedMatcher 中重新实现。

◆ clone()

virtual CV_NODISCARD_STD Ptr< DescriptorMatcher > cv::DescriptorMatcher::clone ( bool emptyTrainData = false ) const

纯虚函数

Python
	cv.DescriptorMatcher.clone(	[, emptyTrainData]	) ->	retval

克隆匹配器。

参数

emptyTrainData 如果 emptyTrainData 为 false，则方法创建一个对象的深拷贝，即同时复制参数和训练数据。如果 emptyTrainData 为 true，则方法创建一个具有当前参数但训练数据为空的对象副本。

在 cv::BFMatcher 和 cv::FlannBasedMatcher 中实现。

◆ clone_op()

static CV_NODISCARD_STD Mat cv::DescriptorMatcher::clone_op ( Mat m )

inlinestaticprotected

此函数的调用图

◆ create() [1/2]

static Ptr< DescriptorMatcher > cv::DescriptorMatcher::create ( const DescriptorMatcher::MatcherType & matcherType )

static (静态)


cv.DescriptorMatcher.create(	descriptorMatcherType	) ->	retval
cv.DescriptorMatcher.create(	matcherType	) ->	retval
cv.DescriptorMatcher_create(	descriptorMatcherType	) ->	retval
cv.DescriptorMatcher_create(	matcherType	) ->	retval

◆ create() [2/2]

static Ptr< DescriptorMatcher > cv::DescriptorMatcher::create ( const String & descriptorMatcherType )

static (静态)


cv.DescriptorMatcher.create(	descriptorMatcherType	) ->	retval
cv.DescriptorMatcher.create(	matcherType	) ->	retval
cv.DescriptorMatcher_create(	descriptorMatcherType	) ->	retval
cv.DescriptorMatcher_create(	matcherType	) ->	retval

使用默认参数（使用默认构造函数）创建一个指定类型的描述符匹配器。

参数

descriptorMatcherType

支持的描述符匹配器类型。当前支持以下匹配器类型：

BruteForce (使用 L2 距离)
BruteForce-L1
BruteForce-Hamming
BruteForce-Hamming(2)
FlannBased

◆ empty()

virtual bool cv::DescriptorMatcher::empty ( ) const

virtual

Python
	cv.DescriptorMatcher.empty(		) ->	retval

如果 CPU 和 GPU 描述符集合中都没有训练描述符，则返回 true。

从 cv::Algorithm 重新实现。

◆ getTrainDescriptors()

const std::vector< Mat > & cv::DescriptorMatcher::getTrainDescriptors ( ) const

Python
	cv.DescriptorMatcher.getTrainDescriptors(		) ->	retval

返回训练描述符集合 trainDescCollection 的常量引用。

◆ isMaskedOut()

static bool cv::DescriptorMatcher::isMaskedOut	(	InputArrayOfArrays	masks,
		int	queryIdx )

staticprotected

◆ isMaskSupported()

virtual bool cv::DescriptorMatcher::isMaskSupported ( ) const

纯虚函数

Python
	cv.DescriptorMatcher.isMaskSupported(		) ->	retval

如果描述符匹配器支持遮罩允许匹配，则返回 true。

在 cv::BFMatcher 和 cv::FlannBasedMatcher 中实现。

◆ isPossibleMatch()

static bool cv::DescriptorMatcher::isPossibleMatch	(	InputArray	mask,
		int	queryIdx,
		int	trainIdx )

staticprotected

◆ knnMatch() [1/2]

void cv::DescriptorMatcher::knnMatch	(	InputArray	queryDescriptors,
		InputArray	trainDescriptors,
		std::vector< std::vector< DMatch > > &	matches,
		int	k,
		InputArray	mask = noArray(),
		bool	compactResult = false ) const

Python
	cv.DescriptorMatcher.knnMatch(	queryDescriptors, trainDescriptors, k[, mask[, compactResult]]	) ->	matches
	cv.DescriptorMatcher.knnMatch(	queryDescriptors, k[, masks[, compactResult]]	) ->	matches

为查询集中的每个描述符查找 k 个最佳匹配项。

参数

queryDescriptors	查询描述符集。
trainDescriptors	训练描述符集。此集合不会添加到类对象中存储的训练描述符集合。
mask	用于指定查询和训练矩阵之间允许匹配的掩码。
matches	匹配项。每个 matches[i] 是针对相同查询描述符的 k 个或更少匹配项。
k	每个查询描述符找到的最佳匹配项数量，或如果查询描述符的总可能匹配项少于 k 个，则为该数量。
compactResult	当掩码（或掩码集）不为空时使用的参数。如果 compactResult 为 false，则 matches 向量的大小与 queryDescriptors 的行数相同。如果 compactResult 为 true，则 matches 向量不包含完全被掩码掉的查询描述符的匹配项。

这些 DescriptorMatcher::match 方法的扩展变体会为每个查询描述符查找几个最佳匹配项。匹配项按距离递增的顺序返回。有关查询和训练描述符的详细信息，请参阅 DescriptorMatcher::match。

◆ knnMatch() [2/2]

void cv::DescriptorMatcher::knnMatch	(	InputArray	queryDescriptors,
		std::vector< std::vector< DMatch > > &	matches,
		int	k,
		InputArrayOfArrays	masks = noArray(),
		bool	compactResult = false )

Python
	cv.DescriptorMatcher.knnMatch(	queryDescriptors, trainDescriptors, k[, mask[, compactResult]]	) ->	matches
	cv.DescriptorMatcher.knnMatch(	queryDescriptors, k[, masks[, compactResult]]	) ->	matches

这是一个重载的成员函数，为方便起见而提供。它与上述函数的区别仅在于所接受的参数不同。

参数

queryDescriptors	查询描述符集。
matches	匹配项。每个 matches[i] 是针对相同查询描述符的 k 个或更少匹配项。
k	每个查询描述符找到的最佳匹配项数量，或如果查询描述符的总可能匹配项少于 k 个，则为该数量。
masks	掩码集。每个 masks[i] 指定查询描述符与来自第 i 个图像 trainDescCollection[i] 的存储训练描述符之间的允许匹配。
compactResult	当掩码（或掩码集）不为空时使用的参数。如果 compactResult 为 false，则 matches 向量的大小与 queryDescriptors 的行数相同。如果 compactResult 为 true，则 matches 向量不包含完全被掩码掉的查询描述符的匹配项。

◆ knnMatchImpl()

virtual void cv::DescriptorMatcher::knnMatchImpl	(	InputArray	queryDescriptors,
		std::vector< std::vector< DMatch > > &	matches,
		int	k,
		InputArrayOfArrays	masks = noArray(),
		bool	compactResult = false )

protectedpure virtual

实际上，匹配仅由以下两个方法实现。这些方法假定类对象已经过训练。公共匹配方法调用这些方法，在调用 train() 之后。

在 cv::BFMatcher 和 cv::FlannBasedMatcher 中实现。

此函数的调用图

◆ match() [1/2]

void cv::DescriptorMatcher::match	(	InputArray	queryDescriptors,
		InputArray	trainDescriptors,
		std::vector< DMatch > &	matches,
		InputArray	mask = noArray() ) const

Python
	cv.DescriptorMatcher.match(	queryDescriptors, trainDescriptors[, mask]	) ->	matches
	cv.DescriptorMatcher.match(	queryDescriptors[, masks]	) ->	matches

为查询集中的每个描述符查找最佳匹配项。

参数

queryDescriptors	查询描述符集。
trainDescriptors	训练描述符集。此集合不会添加到类对象中存储的训练描述符集合。
matches	匹配项。如果查询描述符在 mask 中被掩码掉，则该描述符将不添加匹配项。因此，matches 的大小可能小于查询描述符的数量。
mask	用于指定查询和训练矩阵之间允许匹配的掩码。

在此方法的第一个变体中，训练描述符作为输入参数传递。在此方法的第二个变体中，使用 DescriptorMatcher::add 设置的训练描述符集合。可以传递可选的掩码（或掩码集）来指定哪些查询和训练描述符可以匹配。即，仅当 mask.at<uchar>(i,j) 非零时，queryDescriptors[i] 才能与 trainDescriptors[j] 匹配。

◆ match() [2/2]

void cv::DescriptorMatcher::match	(	InputArray	queryDescriptors,
		std::vector< DMatch > &	matches,
		InputArrayOfArrays	masks = noArray() )

Python
	cv.DescriptorMatcher.match(	queryDescriptors, trainDescriptors[, mask]	) ->	matches
	cv.DescriptorMatcher.match(	queryDescriptors[, masks]	) ->	matches

这是一个重载的成员函数，为方便起见而提供。它与上述函数的区别仅在于所接受的参数不同。

参数

queryDescriptors	查询描述符集。
matches	匹配项。如果查询描述符在 mask 中被掩码掉，则该描述符将不添加匹配项。因此，matches 的大小可能小于查询描述符的数量。
masks	掩码集。每个 masks[i] 指定查询描述符与来自第 i 个图像 trainDescCollection[i] 的存储训练描述符之间的允许匹配。

◆ radiusMatch() [1/2]

void cv::DescriptorMatcher::radiusMatch	(	InputArray	queryDescriptors,
		InputArray	trainDescriptors,
		std::vector< std::vector< DMatch > > &	matches,
		float	maxDistance,
		InputArray	mask = noArray(),
		bool	compactResult = false ) const

Python
	cv.DescriptorMatcher.radiusMatch(	queryDescriptors, trainDescriptors, maxDistance[, mask[, compactResult]]	) ->	matches
	cv.DescriptorMatcher.radiusMatch(	queryDescriptors, maxDistance[, masks[, compactResult]]	) ->	matches

对于每个查询描述符，查找距离不超过指定距离的训练描述符。

参数

queryDescriptors	查询描述符集。
trainDescriptors	训练描述符集。此集合不会添加到类对象中存储的训练描述符集合。
matches	找到的匹配项。
compactResult	当掩码（或掩码集）不为空时使用的参数。如果 compactResult 为 false，则 matches 向量的大小与 queryDescriptors 的行数相同。如果 compactResult 为 true，则 matches 向量不包含完全被掩码掉的查询描述符的匹配项。
maxDistance	匹配描述符之间的距离阈值。这里的距离是指度量距离（例如，汉明距离），而不是坐标之间的距离（以像素为单位测量）！
mask	用于指定查询和训练矩阵之间允许匹配的掩码。

对于每个查询描述符，这些方法查找距离查询描述符和训练描述符小于或等于 maxDistance 的训练描述符。找到的匹配项按距离递增的顺序返回。

◆ radiusMatch() [2/2]

void cv::DescriptorMatcher::radiusMatch	(	InputArray	queryDescriptors,
		std::vector< std::vector< DMatch > > &	matches,
		float	maxDistance,
		InputArrayOfArrays	masks = noArray(),
		bool	compactResult = false )

Python
	cv.DescriptorMatcher.radiusMatch(	queryDescriptors, trainDescriptors, maxDistance[, mask[, compactResult]]	) ->	matches
	cv.DescriptorMatcher.radiusMatch(	queryDescriptors, maxDistance[, masks[, compactResult]]	) ->	matches

这是一个重载的成员函数，为方便起见而提供。它与上述函数的区别仅在于所接受的参数不同。

参数

queryDescriptors	查询描述符集。
matches	找到的匹配项。
maxDistance	匹配描述符之间的距离阈值。这里的距离是指度量距离（例如，汉明距离），而不是坐标之间的距离（以像素为单位测量）！
masks	掩码集。每个 masks[i] 指定查询描述符与来自第 i 个图像 trainDescCollection[i] 的存储训练描述符之间的允许匹配。
compactResult	当掩码（或掩码集）不为空时使用的参数。如果 compactResult 为 false，则 matches 向量的大小与 queryDescriptors 的行数相同。如果 compactResult 为 true，则 matches 向量不包含完全被掩码掉的查询描述符的匹配项。

◆ radiusMatchImpl()

virtual void cv::DescriptorMatcher::radiusMatchImpl	(	InputArray	queryDescriptors,
		std::vector< std::vector< DMatch > > &	matches,
		float	maxDistance,
		InputArrayOfArrays	masks = noArray(),
		bool	compactResult = false )

protectedpure virtual

在 cv::BFMatcher 和 cv::FlannBasedMatcher 中实现。

此函数的调用图

◆ read() [1/2]

virtual void cv::DescriptorMatcher::read ( const FileNode & fn )

virtual

Python
	cv.DescriptorMatcher.read(	fileName	) ->	None
	cv.DescriptorMatcher.read(	arg1	) ->	None

从文件存储中读取算法参数。

从 cv::Algorithm 中重新实现。

在 cv::FlannBasedMatcher 中重新实现。

◆ read() [2/2]

void cv::DescriptorMatcher::read ( const String & fileName )

内联

Python
	cv.DescriptorMatcher.read(	fileName	) ->	None
	cv.DescriptorMatcher.read(	arg1	) ->	None

此函数的调用图

◆ train()

virtual void cv::DescriptorMatcher::train ( )

virtual

Python
	cv.DescriptorMatcher.train(		) ->	None

训练描述符匹配器。

训练描述符匹配器（例如，flann 索引）。在所有匹配方法中，都会在每次匹配之前运行 train() 方法。一些描述符匹配器（例如，BruteForceMatcher）对此方法的实现为空。其他匹配器会真正训练其内部结构（例如，FlannBasedMatcher 会训练 flann::Index）。

在 cv::FlannBasedMatcher 中重新实现。

◆ write() [1/4]

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

内联

Python
	cv.DescriptorMatcher.write(	fileName	) ->	None
	cv.DescriptorMatcher.write(	fs, name	) ->	None

◆ write() [2/4]

void cv::DescriptorMatcher::write ( const String & fileName ) const

内联

Python
	cv.DescriptorMatcher.write(	fileName	) ->	None
	cv.DescriptorMatcher.write(	fs, name	) ->	None

此函数的调用图

◆ write() [3/4]

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

virtual

Python
	cv.DescriptorMatcher.write(	fileName	) ->	None
	cv.DescriptorMatcher.write(	fs, name	) ->	None

将算法参数存储在文件存储中。

从 cv::Algorithm 中重新实现。

在 cv::FlannBasedMatcher 中重新实现。

◆ write() [4/4]

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

内联

Python
	cv.DescriptorMatcher.write(	fileName	) ->	None
	cv.DescriptorMatcher.write(	fs, name	) ->	None

成员数据文档

◆ trainDescCollection

std::vector<Mat> cv::DescriptorMatcher::trainDescCollection

保护

训练图像的描述符集合。

◆ utrainDescCollection

std::vector<UMat> cv::DescriptorMatcher::utrainDescCollection

保护

该类的文档由以下文件生成：

opencv2/features2d.hpp

类

公开类型

公开成员函数

静态公开成员函数

保护成员函数

保护静态成员函数

保护属性

详细说明

成员枚举文档

◆ MatcherType

构造函数与析构函数说明

◆ ~DescriptorMatcher()

成员函数说明

◆ add()

◆ checkMasks()

◆ clear()

◆ clone()

◆ clone_op()

◆ create() [1/2]

◆ create() [2/2]

◆ empty()

◆ getTrainDescriptors()

◆ isMaskedOut()

◆ isMaskSupported()

◆ isPossibleMatch()

◆ knnMatch() [1/2]

◆ knnMatch() [2/2]

◆ knnMatchImpl()

◆ match() [1/2]

◆ match() [2/2]

◆ radiusMatch() [1/2]

◆ radiusMatch() [2/2]

◆ radiusMatchImpl()

◆ read() [1/2]

◆ read() [2/2]

◆ train()

◆ write() [1/4]

◆ write() [2/4]

◆ write() [3/4]

◆ write() [4/4]

成员数据文档

◆ trainDescCollection

◆ utrainDescCollection