FingerMatcher.compareTemplateRecordsInDetails Method

Module: FingerMatcher

Definition

Compares two template records and outputs a list of match details.

compare_template_records_in_details(self, reference_record: FingerTemplateRecord, probe_record: FingerTemplateRecord, trust_filled_positions: bool) -> FingerMatchDetailsList

Parameters

reference_record FingerTemplateRecord
in Reference template record.

probe_record FingerTemplateRecord
in Probe template record.

trust_filled_positions bool
in If True, template(s) of one position in reference will be compared only to the templates of the same position in probe. If False, all templates in reference will be compared to all templates in probe (this method is also known as ‘flat’ comparison).

Returns

FingerMatchDetailsList
Finger match details list associated to this comparison. This list can be pooled to output a unique score if necessary, see FingerMatchDetails functions for that.

Exceptions

FingerException
An error has occurred during Finger Library execution.
FingerMatchDetailsList compareTemplateRecordsInDetails(FingerTemplateRecord referenceRecord, FingerTemplateRecord probeRecord, bool trustFilledPositions)

Parameters

referenceRecord FingerTemplateRecord
in Reference template record.

probeRecord FingerTemplateRecord
in Probe template record.

trustFilledPositions bool
in If True, template(s) of one position in reference will be compared only to the templates of the same position in probe. If False, all templates in reference will be compared to all templates in probe (this method is also known as ‘flat’ comparison).

Returns

FingerMatchDetailsList
Finger match details list associated to this comparison. This list can be pooled to output a unique score if necessary, see FingerMatchDetails functions for that.

Exceptions

FingerException
An error has occurred during Finger Library execution.
public FingerMatchDetailsList CompareTemplateRecordsInDetails(FingerTemplateRecord referenceRecord, FingerTemplateRecord probeRecord, bool trustFilledPositions)

Parameters

referenceRecord FingerTemplateRecord
in Reference template record.

probeRecord FingerTemplateRecord
in Probe template record.

trustFilledPositions bool
in If True, template(s) of one position in reference will be compared only to the templates of the same position in probe. If False, all templates in reference will be compared to all templates in probe (this method is also known as ‘flat’ comparison).

Returns

FingerMatchDetailsList
Finger match details list associated to this comparison. This list can be pooled to output a unique score if necessary, see FingerMatchDetails functions for that.

Exceptions

FingerException
An error has occurred during Finger Library execution.
public FingerMatchDetailsList compareTemplateRecordsInDetails(FingerTemplateRecord referenceRecord, FingerTemplateRecord probeRecord, boolean trustFilledPositions) throws FingerException

Parameters

referenceRecord FingerTemplateRecord
in Reference template record.

probeRecord FingerTemplateRecord
in Probe template record.

trustFilledPositions boolean
in If True, template(s) of one position in reference will be compared only to the templates of the same position in probe. If False, all templates in reference will be compared to all templates in probe (this method is also known as ‘flat’ comparison).

Returns

FingerMatchDetailsList
Finger match details list associated to this comparison. This list can be pooled to output a unique score if necessary, see FingerMatchDetails functions for that.

Exceptions

FingerException
An error has occurred during Finger Library execution.
public func compareTemplateRecordsInDetails(referenceRecord: FingerTemplateRecord, probeRecord: FingerTemplateRecord, trustFilledPositions: Bool) throws -> FingerMatchDetailsList

Parameters

referenceRecord FingerTemplateRecord
in Reference template record.

probeRecord FingerTemplateRecord
in Probe template record.

trustFilledPositions Bool
in If True, template(s) of one position in reference will be compared only to the templates of the same position in probe. If False, all templates in reference will be compared to all templates in probe (this method is also known as ‘flat’ comparison).

Returns

FingerMatchDetailsList
Finger match details list associated to this comparison. This list can be pooled to output a unique score if necessary, see FingerMatchDetails functions for that.

Exceptions

FingerException
An error has occurred during Finger Library execution.
int id3FingerMatcher_CompareTemplateRecordsInDetails (
    ID3_FINGER_MATCHER hFingerMatcher,
    ID3_FINGER_TEMPLATE_RECORD hReferenceRecord,
    ID3_FINGER_TEMPLATE_RECORD hProbeRecord,
    bool trustFilledPositions,
    ID3_FINGER_MATCH_DETAILS_LIST hMatchDetailsList)

Parameters

hFingerMatcher ID3_FINGER_MATCHER
in Handle to the FingerMatcher object.

hReferenceRecord ID3_FINGER_TEMPLATE_RECORD
in Reference template record.

hProbeRecord ID3_FINGER_TEMPLATE_RECORD
in Probe template record.

trustFilledPositions bool
in If True, template(s) of one position in reference will be compared only to the templates of the same position in probe. If False, all templates in reference will be compared to all templates in probe (this method is also known as ‘flat’ comparison).

hMatchDetailsList ID3_FINGER_MATCH_DETAILS_LIST
out Finger match details list associated to this comparison. This list can be pooled to output a unique score if necessary, see FingerMatchDetails functions for that.

Returns

int
An error code.
See id3FingerError file for the list of possible error codes.