FingerIndexer.searchFromEmbedding Method

Module: FingerIndexer

Definition

Internal function

search_from_embedding(self, template_record: FingerTemplateRecord, max_candidates: int, trust_filled_positions: bool) -> FingerCandidateList

Parameters

template_record FingerTemplateRecord
in The probe finger template 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 searchFromEmbedding(FingerTemplateRecord templateRecord, int maxCandidates, bool trustFilledPositions)

Parameters

templateRecord FingerTemplateRecord
in The probe finger template 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 SearchFromEmbedding(FingerTemplateRecord templateRecord, int maxCandidates, bool trustFilledPositions)

Parameters

templateRecord FingerTemplateRecord
in The probe finger template 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 searchFromEmbedding(FingerTemplateRecord templateRecord, int maxCandidates, boolean trustFilledPositions) throws FingerException

Parameters

templateRecord FingerTemplateRecord
in The probe finger template 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 searchFromEmbedding(templateRecord: FingerTemplateRecord, maxCandidates: Int32, trustFilledPositions: Bool) throws -> FingerCandidateList

Parameters

templateRecord FingerTemplateRecord
in The probe finger template 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_SearchFromEmbedding (
    ID3_FINGER_INDEXER hFingerIndexer,
    ID3_FINGER_TEMPLATE_RECORD hTemplateRecord,
    int maxCandidates,
    bool trustFilledPositions,
    ID3_FINGER_CANDIDATE_LIST hCandidates)

Parameters

hFingerIndexer ID3_FINGER_INDEXER
in Handle to the FingerIndexer object.

hTemplateRecord ID3_FINGER_TEMPLATE_RECORD
in The probe finger template 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.