Face API

Classes

DetectedFace	Represents a detected face.
DetectedFaceList	Represents a list of detected faces.
FaceAnalyser	Provides methods for analysing the characteristics of portrait image.
FaceCandidate	Represents a candidate in a one-to-many search.
FaceCandidateList	Represents a candidate list in a one-to-many search.
FaceDetector	Detects human faces in images.
FaceEncoder	Extracts facial features and encodes face templates.
FaceIndexer	Performs a one-to-many search on a large number of face templates.
FaceLibrary	The FaceLibrary class serves as the entry point to the id3 Face SDK. It provides essential methods for initializing the SDK, managing face models, and accessing version information. This class must be utilized to leverage the facial recognition capabilities offered by the SDK.
FaceLicense	Handles the license to use this SDK.
FaceMatcher	Compares two face templates and searches for a face template in a list.
FacePad	Detects presentation attacks in still images or video frames.
FaceTemplate	Represents a face template.
FaceTemplateDict	Represents a dictionary of face templates.
FaceTemplateList	Represents a list of face templates.
FaceTracker	Tracks faces on consecutive images and automatically creates and updates associated face templates.
Image	Represents an image.
ImageBuffer	Represents an image buffer.
ImageDict	This class represents a ImageDict
ImageList	Represents a list of images.
PointList	Represents a point list.
Portrait	Represents a portrait.
PortraitProcessor	Facilitates the creation of portraits in various scenarios such as enrolment or face verification.
StringList	Represents a list of strings.
TrackedFace	Represents a tracked face.
TrackedFaceList	Represents a list of tracked faces.

Enumerations

FaceAttackSupport	Enumerates the types of presentation attack supports.
FaceError	Enumerates the possible error codes returned by this SDK.
FaceExpression	Enumerates the possible facial expressions.
FaceMatcherThreshold	Enumerates some typical values for the matching decision threshold.
FaceModel	Enumerates the AI models available in this SDK.
FaceSegmentationLabel	Enumerates the face segmentation labels
FaceTemplateFormat	Enumerates the face template formats.
ImageError	Enumerates possible error codes related to image management.
ImageFormat	Enumerates supported image formats.
LicenseError	Enumerates the error codes related to license management.
LicenseHardwareCodeType	Enumerates the types of hardware codes.
LicenseType	Enumerates the license types.
PadStatus	Enumerates the statuses of the presentation attack detection (PAD).
PixelFormat	Enumerates supported pixel formats.
PoolingMethod	Enumerates the possible pooling methods for template agregration in the FaceTracker module.
PortraitInstruction	Enumerates the instructions to be given to the user for effective portrait capture.
PortraitStatus	Enumerates the possible statuses of a portrait.
ProcessingUnit	Enumerates the processing units for the inference of AI models.
SubjectPosition	Enumerates the positions of a subject in an image.
TrackingStatus	Enumerates the possible face-tracking statuses.

Structures

BackgroundUniformity	Represents the result of the background uniformity check.
ColorBasedPadResult	Represents the result of the color-based PAD method.
DetectedFaceAttackSupport	Represents the result of the attack support detection.
EyeGaze	Represents the eye gaze.
FaceAttributes	Represents the face attributes.
FaceOcclusionScores	Represents the result of face occlusion detection.
FacePose	Represents the face pose (yaw, pitch, roll).
GeometricAttributes	Represents the geometric attributes of a portrait image.
GlassesAttributes	Represents some glasses attributes.
LibVersion	Contains data for LibVersion
PhotographicAttributes	Represents the photographic attributes of a portrait image.
Point	Represents a point.
PortraitQualityCheckpoints	Represents the portrait quality check points.
Rectangle	Represents a rectangle.

Exceptions

FaceException

This exception is thrown when an error occurs in the id3 Face library.