OpenCVForUnity.ObjdetectModule.FaceDetectorYN Class Reference

DNN-based face detector. More...

Inheritance diagram for OpenCVForUnity.ObjdetectModule.FaceDetectorYN:

Public Member Functions
IntPtr	getNativeObjAddr ()
void	setInputSize (Size input_size)
	Set the size for the network input, which overwrites the input size of creating model. Call this method when the size of input image does not match the input size when creating model. More...
Size	getInputSize ()
void	setScoreThreshold (float score_threshold)
	Set the score threshold to filter out bounding boxes of score less than the given value. More...
float	getScoreThreshold ()
void	setNMSThreshold (float nms_threshold)
	Set the Non-maximum-suppression threshold to suppress bounding boxes that have IoU greater than the given value. More...
float	getNMSThreshold ()
void	setTopK (int top_k)
	Set the number of bounding boxes preserved before NMS. More...
int	getTopK ()
int	detect (Mat image, Mat faces)
	Detects faces in the input image. Following is an example output. More...
Public Member Functions inherited from OpenCVForUnity.DisposableObject
void	Dispose ()
void	ThrowIfDisposed ()

Static Public Member Functions
static FaceDetectorYN	__fromPtr__ (IntPtr addr)
static FaceDetectorYN	create (string model, string config, Size input_size, float score_threshold, float nms_threshold, int top_k, int backend_id, int target_id)
	Creates an instance of face detector class with given parameters. More...
static FaceDetectorYN	create (string model, string config, Size input_size, float score_threshold, float nms_threshold, int top_k, int backend_id)
	Creates an instance of face detector class with given parameters. More...
static FaceDetectorYN	create (string model, string config, Size input_size, float score_threshold, float nms_threshold, int top_k)
	Creates an instance of face detector class with given parameters. More...
static FaceDetectorYN	create (string model, string config, Size input_size, float score_threshold, float nms_threshold)
	Creates an instance of face detector class with given parameters. More...
static FaceDetectorYN	create (string model, string config, Size input_size, float score_threshold)
	Creates an instance of face detector class with given parameters. More...
static FaceDetectorYN	create (string model, string config, Size input_size)
	Creates an instance of face detector class with given parameters. More...
static FaceDetectorYN	create (string framework, MatOfByte bufferModel, MatOfByte bufferConfig, Size input_size, float score_threshold, float nms_threshold, int top_k, int backend_id, int target_id)
static FaceDetectorYN	create (string framework, MatOfByte bufferModel, MatOfByte bufferConfig, Size input_size, float score_threshold, float nms_threshold, int top_k, int backend_id)
static FaceDetectorYN	create (string framework, MatOfByte bufferModel, MatOfByte bufferConfig, Size input_size, float score_threshold, float nms_threshold, int top_k)
static FaceDetectorYN	create (string framework, MatOfByte bufferModel, MatOfByte bufferConfig, Size input_size, float score_threshold, float nms_threshold)
static FaceDetectorYN	create (string framework, MatOfByte bufferModel, MatOfByte bufferConfig, Size input_size, float score_threshold)
static FaceDetectorYN	create (string framework, MatOfByte bufferModel, MatOfByte bufferConfig, Size input_size)
Static Public Member Functions inherited from OpenCVForUnity.DisposableObject
static IntPtr	ThrowIfNullIntPtr (IntPtr ptr)

Protected Member Functions
override void	Dispose (bool disposing)
Protected Member Functions inherited from OpenCVForUnity.DisposableOpenCVObject
	DisposableOpenCVObject ()
	DisposableOpenCVObject (IntPtr ptr)
	DisposableOpenCVObject (bool isEnabledDispose)
	DisposableOpenCVObject (IntPtr ptr, bool isEnabledDispose)
Protected Member Functions inherited from OpenCVForUnity.DisposableObject
	DisposableObject ()
	DisposableObject (bool isEnabledDispose)

Additional Inherited Members
Properties inherited from OpenCVForUnity.DisposableObject
bool	IsDisposed [get, protected set]
bool	IsEnabledDispose [get, set]

Detailed Description

DNN-based face detector.

model download link: https://github.com/opencv/opencv_zoo/tree/master/models/face_detection_yunet

Member Function Documentation

__fromPtr__()

static FaceDetectorYN OpenCVForUnity.ObjdetectModule.FaceDetectorYN.__fromPtr__ ( IntPtr  addr )

static

create() [1/12]

static FaceDetectorYN OpenCVForUnity.ObjdetectModule.FaceDetectorYN.create ( string  model, string  config, Size  input_size, float  score_threshold, float  nms_threshold, int  top_k, int  backend_id, int  target_id  )

static

Creates an instance of face detector class with given parameters.

Parameters

model	the path to the requested model
config	the path to the config file for compability, which is not requested for ONNX models
input_size	the size of the input image
score_threshold	the threshold to filter out bounding boxes of score smaller than the given value
nms_threshold	the threshold to suppress bounding boxes of IoU bigger than the given value
top_k	keep top K bboxes before NMS
backend_id	the id of backend
target_id	the id of target device

