eu.id3.face

Class FaceLibrary

java.lang.Object

eu.id3.face.FaceLibrary

public class FaceLibrary
extends java.lang.Object

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.

Constructor Summary

Constructors

Constructor and Description
FaceLibrary()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getModelFileName(FaceModel model) Retrieves the model file name which is needed in the LoadModel function.
static java.lang.String	getVersion() Retrieves the library version as a `X.Y.Z` formatted string.
static LibVersion	getVersionEx() Retrieves the library version as a structure.
static void	loadModel(java.lang.String modelPath, FaceModel faceModel, ProcessingUnit processingUnit) Loads a specified AI model into memory from the specified directory.
static void	loadModelBuffer(byte[] modelBuffer, FaceModel faceModel, ProcessingUnit processingUnit) Loads a model into memory from the specified buffer.
static void	unloadModel(FaceModel faceModel, ProcessingUnit processingUnit) Unloads a model from memory.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FaceLibrary

public FaceLibrary()

Method Detail

getModelFileName

public static java.lang.String getModelFileName(FaceModel model)
                                         throws FaceException

Retrieves the model file name which is needed in the LoadModel function.

Parameters:

model - The Face Model to look for.

Returns:

The expected file name

Throws:

FaceException - An error has occurred during Face Library execution.

getVersion

public static java.lang.String getVersion()
                                   throws FaceException

Retrieves the library version as a `X.Y.Z` formatted string.

Returns:

A string that identifies the library version.

Throws:

FaceException - An error has occurred during Face Library execution.

getVersionEx

public static LibVersion getVersionEx()
                               throws FaceException

Retrieves the library version as a structure.

Returns:

The version.

Throws:

FaceException - An error has occurred during Face Library execution.

loadModel

public static void loadModel(java.lang.String modelPath,
                             FaceModel faceModel,
                             ProcessingUnit processingUnit)
                      throws FaceException

Loads a specified AI model into memory from the specified directory.

Parameters:

modelPath - The path to directory containing the AI model files.

faceModel - The AI model to be loaded.

processingUnit - The processing unit to be used.

Throws:

FaceException - An error has occurred during Face Library execution.

loadModelBuffer

public static void loadModelBuffer(byte[] modelBuffer,
                                   FaceModel faceModel,
                                   ProcessingUnit processingUnit)
                            throws FaceException

Loads a model into memory from the specified buffer.

Parameters:

modelBuffer - A buffer containing the AI model to be loaded.

faceModel - The AI model to be loaded.

processingUnit - The processing unit to be used.

Throws:

FaceException - An error has occurred during Face Library execution.

unloadModel

public static void unloadModel(FaceModel faceModel,
                               ProcessingUnit processingUnit)
                        throws FaceException

Unloads a model from memory.

Parameters:

faceModel - The AI model to be unloaded.

processingUnit - The processing unit used for the model.

Throws:

FaceException - An error has occurred during Face Library execution.