FaceTemplateDiagnostics

public class FaceTemplateDiagnostics

Face template diagnostic utility

Since

2.5.0

  • Ver-ID instance used for face comparisons and user management

    Declaration

    Swift

    public let verID: VerID

  • Constructor

    Declaration

    Swift

    public init(verID: VerID)

    Parameters

    verID

    Ver-ID instance used for face comparisons and user management

  • Compare all registered face templates to each other

    Since

    2.5.0

    Declaration

    Swift

    public func compareRegisteredFaceTemplates(hashUserNames: Bool = true, completion: @escaping (Result<[VerIDFaceTemplateVersion : [UserFaceComparison]], Error>) -> Void)

    Parameters

    hashUserNames

    If true the user names in the result will be hashes using SHA 256 algorithm to preserve privacy
    completion

    Completion callback

  • Compare all user face templates to each other

    Since

    2.5.0

    Declaration

    Swift

    public func compareUserFaceTemplates(_ userFaceTemplates: [String : [Recognizable]], completion: @escaping (Result<[VerIDFaceTemplateVersion : [UserFaceComparison]], Error>) -> Void)

    Parameters

    userFaceTemplates

    Map of user IDs and face template arrays
    completion

    Completion callback

  • Compare all face templates in a given array to each other

    Note

    All supplied templates must have the same version

    Since

    2.5.0

    Declaration

    Swift

    public func compareFaceTemplates(_ templates: [Recognizable], completion: @escaping (Result<[(Recognizable, Recognizable, Float)], Error>) -> Void)

    Parameters

    templates

    Face templates to compare
    completion

    Completion callback

  • Find registered users with the most similar faces

    Since

    2.5.0

    Declaration

    Swift

    public func findMostSimilarUsers(hashUserNames: Bool = true, completion: @escaping (Result<[VerIDFaceTemplateVersion : UserFaceComparison], Error>) -> Void)

    Parameters

    hashUserNames

    If true user names will be hashed using SHA 256 algorithm to preserve privacy
    completion

    Completion callback

  • Find registered users with the most different faces

    Since

    2.5.0

    Declaration

    Swift

    public func findMostDifferentUsers(hashUserNames: Bool = true, completion: @escaping (Result<[VerIDFaceTemplateVersion : UserFaceComparison], Error>) -> Void)

    Parameters

    hashUserNames

    If true user names will be hashed using SHA 256 algorithm to preserve privacy
    completion

    Completion callback

  • Find most similar users among the given comparison pairs

    Since

    2.5.0

    Declaration

    Swift

    public func findMostSimilarUsers(in comparisons: [UserFaceComparison]) -> UserFaceComparison?

    Parameters

    comparisons

    Comparison pairs

    Return Value

    The most similar user pair

  • Find most different users among the given comparison pairs

    Since

    2.5.0

    Declaration

    Swift

    public func findMostDifferentUsers(in comparisons: [UserFaceComparison]) -> UserFaceComparison?

    Parameters

    comparisons

    Comparison pairs

    Return Value

    The most different user pair