Face SDK  1.13.0 Mozart release
Face Recognition Software Development Kit
Classes | Functions | Variables
Java interface

Classes

interface  com.tech5.FaceSDK.Liveness< Result extends LivenessResult >
 
class  com.tech5.FaceSDK.Liveness102.Native
 
class  com.tech5.FaceSDK.Liveness102
 
class  com.tech5.FaceSDK.Liveness102Config.Native
 
class  com.tech5.FaceSDK.Liveness102Config
 
enum  com.tech5.FaceSDK.Liveness102Result.ErrorCodes
 
class  com.tech5.FaceSDK.Liveness102Result.Native
 
class  com.tech5.FaceSDK.Liveness102Result
 
class  com.tech5.FaceSDK.Liveness102ResultSet.Native
 
class  com.tech5.FaceSDK.Liveness102ResultSet
 
interface  com.tech5.FaceSDK.LivenessResult
 

Functions

List< Result > com.tech5.FaceSDK.Liveness< Result extends LivenessResult >.processFaces (FaceSet faces) throws FaceSDKException
 
int com.tech5.FaceSDK.Liveness< Result extends LivenessResult >.getVersion ()
 
 com.tech5.FaceSDK.Liveness102.Liveness102 (Liveness102Config config, int batchSize, int computeDevice) throws FaceSDKException
 
 com.tech5.FaceSDK.Liveness102.Liveness102 (Liveness102Config config, License license, DataContainer dataContainer, int batchSize, int computeDevice) throws FaceSDKException
 
 com.tech5.FaceSDK.Liveness102.Liveness102 (Liveness102Config config, License license, int batchSize, int computeDevice) throws FaceSDKException
 
 com.tech5.FaceSDK.Liveness102.Liveness102 (Liveness102Config config, DataContainer dataContainer, int batchSize, int computeDevice) throws FaceSDKException
 
boolean com.tech5.FaceSDK.Liveness102.equals (Object o)
 
int com.tech5.FaceSDK.Liveness102.hashCode ()
 
void com.tech5.FaceSDK.Liveness102.close () throws Exception
 
void com.tech5.FaceSDK.Liveness102.finalize () throws Throwable
 
int com.tech5.FaceSDK.Liveness102.getVersion ()
 
List< Liveness102Resultcom.tech5.FaceSDK.Liveness102.processFaces (FaceSet faces) throws FaceSDKException
 
 com.tech5.FaceSDK.Liveness102Config.Liveness102Config (float threshold1, float threshold2, float threshold3) throws FaceSDKException
 
 com.tech5.FaceSDK.Liveness102Config.Liveness102Config () throws FaceSDKException
 
float com.tech5.FaceSDK.Liveness102Config.getThreshold1 ()
 
float com.tech5.FaceSDK.Liveness102Config.getThreshold2 ()
 
float com.tech5.FaceSDK.Liveness102Config.getThreshold3 ()
 
boolean com.tech5.FaceSDK.Liveness102Config.equals (Object o)
 
int com.tech5.FaceSDK.Liveness102Config.hashCode ()
 
void com.tech5.FaceSDK.Liveness102Config.close () throws Exception
 
void com.tech5.FaceSDK.Liveness102Config.finalize () throws Throwable
 
float com.tech5.FaceSDK.Liveness102Result.getValue1 ()
 
float com.tech5.FaceSDK.Liveness102Result.getValue2 ()
 
float com.tech5.FaceSDK.Liveness102Result.getValue3 ()
 
int com.tech5.FaceSDK.Liveness102Result.getErrorCode ()
 
boolean com.tech5.FaceSDK.Liveness102Result.getReal ()
 
boolean com.tech5.FaceSDK.Liveness102Result.equals (Object o)
 
int com.tech5.FaceSDK.Liveness102Result.hashCode ()
 
void com.tech5.FaceSDK.Liveness102Result.close () throws Exception
 
