FaceTemplateStatus

The FaceTemplateStatus message provides the status of a biometric face template as managed by BWS.

Message definition

message FaceTemplateStatus {
    int64 classId = 1;
    bool available = 2;
    google.protobuf.Timestamp enrolled = 3;
    repeated string tags = 4;
    int32 encoder_version = 5;
    int32 feature_vectors = 6;
    int32 thumbnails_stored = 7;
    repeated Thumbnail thumbnails = 8;

    message Thumbnail {
        google.protobuf.Timestamp enrolled = 1;
        bytes image = 2;
    }
}

FaceTemplateStatus fields

classId

Unique class ID associated with the template.

available

Is there a template stored for the this class? Only if this flag is set to true, the following fields are set as well.

enrolled

When has the template been generated the last time.

tags

List of tags stored with the template.

encoder_version

The version of the encoder used to calculate the feature vectors for this template.

feature_vectors

The number of feature vectors (created from the enrolled face images) that have been calculated, stored and used to generate the template.

thumbnails_stored

The number of thumbnails (created from the enrolled face images) that have been stored with the template. The storage of thumbnails is optional, but is required, when a template shall be upgraded to newer encoder version.

thumbnails

If thumbnails have been stored and they have been requested (with a call to GetTemplateStatus), those are returned with this field.

Thumbnail

In the Thumbnail message a stored thumbnail, cut out from an enrolled face image, is returned:

enrolled

Timestamp when the image was enrolled.

image

The binary image data of the thumbnail (typically serialized as PNG).