eu.id3.face

## Class FaceMatcher

- java.lang.Object
- - eu.id3.face.FaceMatcher

- All Implemented Interfaces:
    java.io.Serializable, java.lang.AutoCloseable

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

  Compares two face templates and searches for a face template in a list.
  See Also:
    Serialized Form

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `FaceMatcher()` Creates a new instance of the FaceMatcher class.
    `FaceMatcher(long handle)` Creates a new instance of the FaceMatcher class.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `close()` Releases all resources used by this FaceMatcher.
    `int` | `compareTemplateLists(FaceTemplateList referenceList, FaceTemplateList probeList, PoolingMethod poolingMethod)` Compares two template lists and outputs a comparison score.
    `int` | `compareTemplates(FaceTemplate reference, FaceTemplate probe)` Compares two templates and outputs a comparison score.
    `protected void` | `finalize()` Finalizer for this class.
    `long` | `getHandle()` Gets the native handle.
    `void` | `searchTemplate(FaceTemplateDict referenceDict, FaceTemplate probe, int maxCandidates, FaceCandidateList candidateList)` Performs a one-to-many search of a biometric probe against a previously initialized dictionary of biometric references and outputs a candidate list.

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### FaceMatcher

          public FaceMatcher()
                      throws FaceException

      Creates a new instance of the FaceMatcher class.
      Throws:
        `FaceException` - An error has occurred during Face Library execution.

    - #### FaceMatcher

          public FaceMatcher(long handle)
                      throws FaceException

      Creates a new instance of the FaceMatcher class.
      Parameters:
        `handle` - Handle to the FaceMatcher.
      Throws:
        `FaceException` - An error has occurred during Face Library execution.

  - ### Method Detail

    - #### close

          public void close()

      Releases all resources used by this FaceMatcher.
      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.

    - #### compareTemplateLists

          public int compareTemplateLists(FaceTemplateList referenceList,
                                          FaceTemplateList probeList,
                                          PoolingMethod poolingMethod)
                                   throws FaceException

      Compares two template lists and outputs a comparison score.
      Parameters:
        `referenceList` - Reference template list.
        `probeList` - Probe template list.
        `poolingMethod` - Pooling method applied during the match process.
      Returns:
        The comparison score, in the range [0;65535].
      Throws:
        `FaceException` - An error has occurred during Face Library execution.

    - #### compareTemplates

          public int compareTemplates(FaceTemplate reference,
                                      FaceTemplate probe)
                               throws FaceException

      Compares two templates and outputs a comparison score.
      Parameters:
        `reference` - Reference template.
        `probe` - Probe template.
      Returns:
        The comparison score, in the range [0;65535].
      Throws:
        `FaceException` - An error has occurred during Face Library execution.

    - #### searchTemplate

          public void searchTemplate(FaceTemplateDict referenceDict,
                                     FaceTemplate probe,
                                     int maxCandidates,
                                     FaceCandidateList candidateList)
                              throws FaceException

      Performs a one-to-many search of a biometric probe against a previously initialized dictionary of biometric references and outputs a candidate list.
      Parameters:
        `referenceDict` - Reference template dictionary.
        `probe` - Probe template.
        `maxCandidates` - Maximum number of candidates to output.
        `candidateList` - List of candidates sorted by decreasing match score.
      Throws:
        `FaceException` - An error has occurred during Face Library execution.

Copyright © id3 Technologies. All rights reserved. eu.id3.face