create() [2/12]

static FaceDetectorYN OpenCVForUnity.ObjdetectModule.FaceDetectorYN.create ( string  model, string  config, Size  input_size, float  score_threshold, float  nms_threshold, int  top_k, int  backend_id  )

static

Creates an instance of face detector class with given parameters.

Parameters

model	the path to the requested model
config	the path to the config file for compability, which is not requested for ONNX models
input_size	the size of the input image
score_threshold	the threshold to filter out bounding boxes of score smaller than the given value
nms_threshold	the threshold to suppress bounding boxes of IoU bigger than the given value
top_k	keep top K bboxes before NMS
backend_id	the id of backend
target_id	the id of target device

create() [3/12]

static FaceDetectorYN OpenCVForUnity.ObjdetectModule.FaceDetectorYN.create ( string  model, string  config, Size  input_size, float  score_threshold, float  nms_threshold, int  top_k  )

static

Creates an instance of face detector class with given parameters.

Parameters

model	the path to the requested model
config	the path to the config file for compability, which is not requested for ONNX models
input_size	the size of the input image
score_threshold	the threshold to filter out bounding boxes of score smaller than the given value
nms_threshold	the threshold to suppress bounding boxes of IoU bigger than the given value
top_k	keep top K bboxes before NMS
backend_id	the id of backend
target_id	the id of target device

create() [4/12]

static FaceDetectorYN OpenCVForUnity.ObjdetectModule.FaceDetectorYN.create ( string  model, string  config, Size  input_size, float  score_threshold, float  nms_threshold  )

static

Creates an instance of face detector class with given parameters.

Parameters

model	the path to the requested model
config	the path to the config file for compability, which is not requested for ONNX models
input_size	the size of the input image
score_threshold	the threshold to filter out bounding boxes of score smaller than the given value
nms_threshold	the threshold to suppress bounding boxes of IoU bigger than the given value
top_k	keep top K bboxes before NMS
backend_id	the id of backend
target_id	the id of target device

create() [5/12]

static FaceDetectorYN OpenCVForUnity.ObjdetectModule.FaceDetectorYN.create ( string  model, string  config, Size  input_size, float  score_threshold  )

static

Creates an instance of face detector class with given parameters.

Parameters

model	the path to the requested model
config	the path to the config file for compability, which is not requested for ONNX models
input_size	the size of the input image
score_threshold	the threshold to filter out bounding boxes of score smaller than the given value
nms_threshold	the threshold to suppress bounding boxes of IoU bigger than the given value
top_k	keep top K bboxes before NMS
backend_id	the id of backend
target_id	the id of target device

create() [6/12]

static FaceDetectorYN OpenCVForUnity.ObjdetectModule.FaceDetectorYN.create ( string  model, string  config, Size  input_size  )

static

Creates an instance of face detector class with given parameters.

Parameters

model	the path to the requested model
config	the path to the config file for compability, which is not requested for ONNX models
input_size	the size of the input image
score_threshold	the threshold to filter out bounding boxes of score smaller than the given value
nms_threshold	the threshold to suppress bounding boxes of IoU bigger than the given value
top_k	keep top K bboxes before NMS
backend_id	the id of backend
target_id	the id of target device

create() [7/12]

static FaceDetectorYN OpenCVForUnity.ObjdetectModule.FaceDetectorYN.create ( string  framework, MatOfByte  bufferModel, MatOfByte  bufferConfig, Size  input_size, float  score_threshold, float  nms_threshold, int  top_k, int  backend_id, int  target_id  )

static

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

framework	Name of origin framework
bufferModel	A buffer with a content of binary file with weights
bufferConfig	A buffer with a content of text file contains network configuration
input_size	the size of the input image
score_threshold	the threshold to filter out bounding boxes of score smaller than the given value
nms_threshold	the threshold to suppress bounding boxes of IoU bigger than the given value
top_k	keep top K bboxes before NMS
backend_id	the id of backend
target_id	the id of target device

create() [8/12]

static FaceDetectorYN OpenCVForUnity.ObjdetectModule.FaceDetectorYN.create ( string  framework, MatOfByte  bufferModel, MatOfByte  bufferConfig, Size  input_size, float  score_threshold, float  nms_threshold, int  top_k, int  backend_id  )

static

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

framework	Name of origin framework
bufferModel	A buffer with a content of binary file with weights
bufferConfig	A buffer with a content of text file contains network configuration
input_size	the size of the input image
score_threshold	the threshold to filter out bounding boxes of score smaller than the given value
nms_threshold	the threshold to suppress bounding boxes of IoU bigger than the given value
top_k	keep top K bboxes before NMS
backend_id	the id of backend
target_id	the id of target device

create() [9/12]

static FaceDetectorYN OpenCVForUnity.ObjdetectModule.FaceDetectorYN.create ( string  framework, MatOfByte  bufferModel, MatOfByte  bufferConfig, Size  input_size, float  score_threshold, float  nms_threshold, int  top_k  )

static

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

