File containing API of sfe_iris library as part of SFE Toolkit. More...

#include "sfe_core.h"

Data Structures
struct	SFEIrisTemplate
	Iris template struct. More...

struct	SFEIrisTemplateVersion
	Iris template version struct. More...

Macros
#define	SFE_IRIS_TEMPLATE_SIZE 522
	Iris template size in bytes.

Typedefs
typedef struct SFEIrisTemplate	SFEIrisTemplate
	Iris template struct.

typedef struct SFEIrisTemplateVersion	SFEIrisTemplateVersion
	Iris template version struct.

Functions
SFEError	sfeIrisTemplateExtract (SFESolver solver, SFEImageView image, const SFEDetection detection, SFEIrisTemplate out_iris_template)
	Extract template from source image and given iris detection.

SFEError	sfeIrisTemplateMatch (const SFEIrisTemplate template1, const SFEIrisTemplate template2, float *out_matching_score)
	Match two iris templates.

SFEError	sfeIrisTemplateVersion (const SFEIrisTemplate iris_template, SFEIrisTemplateVersion out_iris_template_version)
	Get iris template version.

SFEError	sfeIrisTemplateQuality (const SFEIrisTemplate iris_template, float out_iris_template_quality)
	Get iris template quality.

SFEError	sfeIrisTemplateIdentify (const SFEIrisTemplate probe_iris_template, const SFEIrisTemplate templates_gallery, size_t gallery_size, float matching_score_threshold, SFETemplateIdentificationCandidate out_candidates, size_t in_out_candidates_count, size_t thread_count)
	Get an ordered array of SFETemplateIdentificationCandidate from probe's template best matches with templates in the gallery.

SFEError	sfeIrisEntityIdentify (const SFEIrisTemplate probe_iris_template, const SFEIrisTemplate templates_gallery, const SFEEntity entities_gallery, size_t gallery_size, float matching_score_threshold, SFEEntityIdentificationCandidate out_candidates, size_t *in_out_candidates_count, size_t thread_count)
	Get an ordered array of SFEEntityIdentificationCandidate from probe's template best matches with templates in the gallery. Entity is then used to group the results by entity using the best score of any template associated with the entity.

Detailed Description

File containing API of sfe_iris library as part of SFE Toolkit.

Author: Innovatrics - SmartFace Embedded

Date: 2.1.2024

Definition in file sfe_iris.h.

Macro Definition Documentation

◆ SFE_IRIS_TEMPLATE_SIZE

#define SFE_IRIS_TEMPLATE_SIZE 522

Iris template size in bytes.

Definition at line 19 of file sfe_iris.h.

Typedef Documentation

◆ SFEIrisTemplate

typedef struct SFEIrisTemplate SFEIrisTemplate

Iris template struct.

◆ SFEIrisTemplateVersion

typedef struct SFEIrisTemplateVersion SFEIrisTemplateVersion

Iris template version struct.

Function Documentation

◆ sfeIrisEntityIdentify()

SFEError sfeIrisEntityIdentify	(	const SFEIrisTemplate *	probe_iris_template,
		const SFEIrisTemplate *	templates_gallery,
		const SFEEntity *	entities_gallery,
		size_t	gallery_size,
		float	matching_score_threshold,
		SFEEntityIdentificationCandidate *	out_candidates,
		size_t *	in_out_candidates_count,
		size_t	thread_count
	)

Get an ordered array of SFEEntityIdentificationCandidate from probe's template best matches with templates in the gallery. Entity is then used to group the results by entity using the best score of any template associated with the entity.

Parameters

[in]	probe_iris_template	probe template
[in]	templates_gallery	pointer to an array of SFEIrisTemplate
[in]	entities_gallery	pointer to an array of SFEEntity that corresponds with templates_gallery
[in]	gallery_size	number of templates in gallery
[in]	matching_score_threshold	threshold for matching - range <0,1>
[out]	out_candidates	Pointer to an ordered array of candidates
[in,out]	in_out_candidates_count	IN: Expected number of candidates OUT: Number of found candidates with matching score above the matching score threshold
[in]	thread_count	Number of threads to use in the identification - 0: use all available cores, 1: use single thread, N: use N number of threads

Returns: Error in case of failed identification.

◆ sfeIrisTemplateExtract()

SFEError sfeIrisTemplateExtract	(	SFESolver	solver,
		SFEImageView	image,
		const SFEDetection *	detection,
		SFEIrisTemplate *	out_iris_template
	)

Extract template from source image and given iris detection.

Parameters

[in]	solver	iris template extraction solver
[in]	image	source image
[in]	detection	core detection containing the detected iris
[out]	out_iris_template	extracted iris template

Returns: Error in case of failed extraction.

Examples: example_iris_identify.cpp.

◆ sfeIrisTemplateIdentify()

SFEError sfeIrisTemplateIdentify	(	const SFEIrisTemplate *	probe_iris_template,
		const SFEIrisTemplate *	templates_gallery,
		size_t	gallery_size,
		float	matching_score_threshold,
		SFETemplateIdentificationCandidate *	out_candidates,
		size_t *	in_out_candidates_count,
		size_t	thread_count
	)

Get an ordered array of SFETemplateIdentificationCandidate from probe's template best matches with templates in the gallery.

Parameters

[in]	probe_iris_template	probe template
[in]	templates_gallery	pointer to an array of SFIrisTemplate
[in]	gallery_size	number of templates in the gallery
[in]	matching_score_threshold	threshold for matching - range <0,1>
[out]	out_candidates	Pointer to an ordered array of candidates
[in,out]	in_out_candidates_count	IN: Expected number of candidates OUT: Number of found candidates with matching score above the matching score threshold
[in]	thread_count	Number of threads to use in the identification - 0: use all available cores, 1: use single thread, N: use N number of threads

Returns: Error in case of failed identification.

Examples: example_iris_identify.cpp.

◆ sfeIrisTemplateMatch()

SFEError sfeIrisTemplateMatch	(	const SFEIrisTemplate *	template1,
		const SFEIrisTemplate *	template2,
		float *	out_matching_score
	)

Match two iris templates.

Parameters

[in]	template1	first template to match
[in]	template2	second template to match
[out]	out_matching_score	matching score - range <0,1>

Returns: Error in case of failed matching.

Examples: example_iris_identify.cpp.

◆ sfeIrisTemplateQuality()

SFEError sfeIrisTemplateQuality	(	const SFEIrisTemplate *	iris_template,
		float *	out_iris_template_quality
	)

Get iris template quality.

Parameters

[in]	iris_template	source iris template
[out]	out_iris_template_quality	template quality - range <0,1>

Returns: Error in case of template checksum mismatch.

Examples: example_iris_identify.cpp.

◆ sfeIrisTemplateVersion()

SFEError sfeIrisTemplateVersion	(	const SFEIrisTemplate *	iris_template,
		SFEIrisTemplateVersion *	out_iris_template_version
	)

Get iris template version.

Parameters

[in]	iris_template	source iris template
[out]	out_iris_template_version	iris template version struct

Returns: Error in case of template checksum mismatch.

Examples: example_iris_identify.cpp.

Data Structures

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ SFE_IRIS_TEMPLATE_SIZE

Typedef Documentation

◆ SFEIrisTemplate

◆ SFEIrisTemplateVersion

Function Documentation

◆ sfeIrisEntityIdentify()

◆ sfeIrisTemplateExtract()

◆ sfeIrisTemplateIdentify()

◆ sfeIrisTemplateMatch()

◆ sfeIrisTemplateQuality()

◆ sfeIrisTemplateVersion()