Class FaceRecognizerSF

DNN-based face recognizer

public class FaceRecognizerSF : SharedPtrObject, IDisposable

Inheritance: object

DisposableObject

UnmanagedObject

SharedPtrObject

FaceRecognizerSF

Inherited Members: SharedPtrObject._sharedPtr

SharedPtrObject.SharedPtr

UnmanagedObject._ptr

UnmanagedObject.Ptr

DisposableObject.Dispose()

DisposableObject.ReleaseManagedResources()

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

Creates an instance of this class with given parameters.

public FaceRecognizerSF(string model, string config, Backend backendId, Target targetId)

model string: The path of the onnx model used for face recognition
config string: The path to the config file for compability, which is not requested for ONNX models
backendId Backend: The id of backend
targetId Target: The id of target device

Aligning image to put face on the standard position.

public void AlignCrop(IInputArray srcImg, IInputArray faceBox, IOutputArray alignedImg)

srcImg IInputArray: Input image
faceBox IInputArray: The detection result used for indicate face in input image
alignedImg IOutputArray: Output aligned image

Release the unmanaged memory associated with this FaceRecognizerSF

protected override void DisposeObject()

Extracting face feature from aligned image.

public void Feature(IInputArray alignedImg, IOutputArray faceFeature)

Calculating the distance between two face features.

public double Match(IInputArray faceFeature1, IInputArray faceFeature2, FaceRecognizerSF.DisType disType = DisType.Cosine)

faceFeature1 IInputArray: The first input feature
faceFeature2 IInputArray: The second input feature of the same size and the same type as faceFeature1
disType FaceRecognizerSF.DisType: Defining the similarity with optional values