3DiVi Face SDK  3.24.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Groups
Recognizer

Classes

class  face_sdk.modules.recognizer.MatchResult
 Interface object for creating and matching templates. More...
 
class  face_sdk.modules.recognizer.SearchResult
 Result of searching the Template query in the TemplatesIndex. More...
 
class  face_sdk.modules.recognizer.SearchAccelerationType
 Types of search acceleration. More...
 
class  face_sdk.modules.recognizer.Recognizer
 Interface object for creating and matching templates. More...
 

Functions

def face_sdk.modules.recognizer.Recognizer.processing
 Create a template. More...
 
def face_sdk.modules.recognizer.Recognizer.verify_match
 Compare two templates. More...
 
def face_sdk.modules.recognizer.Recognizer.create_index
 Create the TemplatesIndex for quick search. More...
 
def face_sdk.modules.recognizer.Recognizer.get_method_name
 Get a method name. More...
 
def face_sdk.modules.recognizer.Recognizer.search
 Search for the k nearest Templates in the TemplatesIndex. More...
 
def face_sdk.modules.recognizer.Recognizer.load_template
 Load the template. More...
 
def face_sdk.modules.recognizer.Recognizer.choose_representative_templates_set
 Choose templates set that best represent original templates. More...
 
def face_sdk.modules.recognizer.Recognizer.get_roc_curve_point_by_distance_threshold
 Get a point on the ROC curve with a given distance threshold. More...
 
def face_sdk.modules.recognizer.Recognizer.get_roc_curve_point_by_far
 Get a point on the ROC curve with a given false acceptance rate (FAR). More...
 
def face_sdk.modules.recognizer.Recognizer.get_roc_curve_point_by_frr
 Get a point on the ROC curve with a given false rejection rate (FRR). More...
 
def face_sdk.modules.recognizer.Recognizer.get_roc_curve_point_by_score_threshold
 Get a point on the ROC curve with a given similarity score threshold. More...
 

Detailed Description

Function Documentation

def face_sdk.modules.recognizer.Recognizer.choose_representative_templates_set (   self,
  set_size 
)

Choose templates set that best represent original templates.

Parameters
[in]set_sizeRequired set size.
[in]templatesOriginal templates.
[in]inviolable_templates_indexesIndexes of templates, required to be included in the result set.
Returns
Indexes of templates that make up the result set.
def face_sdk.modules.recognizer.Recognizer.create_index (   self,
  templates 
)

Create the TemplatesIndex for quick search.

The total size of all indexes is limited by the license.

Parameters
[in]templatesVector of templates for creating an index.
[in]search_threads_countCount of threads that will be used while searching in this index.
[in]reserve_queries_countInteger passed to TemplatesIndex.reserve_search_memory, which is called with the created index.
Returns
Created index.
def face_sdk.modules.recognizer.Recognizer.get_method_name (   self,
  str 
)

Get a method name.

Thread-safe.

Returns
The name of the method.
def face_sdk.modules.recognizer.Recognizer.get_roc_curve_point_by_distance_threshold (   self,
  distance_threshold 
)

Get a point on the ROC curve with a given distance threshold.

Thread-safe.

Returns
Point on the ROC curve in the form of a MatchResult struct.
def face_sdk.modules.recognizer.Recognizer.get_roc_curve_point_by_far (   self,
  desired_far 
)

Get a point on the ROC curve with a given false acceptance rate (FAR).

Thread-safe.

Returns
Point on the ROC curve in the form of a MatchResult struct.
def face_sdk.modules.recognizer.Recognizer.get_roc_curve_point_by_frr (   self,
  desired_frr 
)

Get a point on the ROC curve with a given false rejection rate (FRR).

Thread-safe.

Returns
Point on the ROC curve in the form of a MatchResult struct.
def face_sdk.modules.recognizer.Recognizer.get_roc_curve_point_by_score_threshold (   self,
  score_threshold 
)

Get a point on the ROC curve with a given similarity score threshold.

Thread-safe.

Returns
Point on the ROC curve in the form of a MatchResult struct.
def face_sdk.modules.recognizer.Recognizer.load_template (   self,
  binary_stream 
)

Load the template.

The format is platform-independent. Only the templates that were created with the same method (i.e. with the same ini_file) can be loaded.

Parameters
[in]binary_streamInput stream object. The file stream (std::ifstream) must be opened with the std::ios_base::binary flag.
Returns
Loaded template.
def face_sdk.modules.recognizer.Recognizer.processing (   self,
  sample 
)

Create a template.

Parameters
[in]sampleFace sample. At the moment, all methods can only be used with frontal samples.
Returns
Created template.
def face_sdk.modules.recognizer.Recognizer.search (   self,
  queries_templates 
)

Search for the k nearest Templates in the TemplatesIndex.

The search time depends on k and the size of the TemplatesIndex.

Parameters
[in]query_templateThe Template query.
[in]templates_indexTemplatesIndex for search.
[in]kCount of the nearest templates for search.
[in]accelerationAcceleration type.
Returns
Vector with min(k, templates_index.size()) elements in ascending order of distance to the query_template.
def face_sdk.modules.recognizer.Recognizer.verify_match (   self,
  template1 
)

Compare two templates.

The order of templates does not matter. Only the templates that were created with the same method (i.e. with the same ini_file) can be loaded.

Parameters
[in]template1Template created by the same method.
[in]template2Template created by the same method.
Returns
Result of the matching.