Classes
class	com.tech5.FaceSDK.QualityChecker.Native

class	com.tech5.FaceSDK.QualityChecker

class	com.tech5.FaceSDK.QualityCheckerInitializer.Native

class	com.tech5.FaceSDK.QualityCheckerInitializer

class	com.tech5.FaceSDK.QualityCheckerResult.Native

class	com.tech5.FaceSDK.QualityCheckerResult

class	com.tech5.FaceSDK.QualityCheckerResultSet.Native

class	com.tech5.FaceSDK.QualityCheckerResultSet

Functions
	com.tech5.FaceSDK.QualityChecker.QualityChecker (int version, License license, QualityCheckerInitializer initializer, int batchSize, int computeDevice) throws FaceSDKException

	com.tech5.FaceSDK.QualityChecker.QualityChecker (int version, QualityCheckerInitializer initializer, int batchSize, int computeDevice) throws FaceSDKException

	com.tech5.FaceSDK.QualityChecker.QualityChecker (int version, License license, int batchSize, int computeDevice) throws FaceSDKException

	com.tech5.FaceSDK.QualityChecker.QualityChecker (int version, int batchSize, int computeDevice) throws FaceSDKException

QualityCheckerResultSet	com.tech5.FaceSDK.QualityChecker.checkFaces (FaceSet faces) throws FaceSDKException

boolean	com.tech5.FaceSDK.QualityChecker.isCompatible (int faceDetectorVersion) throws FaceSDKException

boolean	com.tech5.FaceSDK.QualityChecker.equals (Object o)

int	com.tech5.FaceSDK.QualityChecker.hashCode ()

void	com.tech5.FaceSDK.QualityChecker.close () throws Exception

void	com.tech5.FaceSDK.QualityChecker.finalize () throws Throwable

void	com.tech5.FaceSDK.QualityCheckerInitializer.setUseBackgroundChecker (boolean use)

boolean	com.tech5.FaceSDK.QualityCheckerInitializer.getUseBackgroundChecker ()

void	com.tech5.FaceSDK.QualityCheckerInitializer.setUseBlurChecker (boolean use)

boolean	com.tech5.FaceSDK.QualityCheckerInitializer.getUseBlurChecker ()

void	com.tech5.FaceSDK.QualityCheckerInitializer.setUseFaceColorChecker (boolean use)

boolean	com.tech5.FaceSDK.QualityCheckerInitializer.getUseFaceColorChecker ()

void	com.tech5.FaceSDK.QualityCheckerInitializer.setUseGlassesSmileOcclusionChecker (boolean use)

boolean	com.tech5.FaceSDK.QualityCheckerInitializer.getUseGlassesSmileOcclusionChecker ()

void	com.tech5.FaceSDK.QualityCheckerInitializer.setUseHotSpotsChecker (boolean use)

boolean	com.tech5.FaceSDK.QualityCheckerInitializer.getUseHotSpotsChecker ()

void	com.tech5.FaceSDK.QualityCheckerInitializer.setUseRedEyesChecker (boolean use)

boolean	com.tech5.FaceSDK.QualityCheckerInitializer.getUseRedEyesChecker (long handle)

void	com.tech5.FaceSDK.QualityCheckerInitializer.setUseRotationChecker (boolean use)

boolean	com.tech5.FaceSDK.QualityCheckerInitializer.getUseRotationChecker (long handle)

void	com.tech5.FaceSDK.QualityCheckerInitializer.setUseMaskChecker (boolean use)

boolean	com.tech5.FaceSDK.QualityCheckerInitializer.getUseMaskChecker (long handle)

void	com.tech5.FaceSDK.QualityCheckerInitializer.setBackgroundContainer (DataContainer dataContainerHandle)

void	com.tech5.FaceSDK.QualityCheckerInitializer.setFaceColorContainer (DataContainer dataContainerHandle)

void	com.tech5.FaceSDK.QualityCheckerInitializer.setGlassesSmileOcclusionContainer (DataContainer dataContainerHandle)

void	com.tech5.FaceSDK.QualityCheckerInitializer.setRedEyesContainer (DataContainer dataContainerHandle)

void	com.tech5.FaceSDK.QualityCheckerInitializer.setMaskContainer (DataContainer dataContainerHandle)

boolean	com.tech5.FaceSDK.QualityCheckerInitializer.equals (Object o)

int	com.tech5.FaceSDK.QualityCheckerInitializer.hashCode ()

void	com.tech5.FaceSDK.QualityCheckerInitializer.close () throws Exception

void	com.tech5.FaceSDK.QualityCheckerInitializer.finalize () throws Throwable

Float	com.tech5.FaceSDK.QualityCheckerResult.getHotSpots ()

Float	com.tech5.FaceSDK.QualityCheckerResult.getBlur ()