void com.tech5.FaceSDK.Liveness102Result.finalize () throws Throwable
 
boolean com.tech5.FaceSDK.Liveness102ResultSet.equals (Object o)
 
int com.tech5.FaceSDK.Liveness102ResultSet.hashCode ()
 
void com.tech5.FaceSDK.Liveness102ResultSet.close () throws Exception
 
void com.tech5.FaceSDK.Liveness102ResultSet.finalize () throws Throwable
 
Liveness102Result com.tech5.FaceSDK.Liveness102ResultSet.get (int index)
 
int com.tech5.FaceSDK.Liveness102ResultSet.size ()
 
int com.tech5.FaceSDK.LivenessResult.getErrorCode ()
 
boolean com.tech5.FaceSDK.LivenessResult.getReal ()
 

Variables

 com.tech5.FaceSDK.Liveness102Result.ErrorCodes.Success
 
 com.tech5.FaceSDK.Liveness102Result.ErrorCodes.ImageTooSmall
 
 com.tech5.FaceSDK.Liveness102Result.ErrorCodes.TooBigFace
 
 com.tech5.FaceSDK.Liveness102Result.ErrorCodes.TooLargeYAWAngle
 
 com.tech5.FaceSDK.Liveness102Result.ErrorCodes.TooLargeROLLAngle
 
 com.tech5.FaceSDK.Liveness102Result.ErrorCodes.UnsupportedDetectorVersion
 
 com.tech5.FaceSDK.Liveness102Result.ErrorCodes.FaceOutOfBounds
 

Detailed Description

Function Documentation

◆ getErrorCode() [1/2]

int com.tech5.FaceSDK.LivenessResult.getErrorCode ( )

Liveness error code. Value 0 means "Liveness is passed", non-zero values means "Liveness is not passed".

What exactly is failed is depending on implementation.

Returns
error code, where 0 mean "Liveness is passed" and non-zero values means "Liveness is not passed".

Implemented in com.tech5.FaceSDK.Liveness102Result.

◆ getErrorCode() [2/2]

int com.tech5.FaceSDK.Liveness102Result.getErrorCode ( )
inline

Liveness error code. Value 0 means "Liveness is passed", non-zero values means "Liveness is not passed".

What exactly is failed is depending on implementation.

Returns
error code, where 0 mean "Liveness is passed" and non-zero values means "Liveness is not passed".

Implements com.tech5.FaceSDK.LivenessResult.

◆ getReal() [1/2]

boolean com.tech5.FaceSDK.LivenessResult.getReal ( )

false in case of spoof.

Returns
false in case of spoof.

Implemented in com.tech5.FaceSDK.Liveness102Result.

◆ getReal() [2/2]

boolean com.tech5.FaceSDK.Liveness102Result.getReal ( )
inline

false in case of spoof.

Returns
false in case of spoof.

Implements com.tech5.FaceSDK.LivenessResult.

◆ Liveness102() [1/4]

com.tech5.FaceSDK.Liveness102.Liveness102 ( Liveness102Config  config,
int  batchSize,
int  computeDevice 
) throws FaceSDKException
inline

Creates Liveness102 with specified config, batch size and compute device

The data container is loaded from known paths (see Known paths).
The default license is loaded. License#makeDefaultLicense().

Parameters
configthe config.
batchSizethe batch size.
computeDevicethe compute device. -1 = CPU. 0, 1, ..., N - GPU device.
Exceptions
IllegalArgumentExceptionif config is null.
FaceSDKExceptionin case of an error in native code.

◆ Liveness102() [2/4]

com.tech5.FaceSDK.Liveness102.Liveness102 ( Liveness102Config  config,
License  license,
DataContainer  dataContainer,
int  batchSize,
int  computeDevice 
) throws FaceSDKException
inline

Creates Liveness102 with specified config, license, data container, batch size and compute device