framework	Name of origin framework
bufferModel	A buffer with a content of binary file with weights
bufferConfig	A buffer with a content of text file contains network configuration
input_size	the size of the input image
score_threshold	the threshold to filter out bounding boxes of score smaller than the given value
nms_threshold	the threshold to suppress bounding boxes of IoU bigger than the given value
top_k	keep top K bboxes before NMS
backend_id	the id of backend
target_id	the id of target device

create() [10/12]

static FaceDetectorYN OpenCVForUnity.ObjdetectModule.FaceDetectorYN.create ( string  framework, MatOfByte  bufferModel, MatOfByte  bufferConfig, Size  input_size, float  score_threshold, float  nms_threshold  )

static

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

framework	Name of origin framework
bufferModel	A buffer with a content of binary file with weights
bufferConfig	A buffer with a content of text file contains network configuration
input_size	the size of the input image
score_threshold	the threshold to filter out bounding boxes of score smaller than the given value
nms_threshold	the threshold to suppress bounding boxes of IoU bigger than the given value
top_k	keep top K bboxes before NMS
backend_id	the id of backend
target_id	the id of target device

create() [11/12]

static FaceDetectorYN OpenCVForUnity.ObjdetectModule.FaceDetectorYN.create ( string  framework, MatOfByte  bufferModel, MatOfByte  bufferConfig, Size  input_size, float  score_threshold  )

static

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

framework	Name of origin framework
bufferModel	A buffer with a content of binary file with weights
bufferConfig	A buffer with a content of text file contains network configuration
input_size	the size of the input image
score_threshold	the threshold to filter out bounding boxes of score smaller than the given value
nms_threshold	the threshold to suppress bounding boxes of IoU bigger than the given value
top_k	keep top K bboxes before NMS
backend_id	the id of backend
target_id	the id of target device

create() [12/12]

static FaceDetectorYN OpenCVForUnity.ObjdetectModule.FaceDetectorYN.create ( string  framework, MatOfByte  bufferModel, MatOfByte  bufferConfig, Size  input_size  )

static

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

framework	Name of origin framework
bufferModel	A buffer with a content of binary file with weights
bufferConfig	A buffer with a content of text file contains network configuration
input_size	the size of the input image
score_threshold	the threshold to filter out bounding boxes of score smaller than the given value
nms_threshold	the threshold to suppress bounding boxes of IoU bigger than the given value
top_k	keep top K bboxes before NMS
backend_id	the id of backend
target_id	the id of target device

detect()

int OpenCVForUnity.ObjdetectModule.FaceDetectorYN.detect	(	Mat	image,
		Mat	faces
	)

Detects faces in the input image. Following is an example output.

image

Parameters

image

an image to detect

faces

detection results stored in a 2D cv::Mat of shape [num_faces, 15] 0-1: x, y of bbox top left corner 2-3: width, height of bbox 4-5: x, y of right eye (blue point in the example image) 6-7: x, y of left eye (red point in the example image) 8-9: x, y of nose tip (green point in the example image) 10-11: x, y of right corner of mouth (pink point in the example image) 12-13: x, y of left corner of mouth (yellow point in the example image) 14: face score

Dispose()

override void OpenCVForUnity.ObjdetectModule.FaceDetectorYN.Dispose ( bool  disposing )

protectedvirtual

Reimplemented from OpenCVForUnity.DisposableOpenCVObject.

getInputSize()

Size OpenCVForUnity.ObjdetectModule.FaceDetectorYN.getInputSize

(

)

getNativeObjAddr()

IntPtr OpenCVForUnity.ObjdetectModule.FaceDetectorYN.getNativeObjAddr

(

)

getNMSThreshold()

float OpenCVForUnity.ObjdetectModule.FaceDetectorYN.getNMSThreshold

(

)

getScoreThreshold()

float OpenCVForUnity.ObjdetectModule.FaceDetectorYN.getScoreThreshold

(

)

getTopK()

int OpenCVForUnity.ObjdetectModule.FaceDetectorYN.getTopK

(

)

setInputSize()

void OpenCVForUnity.ObjdetectModule.FaceDetectorYN.setInputSize

(

Size

input_size

)

Set the size for the network input, which overwrites the input size of creating model. Call this method when the size of input image does not match the input size when creating model.

Parameters

input_size

the size of the input image

setNMSThreshold()

void OpenCVForUnity.ObjdetectModule.FaceDetectorYN.setNMSThreshold

(

float

nms_threshold

)

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

Parameters

nms_threshold

threshold for NMS operation

setScoreThreshold()

void OpenCVForUnity.ObjdetectModule.FaceDetectorYN.setScoreThreshold

(

float

score_threshold

)

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

Parameters

score_threshold

threshold for filtering out bounding boxes

setTopK()

void OpenCVForUnity.ObjdetectModule.FaceDetectorYN.setTopK

(

int

top_k

)

Set the number of bounding boxes preserved before NMS.

Parameters

top_k

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

---

The documentation for this class was generated from the following file:

• OpenCVForUnity/Assets/OpenCVForUnity/org/opencv/objdetect/FaceDetectorYN.cs