fsdk::IDescriptorMatcher Struct Reference

Descriptor matcher interface. More...

#include <IDescriptor.h>

Inheritance diagram for fsdk::IDescriptorMatcher:

Public Member Functions
virtual ResultValue< FSDKError, MatchingResult >	match (const IDescriptor *first, const IDescriptor *second) noexcept=0
	Match descriptors 1:1. More...
virtual Result< FSDKError >	match (const IDescriptor *reference, const IDescriptorBatch *candidates, MatchingResult *results) noexcept=0
	Match descriptors 1:M. More...
virtual uint32_t	getModelVersion () const noexcept=0
	Get algorithm model version this matcher works with. More...
Public Member Functions inherited from fsdk::IRefCounted
virtual int32_t	retain () noexcept=0
	Increase strong reference count. More...
virtual int32_t	release () noexcept=0
	Decrease strong reference count. More...
virtual int32_t	getRefCount () const noexcept=0
	Get actual strong reference count. More...
virtual int32_t	retainWeak () noexcept=0
	Increase weak reference count. More...
virtual int32_t	releaseWeak () noexcept=0
	Decrease weak reference count. More...
virtual int32_t	getWeakRefCount () const noexcept=0
	Get actual weak reference count. More...

Detailed Description

Descriptor matcher interface.

Matches descriptors 1:1 and 1:M (

See also

IDescriptor and IDescriptorBatch interfaces).

As a result of the matching process the calling site gets a MatchingResult (or several of them in case of 1:M matching). The MatchingResult structure contains distance and similarity metrics.

Distance is measured in abstract units and tends to 0 for similar descriptors and to infinity for different ones. Similarity is the opposite metric and shows probability of two descriptors belonging to the same person; therfore it is normalized to [0..1] range.

See also

MatchingResult for details.

Member Function Documentation

getModelVersion()

virtual uint32_t fsdk::IDescriptorMatcher::getModelVersion ( ) const

pure virtualnoexcept

Get algorithm model version this matcher works with.

Returns

Version as integral number.

match() [1/2]

virtual ResultValue< FSDKError, MatchingResult> fsdk::IDescriptorMatcher::match ( const IDescriptor *  first, const IDescriptor *  second  )

pure virtualnoexcept

Match descriptors 1:1.

Parameters

first	first descriptor.
second	second descriptor.

Returns

ResultValue with error code specified by FSDKError and matching result.

See also

ResulValue and FSDKError.

match() [2/2]

virtual Result<FSDKError> fsdk::IDescriptorMatcher::match ( const IDescriptor *  reference, const IDescriptorBatch *  candidates, MatchingResult *  results  )

pure virtualnoexcept

Match descriptors 1:M.

Matches a reference descriptor to a batch of candidate descriptors. The results are layed out in the same order as the candidate descriptors in the batch.

Parameters

[in]	reference	the reference descriptor.
[in]	candidates	the candidate descriptor batch to match with the reference.
[in]	[out]	results matchig result array.

Note

Length of results must be at least the same as the length of the candidates batch.

See also

IDescriptorBatch::getMaxCount().

Returns

Result with error specified by FSDKError.

See also

Result and FSDKError.

---

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

• fsdk.framework/Headers/IDescriptor.h