Brute Force Matcher

Runs a brute force matcher algorithm on descriptors. More...

Functions
VPIStatus	vpiSubmitBruteForceMatcher (VPIStream stream, uint64_t backend, VPIArray queryDescriptor, VPIArray referenceDescriptor, VPINormType normType, int32_t maxMatchesPerQuery, VPIArray matches, uint32_t algoFlag)
	Runs a brute force matcher algorithm on descriptors. More...

Detailed Description

Runs a brute force matcher algorithm on descriptors.

Brute force matcher uses query descriptors and reference descriptors provided by the user and calculates matches for every query descriptor by determining the closest reference descriptors. The distance calculation metric can be chosen by the user and also the number of matches to be returned per query descriptor.

Function Documentation

vpiSubmitBruteForceMatcher()

VPIStatus vpiSubmitBruteForceMatcher	(	VPIStream	stream,
		uint64_t	backend,
		VPIArray	queryDescriptor,
		VPIArray	referenceDescriptor,
		VPINormType	normType,
		int32_t	maxMatchesPerQuery,
		VPIArray	matches,
		uint32_t	algoFlag
	)

#include <vpi/algo/BruteForceMatcher.h>

Runs a brute force matcher algorithm on descriptors.

Parameters

[in]	stream	A stream handle where the operation will be queued into.
[in]	backend	Backend that will execute the algorithm. Valid values: VPI_BACKEND_CPU VPI_BACKEND_CUDA
[in]	queryDescriptor	Query descriptor array. Must be of type VPI_ARRAY_TYPE_BRIEF_DESCRIPTOR Must not be NULL.
[in]	referenceDescriptor	Input Descriptor array to be used as refernce for matches. Must be of type VPI_ARRAY_TYPE_BRIEF_DESCRIPTOR Must not be NULL.
[in]	normType	Determines the type of norm calculation. Must be VPI_NORM_HAMMING.
[in]	maxMatchesPerQuery	Maximum number of closest matches per query to be added in the output array. Must be >= 1 and <= VPI_MAX_MATCHES_PER_DESCRIPTOR. If VPI_ENABLE_CROSS_CHECK is passed as flags, maxMatchesPerQuery must be 1.
[out]	matches	Output array. Must be of type VPI_ARRAY_TYPE_MATCHES Must not be NULL.
[in]	algoFlag	Matches calculation flags. The accepted flags are: VPI_ENABLE_CROSS_CHECK to enable cross check.

Return values

VPI_ERROR_INVALID_ARGUMENT	stream is NULL.
VPI_ERROR_INVALID_ARGUMENT	queryDescriptor , referenceDescriptor or matches are NULL.
VPI_ERROR_INVALID_ARGUMENT	matches capacity >= queryDescriptor capacity.
VPI_ERROR_INVALID_ARGUMENT	algoFlag not supported.
VPI_ERROR_INVALID_ARGUMENT	backend is invalid or unknown.
VPI_ERROR_INVALID_ARGUMENT	queryDescriptor and referenceDescriptor formats aren't supported.
VPI_ERROR_INVALID_ARGUMENT	normType is not supported.
VPI_ERROR_INVALID_ARGUMENT	matches formats is not supported.
VPI_ERROR_INVALID_ARGUMENT	maxMatchesPerQuery outside valid range.
VPI_ERROR_NOT_IMPLEMENTED	Brute Force Matcher algorithm is not supported by given backend.
VPI_ERROR_INVALID_OPERATION	Backend hardware not available.
VPI_ERROR_INVALID_OPERATION	The needed backends aren't enabled in stream, queryDescriptor, referenceDescriptor or matches.
VPI_SUCCESS	Operation executed successfully.