FingerMatcher.search Method

Module: FingerMatcher

Definition

Search of a probe candidate against a small number of reference candidates.

This function is the fine-grain step search of the FingerIndexer.

search(self, probe_template_record: FingerTemplateRecord, candidates: FingerCandidateList, trust_filled_positions: bool) -> FingerCandidateList

Parameters

probe_template_record FingerTemplateRecord
in Probe template record to search in the candidate list

candidates FingerCandidateList
in List of candidates with the TemplateRecord set for each candidate.

trust_filled_positions bool
in If True, template(s) of one position in candidates will be compared only to the templates of the same position in probe. If False, all templates in candidates will be compared to all templates in probe.

Returns

FingerCandidateList
Output candidate list with sorted candidates and matching scores.

Exceptions

FingerException
An error has occurred during Finger Library execution.
FingerCandidateList search(FingerTemplateRecord probeTemplateRecord, FingerCandidateList candidates, bool trustFilledPositions)

Parameters

probeTemplateRecord FingerTemplateRecord
in Probe template record to search in the candidate list

candidates FingerCandidateList
in List of candidates with the TemplateRecord set for each candidate.

trustFilledPositions bool
in If True, template(s) of one position in candidates will be compared only to the templates of the same position in probe. If False, all templates in candidates will be compared to all templates in probe.

Returns

FingerCandidateList
Output candidate list with sorted candidates and matching scores.

Exceptions

FingerException
An error has occurred during Finger Library execution.
public FingerCandidateList Search(FingerTemplateRecord probeTemplateRecord, FingerCandidateList candidates, bool trustFilledPositions)

Parameters

probeTemplateRecord FingerTemplateRecord
in Probe template record to search in the candidate list

candidates FingerCandidateList
in List of candidates with the TemplateRecord set for each candidate.

trustFilledPositions bool
in If True, template(s) of one position in candidates will be compared only to the templates of the same position in probe. If False, all templates in candidates will be compared to all templates in probe.

Returns

FingerCandidateList
Output candidate list with sorted candidates and matching scores.

Exceptions

FingerException
An error has occurred during Finger Library execution.
public FingerCandidateList search(FingerTemplateRecord probeTemplateRecord, FingerCandidateList candidates, boolean trustFilledPositions) throws FingerException

Parameters

probeTemplateRecord FingerTemplateRecord
in Probe template record to search in the candidate list

candidates FingerCandidateList
in List of candidates with the TemplateRecord set for each candidate.

trustFilledPositions boolean
in If True, template(s) of one position in candidates will be compared only to the templates of the same position in probe. If False, all templates in candidates will be compared to all templates in probe.

Returns

FingerCandidateList
Output candidate list with sorted candidates and matching scores.

Exceptions

FingerException
An error has occurred during Finger Library execution.
public func search(probeTemplateRecord: FingerTemplateRecord, candidates: FingerCandidateList, trustFilledPositions: Bool) throws -> FingerCandidateList

Parameters

probeTemplateRecord FingerTemplateRecord
in Probe template record to search in the candidate list

candidates FingerCandidateList
in List of candidates with the TemplateRecord set for each candidate.

trustFilledPositions Bool
in If True, template(s) of one position in candidates will be compared only to the templates of the same position in probe. If False, all templates in candidates will be compared to all templates in probe.

Returns

FingerCandidateList
Output candidate list with sorted candidates and matching scores.

Exceptions

FingerException
An error has occurred during Finger Library execution.
int id3FingerMatcher_Search (
    ID3_FINGER_MATCHER hFingerMatcher,
    ID3_FINGER_TEMPLATE_RECORD hProbeTemplateRecord,
    ID3_FINGER_CANDIDATE_LIST hCandidates,
    bool trustFilledPositions,
    ID3_FINGER_CANDIDATE_LIST hSortedCandidates)

Parameters

hFingerMatcher ID3_FINGER_MATCHER
in Handle to the FingerMatcher object.

hProbeTemplateRecord ID3_FINGER_TEMPLATE_RECORD
in Probe template record to search in the candidate list

hCandidates ID3_FINGER_CANDIDATE_LIST
in List of candidates with the TemplateRecord set for each candidate.

trustFilledPositions bool
in If True, template(s) of one position in candidates will be compared only to the templates of the same position in probe. If False, all templates in candidates will be compared to all templates in probe.

hSortedCandidates ID3_FINGER_CANDIDATE_LIST
out Output candidate list with sorted candidates and matching scores.

Returns

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