FaceMatcher.searchTemplate Method

Module: FaceMatcher

Definition

Performs a one-to-many search of a biometric probe against a previously initialized dictionary of biometric references and outputs a candidate list.

search_template(self, reference_dict: FaceTemplateDict, probe: FaceTemplate, max_candidates: int, candidate_list: FaceCandidateList) -> None

Parameters

reference_dict FaceTemplateDict
in Reference template dictionary.

probe FaceTemplate
in Probe template.

max_candidates int
in Maximum number of candidates to output.

candidate_list FaceCandidateList
in List of candidates sorted by decreasing match score.

Exceptions

FaceException
An error has occurred during Face Library execution.
void searchTemplate(FaceTemplateDict referenceDict, FaceTemplate probe, int maxCandidates, FaceCandidateList candidateList)

Parameters

referenceDict FaceTemplateDict
in Reference template dictionary.

probe FaceTemplate
in Probe template.

maxCandidates int
in Maximum number of candidates to output.

candidateList FaceCandidateList
in List of candidates sorted by decreasing match score.

Exceptions

FaceException
An error has occurred during Face Library execution.
public void SearchTemplate(FaceTemplateDict referenceDict, FaceTemplate probe, int maxCandidates, FaceCandidateList candidateList)

Parameters

referenceDict FaceTemplateDict
in Reference template dictionary.

probe FaceTemplate
in Probe template.

maxCandidates int
in Maximum number of candidates to output.

candidateList FaceCandidateList
in List of candidates sorted by decreasing match score.

Exceptions

FaceException
An error has occurred during Face Library execution.
public void searchTemplate(FaceTemplateDict referenceDict, FaceTemplate probe, int maxCandidates, FaceCandidateList candidateList) throws FaceException

Parameters

referenceDict FaceTemplateDict
in Reference template dictionary.

probe FaceTemplate
in Probe template.

maxCandidates int
in Maximum number of candidates to output.

candidateList FaceCandidateList
in List of candidates sorted by decreasing match score.

Exceptions

FaceException
An error has occurred during Face Library execution.
public func searchTemplate(referenceDict: FaceTemplateDict, probe: FaceTemplate, maxCandidates: Int32, candidateList: FaceCandidateList) throws

Parameters

referenceDict FaceTemplateDict
in Reference template dictionary.

probe FaceTemplate
in Probe template.

maxCandidates Int32
in Maximum number of candidates to output.

candidateList FaceCandidateList
in List of candidates sorted by decreasing match score.

Exceptions

FaceException
An error has occurred during Face Library execution.
int id3FaceMatcher_SearchTemplate (
    ID3_FACE_MATCHER hFaceMatcher,
    ID3_FACE_TEMPLATE_DICT hReferenceDict,
    ID3_FACE_TEMPLATE hProbe,
    int maxCandidates,
    ID3_FACE_CANDIDATE_LIST hCandidateList)

Parameters

hFaceMatcher ID3_FACE_MATCHER
in Handle to the FaceMatcher object.

hReferenceDict ID3_FACE_TEMPLATE_DICT
in Reference template dictionary.

hProbe ID3_FACE_TEMPLATE
in Probe template.

maxCandidates int
in Maximum number of candidates to output.

hCandidateList ID3_FACE_CANDIDATE_LIST
in List of candidates sorted by decreasing match score.

Returns

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