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

# FaceTracker Class

Namespace: id3.Face

## Definition

Tracks faces on consecutive images and automatically creates and updates associated face templates.
Python

    class FaceTracker

Dart

    class FaceTracker implements Finalizable

C#

    public partial class FaceTracker

Java

    public class FaceTracker implements AutoCloseable, Serializable

Swift

    public class FaceTracker

C

    typedef struct id3FaceTracker *ID3_FACE_TRACKER;

## Usage

Python

    faceTrackerInstance = id3face.FaceTracker()

Explicit destruction

    # ...
    del faceTrackerInstance

Dart

    final faceTrackerInstance = sdk.FaceTracker();
    // ...

Explicit destruction

    // ...
    faceTrackerInstance.dispose()

C#

    using (var faceTrackerInstance = new FaceTracker())
    {
       // ...
    }

Explicit destruction

    var faceTrackerInstance = new FaceTracker()
    // ...
    faceTrackerInstance.Dispose()

Java

    try (FaceTracker faceTrackerInstance = new FaceTracker()) {
    // ...
    }

Explicit destruction

    FaceTracker faceTrackerInstance = new FaceTracker();
    // ...
    faceTrackerInstance.close();

Swift

    private var faceTrackerInstance: FaceTracker? = nil
    faceTrackerInstance = try FaceTracker()

C

    ID3_FACE_TRACKER hFaceTracker{};
    int err = id3FaceTracker_Initialize(&hFaceTracker);
    if (err == ID3_SUCCESS) {
        // ...
        id3FaceTracker_Dispose(&hFaceTracker);
    }

## Properties

Name | Type | Description
--- | --- | ---
confidenceThreshold | int | Confidence threshold, in the range [0;100].
detectionModel | FaceModel | Model used to detect and track faces.
encodingModel | FaceModel | Model used to create features and assess consistancy among views of a given face.
matchThreshold | int | Minimum match score to reach to preserve the ID of a tracked face between frame ‘t-1’ and frame ‘t’.
maximumTrackedFaceAge | int | Maximum number of consecutive non-detections to reach before deleting a tracked face.
minimumTrackedFaceAge | int | Minimum number of consecutive detections to reach before creating a tracked face.
nmsIouThreshold | int | Non-maximum suppression (NMS) intersection-over-union (IOU) threshold, in the range is [0;100].
threadCount | int | Number of threads to be used for face detection and tracking.

## Methods

Name | Description
--- | ---
detectFaces | Detects faces in an image and update their info in a TrackedFaceList object.
trackFaces | Tracks faces in an image and update their info in a TrackedFaceList object.
warmUp | Gets the face tracker module ready to work on a specific image size by initializing all its internal memory layout.