FingerIndexer.search Method

Module: FingerIndexer

Definition

Performs a one-to-many search of a probe image template record against a previously initialized finger indexer and outputs a candidate list.

Note

This function is thread safe with other Search() calls but not with Add() calls.

search(self, image_record: FingerImageRecord, max_candidates: int, trust_filled_positions: bool) -> FingerCandidateList

Parameters

image_record FingerImageRecord
in The probe finger image record.

max_candidates int
in Maximum candidates count in the retrieved candidate list.

trust_filled_positions bool
in If False, search does not trust the TemplateRecord positions : each query template is searched across all different positions. If True, each query template is only search against templates of its position.

Returns

FingerCandidateList
List of candidates sorted by decreasing match score.

Exceptions

FingerException
An error has occurred during Finger Library execution.
FingerCandidateList search(FingerImageRecord imageRecord, int maxCandidates, bool trustFilledPositions)

Parameters

imageRecord FingerImageRecord
in The probe finger image record.

maxCandidates int
in Maximum candidates count in the retrieved candidate list.

trustFilledPositions bool
in If False, search does not trust the TemplateRecord positions : each query template is searched across all different positions. If True, each query template is only search against templates of its position.

Returns

FingerCandidateList
List of candidates sorted by decreasing match score.

Exceptions

FingerException
An error has occurred during Finger Library execution.
public FingerCandidateList Search(FingerImageRecord imageRecord, int maxCandidates, bool trustFilledPositions)

Parameters

imageRecord FingerImageRecord
in The probe finger image record.

maxCandidates int
in Maximum candidates count in the retrieved candidate list.

trustFilledPositions bool
in If False, search does not trust the TemplateRecord positions : each query template is searched across all different positions. If True, each query template is only search against templates of its position.

Returns

FingerCandidateList
List of candidates sorted by decreasing match score.

Exceptions

FingerException
An error has occurred during Finger Library execution.
public FingerCandidateList search(FingerImageRecord imageRecord, int maxCandidates, boolean trustFilledPositions) throws FingerException

Parameters

imageRecord FingerImageRecord
in The probe finger image record.

maxCandidates int
in Maximum candidates count in the retrieved candidate list.

trustFilledPositions boolean
in If False, search does not trust the TemplateRecord positions : each query template is searched across all different positions. If True, each query template is only search against templates of its position.

Returns

FingerCandidateList
List of candidates sorted by decreasing match score.

Exceptions

FingerException
An error has occurred during Finger Library execution.
public func search(imageRecord: FingerImageRecord, maxCandidates: Int32, trustFilledPositions: Bool) throws -> FingerCandidateList

Parameters

imageRecord FingerImageRecord
in The probe finger image record.

maxCandidates Int32
in Maximum candidates count in the retrieved candidate list.

trustFilledPositions Bool
in If False, search does not trust the TemplateRecord positions : each query template is searched across all different positions. If True, each query template is only search against templates of its position.

Returns

FingerCandidateList
List of candidates sorted by decreasing match score.

Exceptions

FingerException
An error has occurred during Finger Library execution.
int id3FingerIndexer_Search (
    ID3_FINGER_INDEXER hFingerIndexer,
    ID3_FINGER_IMAGE_RECORD hImageRecord,
    int maxCandidates,
    bool trustFilledPositions,
    ID3_FINGER_CANDIDATE_LIST hCandidates)

Parameters

hFingerIndexer ID3_FINGER_INDEXER
in Handle to the FingerIndexer object.

hImageRecord ID3_FINGER_IMAGE_RECORD
in The probe finger image record.

maxCandidates int
in Maximum candidates count in the retrieved candidate list.

trustFilledPositions bool
in If False, search does not trust the TemplateRecord positions : each query template is searched across all different positions. If True, each query template is only search against templates of its position.

hCandidates ID3_FINGER_CANDIDATE_LIST
out List of candidates sorted by decreasing match score.

Returns

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