Face SDK  1.7 Mozart rc
Face Recognition Software Development Kit
Public Member Functions | List of all members
face_sdk::fir_matcher Class Referenceabstract

The FIRs matcher. FIRs matcher compares FIRs to each other. It allows to perform 1:1 and 1:N matching. More...

#include <fir_matcher.h>

Public Member Functions

virtual float match (const std::shared_ptr< face_sdk::fir > &fir_l, const std::shared_ptr< face_sdk::fir > &fir_r)=0
 Performs 1:1 matching operations for specified FIRs. More...
 
virtual float match (const std::shared_ptr< face_sdk::fir_list > &fir_list, uint32_t idx, const std::shared_ptr< face_sdk::fir > &fir)=0
 Performs 1:1 matching operations for specified FIRs. {#matcher_1_1_with_idx}. More...
 
virtual uint32_t builder_version () const noexcept=0
 Builder algorithm version which was selected for FIRs matcher initialization.
 
virtual std::string far_table_code () const noexcept=0
 Returns FAR table code which was selected for FIRs matcher initialization. See Matching table codes.
 
virtual std::vector< float > match (const std::shared_ptr< face_sdk::fir > &fir, const std::shared_ptr< face_sdk::fir_list > &fir_list)=0
 Performs 1:N matching operations for specified FIRs. More...
 
virtual matches best_matches (const std::shared_ptr< face_sdk::fir > &fir, const std::shared_ptr< face_sdk::fir_list > &fir_list, float threshold, uint32_t max_matches)=0
 Performs 1:N matching operations for specified FIRs and returns top matches results. More...
 
virtual matches best_matches (const std::vector< std::shared_ptr< face_sdk::fir > > &firs, const std::shared_ptr< face_sdk::fir_list > &fir_list, float threshold, uint32_t max_matches)=0
 Performs 1:N, 2:N, 3:N and 4:N matching operations for specified FIRs and returns top matches results. Only matcher 104 supports this method. More...
 

Detailed Description

The FIRs matcher. FIRs matcher compares FIRs to each other. It allows to perform 1:1 and 1:N matching.

Use make_fir_matcher() functions for instantiating of face_sdk::fir_matcher object.

Member Function Documentation

◆ best_matches() [1/2]

virtual matches face_sdk::fir_matcher::best_matches ( const std::shared_ptr< face_sdk::fir > &  fir,
const std::shared_ptr< face_sdk::fir_list > &  fir_list,
float  threshold,
uint32_t  max_matches 
)
pure virtual

Performs 1:N matching operations for specified FIRs and returns top matches results.

Parameters
max_matchesNumber of best matches results returned by this function.
Exceptions
face_sdk::exceptionSee Exceptions handling.

◆ best_matches() [2/2]

virtual matches face_sdk::fir_matcher::best_matches ( const std::vector< std::shared_ptr< face_sdk::fir > > &  firs,
const std::shared_ptr< face_sdk::fir_list > &  fir_list,
float  threshold,
uint32_t  max_matches 
)
pure virtual

Performs 1:N, 2:N, 3:N and 4:N matching operations for specified FIRs and returns top matches results. Only matcher 104 supports this method.

Parameters
max_matchesNumber of best matches results returned by this function.
Exceptions
face_sdk::exceptionSee Exceptions handling.

◆ match() [1/3]

virtual std::vector<float> face_sdk::fir_matcher::match ( const std::shared_ptr< face_sdk::fir > &  fir,
const std::shared_ptr< face_sdk::fir_list > &  fir_list 
)
pure virtual

Performs 1:N matching operations for specified FIRs.

Returns
Vector of -log(FAR). Each element of the vector is the -log(FAR) value for each FIR comparison. See How to interpet matching results.
Exceptions
face_sdk::exceptionSee Exceptions handling.

◆ match() [2/3]

virtual float face_sdk::fir_matcher::match ( const std::shared_ptr< face_sdk::fir > &  fir_l,
const std::shared_ptr< face_sdk::fir > &  fir_r 
)
pure virtual

Performs 1:1 matching operations for specified FIRs.

Returns
-log(FAR). See How to interpet matching results.
Exceptions
face_sdk::exceptionSee Exceptions handling.

◆ match() [3/3]

virtual float face_sdk::fir_matcher::match ( const std::shared_ptr< face_sdk::fir_list > &  fir_list,
uint32_t  idx,
const std::shared_ptr< face_sdk::fir > &  fir 
)
pure virtual

Performs 1:1 matching operations for specified FIRs. {#matcher_1_1_with_idx}.

Returns
-log(FAR) value for fir_list[idx] and fir. See How to interpet matching results.
Exceptions
face_sdk::exceptionSee Exceptions handling.

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