Float	com.tech5.FaceSDK.QualityCheckerResult.getOverexposure ()

Float	com.tech5.FaceSDK.QualityCheckerResult.getRotation ()

Float	com.tech5.FaceSDK.QualityCheckerResult.getGlasses ()

Float	com.tech5.FaceSDK.QualityCheckerResult.getSmile ()

Float	com.tech5.FaceSDK.QualityCheckerResult.getOcclusion ()

Float	com.tech5.FaceSDK.QualityCheckerResult.getClosedEyes ()

Float	com.tech5.FaceSDK.QualityCheckerResult.getRedLeftEye ()

Float	com.tech5.FaceSDK.QualityCheckerResult.getRedRightEye ()

Float	com.tech5.FaceSDK.QualityCheckerResult.getFaceColor ()

Float	com.tech5.FaceSDK.QualityCheckerResult.getBackground ()

Float	com.tech5.FaceSDK.QualityCheckerResult.getMask ()

boolean	com.tech5.FaceSDK.QualityCheckerResult.equals (Object o)

int	com.tech5.FaceSDK.QualityCheckerResult.hashCode ()

void	com.tech5.FaceSDK.QualityCheckerResult.close () throws Exception

void	com.tech5.FaceSDK.QualityCheckerResult.finalize () throws Throwable

boolean	com.tech5.FaceSDK.QualityCheckerResultSet.equals (Object o)

int	com.tech5.FaceSDK.QualityCheckerResultSet.hashCode ()

void	com.tech5.FaceSDK.QualityCheckerResultSet.close () throws Exception

void	com.tech5.FaceSDK.QualityCheckerResultSet.finalize () throws Throwable

QualityCheckerResult	com.tech5.FaceSDK.QualityCheckerResultSet.get (int index)

int	com.tech5.FaceSDK.QualityCheckerResultSet.size ()

Detailed Description

Function Documentation

◆ checkFaces()

QualityCheckerResultSet com.tech5.FaceSDK.QualityChecker.checkFaces ( FaceSet faces ) throws FaceSDKException

inline

The function calculates images quality of the given faces.

Parameters

faces the face set to calculate image quality.

Returns: set of image quality calculation results where i-element of the set corresponds to i-element in the faces

Exceptions

IllegalArgumentException	if faces is null.
FaceSDKException	in case of an error in native code.

◆ getBackground()

Float com.tech5.FaceSDK.QualityCheckerResult.getBackground ( )

inline

Even background detector result.

Returns: value in range [0...1] or null, where 0 means the background is even and 1 means the background is not even; null if detector was not enabled.

◆ getBlur()

Float com.tech5.FaceSDK.QualityCheckerResult.getBlur ( )

inline

Blur detector result.

Returns: value in range [0...1] or Float.NaN, where 0 means no blur and 1 means blurred image; Float.Nan if detector was not enabled.

◆ getClosedEyes()

Float com.tech5.FaceSDK.QualityCheckerResult.getClosedEyes ( )

inline

Closed eye detector result.

Returns: value in range [0...1] or null, where 0 means eyes are open and 1 means eyes are closed; null if detector was not enabled.

◆ getFaceColor()

Float com.tech5.FaceSDK.QualityCheckerResult.getFaceColor ( )

inline

Unnatural skin detector result.

Returns: value in range [0...1] or null, where 0 means the skin color is normal and 1 means the color is unnatural; null if detector was not enabled.

◆ getGlasses()

Float com.tech5.FaceSDK.QualityCheckerResult.getGlasses ( )

inline

Glasses detector result.

Returns: value in range [0...1] or Float.NaN, where 0 means no glasses and 1 means glasses on; Float.Nan if detector was not enabled.

◆ getHotSpots()

Float com.tech5.FaceSDK.QualityCheckerResult.getHotSpots ( )

inline

Hot spots detector result.

Returns: value in range [0...1] or Float.NaN, where 0 means no hot spots and 1 means heavy hot spots; Float.Nan if detector was not enabled.

◆ getMask()

Float com.tech5.FaceSDK.QualityCheckerResult.getMask ( )

inline

Mask detector result.

Returns: value in range [0...1] or null, where 0 means no mask and 1 means there is a mask; null if detector was not enabled.

◆ getOcclusion()

Float com.tech5.FaceSDK.QualityCheckerResult.getOcclusion ( )

inline

Occlusion detector result.

Returns: value in range [0...1] or Float.NaN, where 0 means no occlusion and 1 means face is fully blocked; Float.Nan if detector was not enabled.

◆ getOverexposure()

Float com.tech5.FaceSDK.QualityCheckerResult.getOverexposure ( )

inline

Overexposure detector result.

Returns: value in range [0...1] or Float.NaN, where 0 means normal exposure and 1 means under/overexposed image; Float.Nan if detector was not enabled.

