Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
Toggle table of contents sidebar

# FaceIndexer Class

Namespace: id3.Face

## Definition

Performs a one-to-many search on a large number of face templates.
Python

    class FaceIndexer

Dart

    class FaceIndexer implements Finalizable

C#

    public partial class FaceIndexer

Java

    public class FaceIndexer implements AutoCloseable, Serializable

Swift

    public class FaceIndexer

C

    typedef struct id3FaceIndexer *ID3_FACE_INDEXER;

## Usage

Python

    faceIndexerInstance = id3face.FaceIndexer()

Explicit destruction

    # ...
    del faceIndexerInstance

Dart

    final faceIndexerInstance = sdk.FaceIndexer();
    // ...

Explicit destruction

    // ...
    faceIndexerInstance.dispose()

C#

    using (var faceIndexerInstance = new FaceIndexer())
    {
       // ...
    }

Explicit destruction

    var faceIndexerInstance = new FaceIndexer()
    // ...
    faceIndexerInstance.Dispose()

Java

    try (FaceIndexer faceIndexerInstance = new FaceIndexer()) {
    // ...
    }

Explicit destruction

    FaceIndexer faceIndexerInstance = new FaceIndexer();
    // ...
    faceIndexerInstance.close();

Swift

    private var faceIndexerInstance: FaceIndexer? = nil
    faceIndexerInstance = try FaceIndexer()

C

    ID3_FACE_INDEXER hFaceIndexer{};
    int err = id3FaceIndexer_Initialize(&hFaceIndexer);
    if (err == ID3_SUCCESS) {
        // ...
        id3FaceIndexer_Dispose(&hFaceIndexer);
    }

## Properties

Name | Type | Description
--- | --- | ---
format | FaceTemplateFormat | Face template format accepted by this face indexer.
maximumTemplateCount | int | Maximum number of templates that this face indexer can hold.
templateCount | int | Current number of indexed templates.

## Static Methods

Name | Description
--- | ---
create | Creates an empty face indexer
fromFile | Imports the face indexer object from a file.

## Methods

Name | Description
--- | ---
addTemplate | Adds a template to the Face Indexer.
deleteTemplate | Deletes a template from the face indexer.
getTemplate | Retrieves a template from the face indexer by ID.
resize | Resizes the maximum number of templates that the face indexer can hold.
searchTemplate | Performs a one-to-many search of a face template probe against a previously initialized face indexer and outputs a candidate list.
toFile | Saves the face indexer object to a file.