Class FaceDetectorYN

Namespace

OpenCvSharp

Assembly

OpenCvSharp.dll

DNN-based face detector

public class FaceDetectorYN : DisposableCvObject, IDisposable, ICvPtrHolder

Inheritance

object

DisposableObject

DisposableCvObject

FaceDetectorYN

Implements

IDisposable

ICvPtrHolder

Inherited Members

DisposableCvObject.ptr

DisposableCvObject.DisposeUnmanaged()

DisposableCvObject.CvPtr

DisposableObject.DataHandle

DisposableObject.IsDisposed

DisposableObject.IsEnabledDispose

DisposableObject.AllocatedMemory

DisposableObject.AllocatedMemorySize

DisposableObject.Dispose()

DisposableObject.Dispose(bool)

DisposableObject.AllocGCHandle(object)

DisposableObject.AllocMemory(int)

DisposableObject.NotifyMemoryPressure(long)

DisposableObject.ThrowIfDisposed()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

FaceDetectorYN(nint)

Creates instance by raw pointer cv::FaceDetectorYN*

protected FaceDetectorYN(nint p)

Parameters

p nint

Methods

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

Creates an instance of this class with given parameters.

public static FaceDetectorYN Create(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 compatibility, 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

Returns

FaceDetectorYN

Detect(Mat, Mat)

A simple interface to detect face from given image.

public int Detect(Mat image, Mat faces)

Parameters

image Mat

An image to detect

faces Mat

Detection results stored in a Mat

Returns

int

1 if detection is successful, 0 otherwise.

DisposeManaged()

Releases managed resources

protected override void DisposeManaged()