eu.id3.face

Class FaceCandidate

java.lang.Object

eu.id3.face.FaceCandidate

All Implemented Interfaces:

java.io.Serializable, java.lang.AutoCloseable

public class FaceCandidate
extends java.lang.Object
implements java.lang.AutoCloseable, java.io.Serializable

Represents a candidate in a one-to-many search.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FaceCandidate() Creates a new instance of the FaceCandidate class.
FaceCandidate(long handle) Creates a new instance of the FaceCandidate class.

Method Summary

Modifier and Type	Method and Description
FaceCandidate	clone() Creates a copy of the FaceCandidate object.
void	close() Releases all resources used by this FaceCandidate.
protected void	finalize() Finalizer for this class.
long	getHandle() Gets the native handle.
java.lang.String	getId() Gets the ID of the most similar face template as defined in the reference face template list used to perform the search.
int	getScore() Gets the match score between the face probe template and the most similar one in the reference face template list used to perform the search.

Methods inherited from class java.lang.Object

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

Constructor Detail

FaceCandidate

public FaceCandidate()
              throws FaceException

Creates a new instance of the FaceCandidate class.

Throws:

FaceException - An error has occurred during Face Library execution.

FaceCandidate

public FaceCandidate(long handle)
              throws FaceException

Creates a new instance of the FaceCandidate class.

Parameters:

handle - Handle to the FaceCandidate.

Throws:

FaceException - An error has occurred during Face Library execution.

Method Detail

close

public void close()

Releases all resources used by this FaceCandidate.

Specified by:

close in interface java.lang.AutoCloseable

finalize

protected void finalize()

Finalizer for this class. Finalizers are deprecated since Java 9+. This method is not guaranteed to be called. To release all memory held by this class please be sure to call the close() method.

Overrides:

finalize in class java.lang.Object

getHandle

public long getHandle()

Gets the native handle.

Returns:

The native handle.

clone

public FaceCandidate clone()
                    throws FaceException

Creates a copy of the FaceCandidate object.

Overrides:

clone in class java.lang.Object

Returns:

The newly created FaceCandidate object.

Throws:

FaceException - An error has occurred during Face Library execution.

getId

public java.lang.String getId()
                       throws FaceException

Gets the ID of the most similar face template as defined in the reference face template list used to perform the search.

Returns:

ID of the most similar face template as defined in the reference face template list used to perform the search.

Throws:

FaceException - An error has occurred during Face Library execution.

getScore

public int getScore()
             throws FaceException

Gets the match score between the face probe template and the most similar one in the reference face template list used to perform the search.

Returns:

Match score between the face probe template and the most similar one in the reference face template list used to perform the search.

Throws:

FaceException - An error has occurred during Face Library execution.