Parameters
configthe config.
licensethe license.
dataContainerthe data container.
batchSizethe batch size.
computeDevicethe compute device. -1 = CPU. 0, 1, ..., N - GPU device.
Exceptions
IllegalArgumentExceptionif config is null OR license is null OR dataContainer is null.
FaceSDKExceptionin case of an error in native code.

◆ Liveness102() [3/4]

com.tech5.FaceSDK.Liveness102.Liveness102 ( Liveness102Config  config,
License  license,
int  batchSize,
int  computeDevice 
) throws FaceSDKException
inline

Creates Liveness102 with specified config, license, batch size and compute device

The data container is loaded from known paths (see Known paths).

Parameters
configthe config.
licensethe license.
batchSizethe batch size.
computeDevicethe compute device. -1 = CPU. 0, 1, ..., N - GPU device.
Exceptions
IllegalArgumentExceptionif config is null OR license is null.
FaceSDKExceptionin case of an error in native code.

◆ Liveness102() [4/4]

com.tech5.FaceSDK.Liveness102.Liveness102 ( Liveness102Config  config,
DataContainer  dataContainer,
int  batchSize,
int  computeDevice 
) throws FaceSDKException
inline

Creates Liveness102 with specified config, data container, batch size and compute device

The default license is loaded. License#makeDefaultLicense().

Parameters
configthe config.
dataContainerthe data container.
batchSizethe batch size.
computeDevicethe compute device. -1 = CPU. 0, 1, ..., N - GPU device.
Exceptions
IllegalArgumentExceptionif config is null OR dataContainer is null.
FaceSDKExceptionin case of an error in native code.

◆ Liveness102Config() [1/2]

com.tech5.FaceSDK.Liveness102Config.Liveness102Config ( float  threshold1,
float  threshold2,
float  threshold3 
) throws FaceSDKException
inline

Creates config with specified thresholds.

Parameters
threshold1threshold1 value.
threshold2threshold2 value.
threshold3threshold2 value.
Exceptions
FaceSDKExceptionin case of an error in native code.

◆ Liveness102Config() [2/2]

com.tech5.FaceSDK.Liveness102Config.Liveness102Config ( ) throws FaceSDKException
inline

Creates config with default thresholds.

Exceptions
FaceSDKExceptionin case of an error in native code.

◆ processFaces()

List<Result> com.tech5.FaceSDK.Liveness< Result extends LivenessResult >.processFaces ( FaceSet  faces) throws FaceSDKException

Performs liveness detection on detected faces.

Parameters
facesdetected faces
Returns
liveness results list where i-element of the list corresponds to i-element of the faces
Exceptions
FaceSDKExceptionin case of an error in native code.

Variable Documentation

◆ FaceOutOfBounds

com.tech5.FaceSDK.Liveness102Result.ErrorCodes.FaceOutOfBounds

Detected face is out of image bounds

◆ ImageTooSmall

com.tech5.FaceSDK.Liveness102Result.ErrorCodes.ImageTooSmall

Input image is too small. Width and Height of the image must be not less than 128

◆ Success

com.tech5.FaceSDK.Liveness102Result.ErrorCodes.Success

Liveness is passed

◆ TooBigFace

com.tech5.FaceSDK.Liveness102Result.ErrorCodes.TooBigFace

detected face width is too big. The ratio of the distance between the eyes and the image size must not be greater than 0.2325

◆ TooLargeROLLAngle

com.tech5.FaceSDK.Liveness102Result.ErrorCodes.TooLargeROLLAngle

detected face rool angle is too big. The angle must not be greater than 25

◆ TooLargeYAWAngle

com.tech5.FaceSDK.Liveness102Result.ErrorCodes.TooLargeYAWAngle

Detected face yaw angle is too big. The angle must not be greater than 25

◆ UnsupportedDetectorVersion

com.tech5.FaceSDK.Liveness102Result.ErrorCodes.UnsupportedDetectorVersion

Given IFace object was made by unsupported face detector version.