Class FaceDetectorYN

Namespace

Emgu.CV

Assembly

Emgu.CV.dll

DNN-based face detector

public class FaceDetectorYN : SharedPtrObject, IDisposable

Inheritance

object

DisposableObject

UnmanagedObject

SharedPtrObject

FaceDetectorYN

Implements

IDisposable

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

FaceDetectorYN(string, string, Size, float, float, int, Backend, Target)

Creates an instance of this class with given parameters.

public FaceDetectorYN(string model, string config, Size inputSize, float scoreThreshold = 0.9, float nmsThreshold = 0.3, int topK = 5000, Backend backendId = Backend.Default, Target targetId = Target.Cpu)

Parameters

model string

The path to the requested model

config string

The path to the config file for compability, which is not requested for ONNX models

inputSize Size

The size of the input image

scoreThreshold float

The threshold to filter out bounding boxes of score smaller than the given value

nmsThreshold float

The threshold to suppress bounding boxes of IoU bigger than the given value

topK int

Keep top K bboxes before NMS

backendId Backend

The id of backend

targetId Target

The id of target device

Properties

InputSize

The size for the network input, which overwrites the input size of creating model.

public Size InputSize { get; set; }

Property Value

Size

Methods

Detect(IInputArray, IOutputArray)

A simple interface to detect face from given image.

public int Detect(IInputArray image, IOutputArray faces)

Parameters

image IInputArray

An image to detect

faces IOutputArray

Detection results stored in a Mat

Returns

int

1 if detection is successful, 0 otherwise.

DisposeObject()

Release the unmanaged memory associated with this FaceDetectorYN

protected override void DisposeObject()

SetNMSThreshold(float)

The Non-maximum-suppression threshold to suppress bounding boxes that have IoU greater than the given value

public void SetNMSThreshold(float value)

Parameters

value float

The value

SetScoreThreshold(float)

The score threshold to filter out bounding boxes of score less than the given value

public void SetScoreThreshold(float value)

Parameters

value float

The value

SetTopK(int)

The number of bounding boxes to preserve from top rank based on score

public void SetTopK(int value)

Parameters

value int

The value