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

#include "sfe_core.h"

Data Structures
struct	SFEPalmTemplate
	Palm template struct. More...

struct	SFEPalmTemplateVersion
	Palm template version struct. More...

struct	SFEPalmAttributes

Macros
#define	SFE_PALM_TEMPLATE_SIZE 522
	Palm template size in bytes.

Typedefs
typedef struct SFEPalmTemplate	SFEPalmTemplate
	Palm template struct.

typedef struct SFEPalmTemplateVersion	SFEPalmTemplateVersion
	Palm template version struct.

typedef struct SFEPalmAttributes	SFEPalmAttributes

Functions
SFEError	sfePalmLandmarks (SFESolver solver, SFEImageView image, const SFEDetection detection, SFEPalmLandmarks out_landmarks)
	Calculate palm landmarks from given source image and palm detection.

SFEError	sfePalmAttributes (SFESolver solver, SFEImageView image, const SFEPalmLandmarks landmarks, SFEPalmAttributes out_attributes)
	Calculate palm image quality attributes from given source image and palm detection.

SFEError	sfePalmTemplateExtract (SFESolver solver, SFEImageView image, const SFEPalmLandmarks landmarks, SFEPalmTemplate out_palm_template)
	Extract template from source image and given palm attributes.

SFEError	sfePalmTemplateMatch (const SFEPalmTemplate template1, const SFEPalmTemplate template2, float *out_matching_score)
	Match two palm templates.

SFEError	sfePalmTemplateVersion (const SFEPalmTemplate palm_template, SFEPalmTemplateVersion out_palm_template_version)
	Get palm template version.

SFEError	sfePalmTemplateIdentify (const SFEPalmTemplate probe_palm_template, const SFEPalmTemplate 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	sfePalmEntityIdentify (const SFEPalmTemplate probe_palm_template, const SFEPalmTemplate 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.

SFEError	sfePalmLivenessPassive (SFESolver solver, SFEImageView image, const SFEDetection detection, float out_liveness_score)
	Passive liveness score calculation.

Detailed Description

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

Author: Innovatrics - SmartFace Embedded

Date: 28.10.2024

Definition in file sfe_palm.h.

Macro Definition Documentation

◆ SFE_PALM_TEMPLATE_SIZE

#define SFE_PALM_TEMPLATE_SIZE 522

Palm template size in bytes.

Definition at line 19 of file sfe_palm.h.

Typedef Documentation

◆ SFEPalmAttributes

typedef struct SFEPalmAttributes SFEPalmAttributes

◆ SFEPalmTemplate

typedef struct SFEPalmTemplate SFEPalmTemplate

Palm template struct.

◆ SFEPalmTemplateVersion

typedef struct SFEPalmTemplateVersion SFEPalmTemplateVersion

Palm template version struct.

Function Documentation

◆ sfePalmAttributes()

SFEError sfePalmAttributes	(	SFESolver	solver,
		SFEImageView	image,
		const SFEPalmLandmarks *	landmarks,
		SFEPalmAttributes *	out_attributes
	)

Calculate palm image quality attributes from given source image and palm detection.

Parameters

[in]	solver	attributes solver
[in]	image	source image
[in]	landmarks	palm landmarks
[out]	out_attributes	structure containing `hand_orientation`, `hand_position`, `quality`

Returns: Error in case of failed attributes calculation

Examples: example_palm_attributes.cpp.

◆ sfePalmEntityIdentify()

SFEError sfePalmEntityIdentify	(	const SFEPalmTemplate *	probe_palm_template,
		const SFEPalmTemplate *	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_palm_template	probe template
[in]	templates_gallery	pointer to an array of SFEPalmTemplate
[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.

◆ sfePalmLandmarks()

SFEError sfePalmLandmarks	(	SFESolver	solver,
		SFEImageView	image,
		const SFEDetection *	detection,
		SFEPalmLandmarks *	out_landmarks
	)

Calculate palm landmarks from given source image and palm detection.

Parameters

[in]	solver	landmarks solver
[in]	image	source image
[in]	detection	core detection containing the detected palm
[out]	out_landmarks	structure containing `hand_position`, `hand_orientation`, `confidence`, and `keypoints`

Returns: Error in case of failed landmarks calculation

Examples: example_palm_attributes.cpp, and example_palm_identify.cpp.

◆ sfePalmLivenessPassive()

SFEError sfePalmLivenessPassive	(	SFESolver	solver,
		SFEImageView	image,
		const SFEDetection *	detection,
		float *	out_liveness_score
	)

Passive liveness score calculation.

Parameters

[in]	solver	passive liveness solver
[in]	image	source image
[in]	detection	core detection containing the detected palm
[out]	out_liveness_score	OUT: normalized score of passive liveness

Returns: Error in case of failed passive liveness score calculation

Examples: example_palm_liveness.cpp.

◆ sfePalmTemplateExtract()

SFEError sfePalmTemplateExtract	(	SFESolver	solver,
		SFEImageView	image,
		const SFEPalmLandmarks *	landmarks,
		SFEPalmTemplate *	out_palm_template
	)

Extract template from source image and given palm attributes.

Parameters

[in]	solver	palm extraction solver
[in]	image	source image
[in]	landmarks	palm landmarks
[out]	out_palm_template	extracted palm template

Returns: Error in case of failed extraction.

Examples: example_palm_identify.cpp.

◆ sfePalmTemplateIdentify()

SFEError sfePalmTemplateIdentify	(	const SFEPalmTemplate *	probe_palm_template,
		const SFEPalmTemplate *	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_palm_template	probe template
[in]	templates_gallery	pointer to an array of SFPalmTemplate
[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_palm_identify.cpp.

◆ sfePalmTemplateMatch()

SFEError sfePalmTemplateMatch	(	const SFEPalmTemplate *	template1,
		const SFEPalmTemplate *	template2,
		float *	out_matching_score
	)

Match two palm 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_palm_identify.cpp.

◆ sfePalmTemplateVersion()

SFEError sfePalmTemplateVersion	(	const SFEPalmTemplate *	palm_template,
		SFEPalmTemplateVersion *	out_palm_template_version
	)

Get palm template version.

Parameters

[in]	palm_template	source palm template
[out]	out_palm_template_version	palm template version struct

Returns: Error in case of template checksum mismatch.

Examples: example_palm_identify.cpp.

Data Structures

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ SFE_PALM_TEMPLATE_SIZE

Typedef Documentation

◆ SFEPalmAttributes

◆ SFEPalmTemplate

◆ SFEPalmTemplateVersion

Function Documentation

◆ sfePalmAttributes()

◆ sfePalmEntityIdentify()

◆ sfePalmLandmarks()

◆ sfePalmLivenessPassive()

◆ sfePalmTemplateExtract()

◆ sfePalmTemplateIdentify()

◆ sfePalmTemplateMatch()

◆ sfePalmTemplateVersion()