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

# FaceTemplate.toBit Method

Module: FaceTemplate

## Definition

Exports the face template as a Biometric Information Template (BIT) for enrolment on a smart card equipped with id3 Match-on-Card technology.

Note

The threshold value is required and should be set according to the used Face Encoder and desired security level.

Important

The reference data qualifier (RDQ) should be defined in accordance with the smart card application specifications.

Python

    to_bit(self, threshold: int, reference_data_qualifier: int) -> bytearray

Parameters

> `threshold` int
> in The decision threshold, from 0 to 653535, to be applied during the face comparison on the smart card. See FaceMatcherThreshold for a list of typical values.
> `reference_data_qualifier` int
> in Reference data qualifier.

Returns

> `bytearray`
> A buffer that receives the biometric information template.

Exceptions

> FaceException
> An error has occurred during Face Library execution.

Dart

    Uint8List toBit(int threshold, int referenceDataQualifier)

Parameters

> `threshold` int
> in The decision threshold, from 0 to 653535, to be applied during the face comparison on the smart card. See FaceMatcherThreshold for a list of typical values.
> `referenceDataQualifier` int
> in Reference data qualifier.

Returns

> `Uint8List`
> A buffer that receives the biometric information template.

Exceptions

> FaceException
> An error has occurred during Face Library execution.

C#

    public byte[] ToBit(int threshold, int referenceDataQualifier)

Parameters

> `threshold` int
> in The decision threshold, from 0 to 653535, to be applied during the face comparison on the smart card. See FaceMatcherThreshold for a list of typical values.
> `referenceDataQualifier` int
> in Reference data qualifier.

Returns

> `byte[]`
> A buffer that receives the biometric information template.

Exceptions

> FaceException
> An error has occurred during Face Library execution.

Java

    public byte[] toBit(int threshold, int referenceDataQualifier) throws FaceException

Parameters

> `threshold` int
> in The decision threshold, from 0 to 653535, to be applied during the face comparison on the smart card. See FaceMatcherThreshold for a list of typical values.
> `referenceDataQualifier` int
> in Reference data qualifier.

Returns

> `byte[]`
> A buffer that receives the biometric information template.

Exceptions

> FaceException
> An error has occurred during Face Library execution.

Swift

    public func toBit(threshold: Int32, referenceDataQualifier: Int32) throws -> [UInt8]

Parameters

> `threshold` Int32
> in The decision threshold, from 0 to 653535, to be applied during the face comparison on the smart card. See FaceMatcherThreshold for a list of typical values.
> `referenceDataQualifier` Int32
> in Reference data qualifier.

Returns

> `[UInt8]`
> A buffer that receives the biometric information template.

Exceptions

> FaceException
> An error has occurred during Face Library execution.

C

    int id3FaceTemplate_ToBit (
        ID3_FACE_TEMPLATE hFaceTemplate,
        int threshold,
        int referenceDataQualifier,
        unsigned char * data,
        int * dataSize)

Parameters

> `hFaceTemplate` ID3_FACE_TEMPLATE
> in Handle to the FaceTemplate object.
> `threshold` int
> in The decision threshold, from 0 to 653535, to be applied during the face comparison on the smart card. See FaceMatcherThreshold for a list of typical values.
> `referenceDataQualifier` int
> in Reference data qualifier.
> `data` unsigned char *
> out A buffer that receives the biometric information template.
> `dataSize` int *
> in Size of the ‘data’ buffer. Receives the number of elements in the ‘data’ array.

Returns

> `int`
> An error code.
> See id3FaceError file for the list of possible error codes.