FingerTemplate.toBit Method

Module: FingerTemplate

Definition

Exports the finger template object to a Biometric Information Template (BIT) buffer.

This buffer can only be used with id3 Finger Match-on-Card specific implementations to enroll a finger template.

Threshold value is required and should be set according to the desired security level. Threshold values are specific and can be found in the id3 finger Match-On-Card documentation.

Rotation tolerance defines the maximum rotation allowed between two finger templates in degrees. The operational range is from 17 to 180 degrees. Any value outside this range is automatically adjusted to the limits. Recommended value is 42 degrees.

Important

Reference data qualifier should be set according to the smart card requirements.

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

Parameters

threshold int
in Decision threshold, from 0 to 65535, to be applied during the fingerprint on-card comparison. See MocThreshold for a list of typical values.

angle_tolerance int
in Tolerance on the difference in angle, in degrees, between two compared fingerprints. Note that higher values may tend to increase comparison times. Minimum value is 12°, default value is 42°, maximum value is 180°.

reference_data_qualifier int
in Reference data qualifier.

Returns

bytearray
A buffer that receives the biometric information template.

Exceptions

FingerException
An error has occurred during Finger Library execution.
Uint8List toBit(int threshold, int angleTolerance, int referenceDataQualifier)

Parameters

threshold int
in Decision threshold, from 0 to 65535, to be applied during the fingerprint on-card comparison. See MocThreshold for a list of typical values.

angleTolerance int
in Tolerance on the difference in angle, in degrees, between two compared fingerprints. Note that higher values may tend to increase comparison times. Minimum value is 12°, default value is 42°, maximum value is 180°.

referenceDataQualifier int
in Reference data qualifier.

Returns

Uint8List
A buffer that receives the biometric information template.

Exceptions

FingerException
An error has occurred during Finger Library execution.
public byte[] ToBit(int threshold, int angleTolerance, int referenceDataQualifier)

Parameters

threshold int
in Decision threshold, from 0 to 65535, to be applied during the fingerprint on-card comparison. See MocThreshold for a list of typical values.

angleTolerance int
in Tolerance on the difference in angle, in degrees, between two compared fingerprints. Note that higher values may tend to increase comparison times. Minimum value is 12°, default value is 42°, maximum value is 180°.

referenceDataQualifier int
in Reference data qualifier.

Returns

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

Exceptions

FingerException
An error has occurred during Finger Library execution.
public byte[] toBit(int threshold, int angleTolerance, int referenceDataQualifier) throws FingerException

Parameters

threshold int
in Decision threshold, from 0 to 65535, to be applied during the fingerprint on-card comparison. See MocThreshold for a list of typical values.

angleTolerance int
in Tolerance on the difference in angle, in degrees, between two compared fingerprints. Note that higher values may tend to increase comparison times. Minimum value is 12°, default value is 42°, maximum value is 180°.

referenceDataQualifier int
in Reference data qualifier.

Returns

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

Exceptions

FingerException
An error has occurred during Finger Library execution.
public func toBit(threshold: Int32, angleTolerance: Int32, referenceDataQualifier: Int32) throws -> [UInt8]

Parameters

threshold Int32
in Decision threshold, from 0 to 65535, to be applied during the fingerprint on-card comparison. See MocThreshold for a list of typical values.

angleTolerance Int32
in Tolerance on the difference in angle, in degrees, between two compared fingerprints. Note that higher values may tend to increase comparison times. Minimum value is 12°, default value is 42°, maximum value is 180°.

referenceDataQualifier Int32
in Reference data qualifier.

Returns

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

Exceptions

FingerException
An error has occurred during Finger Library execution.
int id3FingerTemplate_ToBit (
    ID3_FINGER_TEMPLATE hFingerTemplate,
    int threshold,
    int angleTolerance,
    int referenceDataQualifier,
    unsigned char * data,
    int * dataSize)

Parameters

hFingerTemplate ID3_FINGER_TEMPLATE
in Handle to the FingerTemplate object.

threshold int
in Decision threshold, from 0 to 65535, to be applied during the fingerprint on-card comparison. See MocThreshold for a list of typical values.

angleTolerance int
in Tolerance on the difference in angle, in degrees, between two compared fingerprints. Note that higher values may tend to increase comparison times. Minimum value is 12°, default value is 42°, maximum value is 180°.

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 id3FingerError file for the list of possible error codes.