Inheritance diagram for com.tech5.FaceSDK.Builder:

Public Member Functions
	Builder (int version, License license, DataContainer dataContainer, int batchSize, int computeDevice) throws FaceSDKException

	Builder (int version, License license, DataContainer dataContainer, int batchSize, int computeDevice, boolean produceShortFirs) throws FaceSDKException

	Builder (int version, License license, int batchSize, int computeDevice) throws FaceSDKException

	Builder (int version, License license, int batchSize, int computeDevice, boolean produceShortFirs) throws FaceSDKException

	Builder (int version, DataContainer dataContainer, int batchSize, int computeDevice) throws FaceSDKException

	Builder (int version, DataContainer dataContainer, int batchSize, int computeDevice, boolean produceShortFirs) throws FaceSDKException

	Builder (int version, int batchSize, int computeDevice) throws FaceSDKException

	Builder (int version, int batchSize, int computeDevice, boolean produceShortFirs) throws FaceSDKException

FirSet	build (AlignmentInfoSet alignmentInfoSet) throws FaceSDKException

FirSet	build (FaceSet faces) throws FaceSDKException

int	getVersion ()

boolean	isCompatibleWithDetector (int detectorVersion)

boolean	isCompatibleWithAlignment (int alignmentVersion)

boolean	producesShortFirs ()

boolean	equals (Object o)

int	hashCode ()

void	close () throws Exception

Protected Member Functions
void	finalize () throws Throwable

Detailed Description

Algorithm extracts biometric templates (FIRs) from AlignmentInfo or from Face objects.

Use isCompatibleWithAlignment(int) and isCompatibleWithDetector(int) functions to determinate which type and its version of an input the builder accepts.
Builder has no assessment and extract template from any input, even if there is not face on the image.
Builder is compatible with the same version of FirMatcher! Builder 200 requires Fir Matcher 200, Builder 210 requires Fir Matcher 210, etc

Constructor & Destructor Documentation

◆ Builder() [1/8]

com.tech5.FaceSDK.Builder.Builder	(	int	version,
		License	license,
		DataContainer	dataContainer,
		int	batchSize,
		int	computeDevice
	)		throws FaceSDKException

inline

Creates the Builder object with specified version, license, data container, batch size and compute device.
The builder will extract short (or binary if version is 211) FIRs.

Parameters

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

Exceptions

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

◆ Builder() [2/8]

com.tech5.FaceSDK.Builder.Builder	(	int	version,
		License	license,
		DataContainer	dataContainer,
		int	batchSize,
		int	computeDevice,
		boolean	produceShortFirs
	)		throws FaceSDKException

inline

Creates the Builder object with specified version, license, data container, batch size, compute device and flag indicates which type of FIRs to extract.

Parameters

version	required version of the algorithm.
license	the license object.
dataContainer	the container with algorithm data.
batchSize	the batch size.
computeDevice	the compute device. -1 = CPU. 0, 1, ..., N - GPU device.
produceShortFirs	true to extract short (or binary if builder version is 211) FIRs; false to extract long FIRs.

Exceptions

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

◆ Builder() [3/8]

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

inline

Creates the Builder object with specified version, license, batch size and compute device.
The data container is loaded from known paths.
The builder will extract short (or binary if version is 211) FIRs.

Parameters

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

Exceptions

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

◆ Builder() [4/8]

com.tech5.FaceSDK.Builder.Builder	(	int	version,
		License	license,
		int	batchSize,
		int	computeDevice,
		boolean	produceShortFirs
	)		throws FaceSDKException

inline

Creates the Builder object with specified version, license, batch size, compute device and flag indicates which type of FIRs to extract.
The data container is loaded from known paths.

Parameters

version	required version of the algorithm.
license	the license object.
batchSize	the batch size.
computeDevice	the compute device. -1 = CPU. 0, 1, ..., N - GPU device.
produceShortFirs	true to extract short (or binary if builder version is 211) FIRs; false to extract long FIRs.

Exceptions

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

◆ Builder() [5/8]

com.tech5.FaceSDK.Builder.Builder	(	int	version,
		DataContainer	dataContainer,
		int	batchSize,
		int	computeDevice
	)		throws FaceSDKException

inline

Makes the Builder object with specified version, data container, batch size and compute device.
The default license is loaded. License#makeDefaultLicense().
The builder will extract short (or binary if version is 211) FIRs.