◆ getRedLeftEye()

Float com.tech5.FaceSDK.QualityCheckerResult.getRedLeftEye ( )

inline

Red eye (for left eye) detector result

Returns: value in range [0...1] or null, where 0 means normal eye color and 1 means red eye; null if detector was not enabled.

◆ getRedRightEye()

Float com.tech5.FaceSDK.QualityCheckerResult.getRedRightEye ( )

inline

Red eye (for right eye) detector result

Returns: value in range [0...1] or null, where 0 means normal eye color and 1 means red eye; null if detector was not enabled.

◆ getRotation()

Float com.tech5.FaceSDK.QualityCheckerResult.getRotation ( )

inline

Rotation detector result.

Returns: value in range [0...1] or Float.NaN, where 0 means face on image is not rotated and 1 means it is rotated; Float.Nan if detector was not enabled.

◆ getSmile()

Float com.tech5.FaceSDK.QualityCheckerResult.getSmile ( )

inline

Smile detector result.

Returns: value in range [0...1] or Float.NaN, where 0 means no smile and 1 means a smile; Float.Nan if detector was not enabled.

◆ isCompatible()

boolean com.tech5.FaceSDK.QualityChecker.isCompatible ( int faceDetectorVersion ) throws FaceSDKException

inline

Checks compatibility of QualityChecker and FaceDetector algorithms.

Parameters

faceDetectorVersion FaceDetector version.

Returns: true if algorithms are compatible and fase otherwise.

Exceptions

FaceSDKException in case of an error in native code.

◆ QualityChecker() [1/4]

com.tech5.FaceSDK.QualityChecker.QualityChecker	(	int	version,
		License	license,
		QualityCheckerInitializer	initializer,
		int	batchSize,
		int	computeDevice
	)		throws FaceSDKException

inline

Creates QualityChecker with nedeed version, license, initializer, batch size and compute device.

Parameters

version	required version of the algorithm.
license	the license.
initializer	the initialized object.
batchSize	the batch size.
computeDevice	the compute device. -1 = CPU. 0, 1, ..., N - GPU device.

Exceptions

IllegalArgumentException	if license is null or initializer is null.
FaceSDKException	in case of an error in native code.

◆ QualityChecker() [2/4]

com.tech5.FaceSDK.QualityChecker.QualityChecker	(	int	version,
		QualityCheckerInitializer	initializer,
		int	batchSize,
		int	computeDevice
	)		throws FaceSDKException

inline

Creates QualityChecker with nedeed version, initializer, batch size and compute device.

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

Parameters

version	required version of the algorithm.
initializer	the initialized object.
batchSize	the batch size.
computeDevice	the compute device. -1 = CPU. 0, 1, ..., N - GPU device.

Exceptions

IllegalArgumentException	if initializer is null.
FaceSDKException	in case of an error in native code.

◆ QualityChecker() [3/4]

com.tech5.FaceSDK.QualityChecker.QualityChecker	(	int	version,
		License	license,
		int	batchSize,
		int	computeDevice
	)		throws FaceSDKException

inline

Creates QualityChecker with nedeed version, license, batch size and compute device.

Default initializer is used. By default all checks are enabled, algorithm's data is loaded from known paths

Parameters

version	required version of the algorithm.
license	the license.
batchSize	the batch size.
computeDevice	the compute device. -1 = CPU. 0, 1, ..., N - GPU device.

Exceptions

IllegalArgumentException	if license is null or initializer is null.
FaceSDKException	in case of an error in native code.

◆ QualityChecker() [4/4]

com.tech5.FaceSDK.QualityChecker.QualityChecker	(	int	version,
		int	batchSize,
		int	computeDevice
	)		throws FaceSDKException

inline

Creates QualityChecker with nedeed version, batch size and compute device.

The default license is loaded. License#makeDefaultLicense().
Default initializer is used. By default all checks are enabled, algorithm's data is loaded from known paths

Parameters

version	required version of the algorithm.
batchSize	the batch size.
computeDevice	the compute device. -1 = CPU. 0, 1, ..., N - GPU device.

Exceptions

FaceSDKException in case of an error in native code.

Classes

Functions

Detailed Description

Function Documentation

◆ checkFaces()

◆ getBackground()

◆ getBlur()

◆ getClosedEyes()

◆ getFaceColor()

◆ getGlasses()

◆ getHotSpots()

◆ getMask()

◆ getOcclusion()

◆ getOverexposure()

◆ getRedLeftEye()

◆ getRedRightEye()

◆ getRotation()

◆ getSmile()

◆ isCompatible()

◆ QualityChecker() [1/4]

◆ QualityChecker() [2/4]

◆ QualityChecker() [3/4]

◆ QualityChecker() [4/4]