3DiVi Face SDK
3.24.1
|
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... | |
def face_sdk.modules.recognizer.Recognizer.choose_representative_templates_set | ( | self, | |
set_size | |||
) |
Choose templates set that best represent original templates.
[in] | set_size | Required set size. |
[in] | templates | Original templates. |
[in] | inviolable_templates_indexes | Indexes of templates, required to be included in 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.
[in] | templates | Vector of templates for creating an index. |
[in] | search_threads_count | Count of threads that will be used while searching in this index. |
[in] | reserve_queries_count | Integer passed to TemplatesIndex.reserve_search_memory, which is called with the created index. |
def face_sdk.modules.recognizer.Recognizer.get_method_name | ( | self, | |
str | |||
) |
Get a method name.
Thread-safe.
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.
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.
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.
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.
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.
[in] | binary_stream | Input stream object. The file stream (std::ifstream) must be opened with the std::ios_base::binary flag. |
def face_sdk.modules.recognizer.Recognizer.processing | ( | self, | |
sample | |||
) |
Create a template.
[in] | sample | Face sample. At the moment, all methods can only be used with frontal samples. |
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.
[in] | query_template | The Template query. |
[in] | templates_index | TemplatesIndex for search. |
[in] | k | Count of the nearest templates for search. |
[in] | acceleration | Acceleration type. |
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.
[in] | template1 | Template created by the same method. |
[in] | template2 | Template created by the same method. |