Parameters

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

Exceptions

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

◆ Builder() [6/8]

com.tech5.FaceSDK.Builder.Builder	(	int	version,
		DataContainer	dataContainer,
		int	batchSize,
		int	computeDevice,
		boolean	produceShortFirs
	)		throws FaceSDKException

inline

Makes the Builder object with specified version, data container, batch size, compute device and flag indicates which type of FIRs to extract.
The default license is loaded. License#makeDefaultLicense().

Parameters

version	required version of the algorithm.
dataContainer	the container with algorithm data.
batchSize	the batch size.
computeDevice	the compute device. -1 = CPU. 0, 1, ..., N - GPU device.
produceShortFirs	true to extract short (or binary if builder version is 211) FIRs; false to extract long FIRs.

Exceptions

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

◆ Builder() [7/8]

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

inline

Makes the Builder object with specified version, batch size and compute device.
The data container is loaded from known paths.
The default license is loaded. License#makeDefaultLicense().
The builder will extract short (or binary if version is 211) FIRs.

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.

◆ Builder() [8/8]

com.tech5.FaceSDK.Builder.Builder	(	int	version,
		int	batchSize,
		int	computeDevice,
		boolean	produceShortFirs
	)		throws FaceSDKException

inline

Creates the Builder object with specified version, license, batch size, compute device and flag indicates which type of FIRs to extract.
The data container is loaded from known paths.
The default license is loaded. License#makeDefaultLicense().

Parameters

version	required version of the algorithm.
batchSize	the batch size.
computeDevice	the compute device. -1 = CPU. 0, 1, ..., N - GPU device.
produceShortFirs	true to extract short (or binary if builder version is 211) FIRs; false to extract long FIRs.

Exceptions

FaceSDKException in case of an error in native code.

Member Function Documentation

◆ build() [1/2]

FirSet com.tech5.FaceSDK.Builder.build ( AlignmentInfoSet alignmentInfoSet ) throws FaceSDKException

inline

Extract FIRs from specified alignment info set.

Parameters

alignmentInfoSet alignment info set to extract FIRs.

Returns: FIR set where i-element of the set corresponds to i-elemen of the input alignment info set.

Exceptions

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

◆ build() [2/2]

FirSet com.tech5.FaceSDK.Builder.build ( FaceSet faces ) throws FaceSDKException

inline

Extract FIRs from specified face set.

Parameters

faces face set to extract FIRs.

Returns: FIR set where i-element of the set corresponds to i-elemen of the input face set.

Exceptions

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

◆ getVersion()

int com.tech5.FaceSDK.Builder.getVersion ( )

inline

Returns the builder's version

Returns: the builder's version

◆ isCompatibleWithAlignment()

boolean com.tech5.FaceSDK.Builder.isCompatibleWithAlignment ( int alignmentVersion )

inline

Checks compatibility with Alignment version.

Parameters

alignmentVersion Alignment version to check compatibility with the builder algorithm.

Returns: true if algorithms are compatible.

◆ isCompatibleWithDetector()

boolean com.tech5.FaceSDK.Builder.isCompatibleWithDetector ( int detectorVersion )

inline

Checks compatibility with FaceDetector version.

Parameters

detectorVersion FaceDetector version to check compatibility with the builder algorithm.

Returns: true if algorithms are compatible.

◆ producesShortFirs()

boolean com.tech5.FaceSDK.Builder.producesShortFirs ( )

inline

Returns true if the builder extracts short (or binary if builder's version is 211) FIRs

Returns: true if the builder extracts short (or binary if builder's version is 211) FIRs; false if builder extracts long FIRs

The documentation for this class was generated from the following file:

E:/git/face_sdk/java/lib/src/main/java/com/tech5/FaceSDK/Builder.java

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Builder() [1/8]

◆ Builder() [2/8]

◆ Builder() [3/8]

◆ Builder() [4/8]

◆ Builder() [5/8]

◆ Builder() [6/8]

◆ Builder() [7/8]

◆ Builder() [8/8]

Member Function Documentation

◆ build() [1/2]

◆ build() [2/2]

◆ getVersion()

◆ isCompatibleWithAlignment()

◆ isCompatibleWithDetector()

◆ producesShortFirs()