java.lang.Object
- org.opencv.objdetect.FaceDetectorYN

```
public class FaceDetectorYN
extends java.lang.Object
```
DNN-based face detector, model download link: https://github.com/ShiqiYu/libfacedetection.train/tree/master/tasks/task1/onnx.

Field Summary

Fields
Modifier and Type Field Description

protected long nativeObj

Constructor Summary

Constructors
Modifier Constructor Description

protected FaceDetectorYN(long addr)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static FaceDetectorYN`	`__fromPtr__(long addr)`
`static FaceDetectorYN`	`create(java.lang.String model, java.lang.String config, Size input_size)`	Creates an instance of this class with given parameters
`static FaceDetectorYN`	`create(java.lang.String model, java.lang.String config, Size input_size, float score_threshold)`	Creates an instance of this class with given parameters
`static FaceDetectorYN`	`create(java.lang.String model, java.lang.String config, Size input_size, float score_threshold, float nms_threshold)`	Creates an instance of this class with given parameters
`static FaceDetectorYN`	`create(java.lang.String model, java.lang.String config, Size input_size, float score_threshold, float nms_threshold, int top_k)`	Creates an instance of this class with given parameters
`static FaceDetectorYN`	`create(java.lang.String model, java.lang.String config, Size input_size, float score_threshold, float nms_threshold, int top_k, int backend_id)`	Creates an instance of this class with given parameters
`static FaceDetectorYN`	`create(java.lang.String model, java.lang.String config, Size input_size, float score_threshold, float nms_threshold, int top_k, int backend_id, int target_id)`	Creates an instance of this class with given parameters
`int`	`detect(Mat image, Mat faces)`	A simple interface to detect face from given image
`protected void`	`finalize()`
`Size`	`getInputSize()`
`long`	`getNativeObjAddr()`
`float`	`getNMSThreshold()`
`float`	`getScoreThreshold()`
`int`	`getTopK()`
`void`	`setInputSize(Size input_size)`	Set the size for the network input, which overwrites the input size of creating model.
`void`	`setNMSThreshold(float nms_threshold)`	Set the Non-maximum-suppression threshold to suppress bounding boxes that have IoU greater than the given value
`void`	`setScoreThreshold(float score_threshold)`	Set the score threshold to filter out bounding boxes of score less than the given value
`void`	`setTopK(int top_k)`	Set the number of bounding boxes preserved before NMS

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - nativeObj
```
protected final long nativeObj
```
- Constructor Detail
  - FaceDetectorYN
```
protected FaceDetectorYN(long addr)
```
- Method Detail
  - getNativeObjAddr
```
public long getNativeObjAddr()
```
  - __fromPtr__
```
public static FaceDetectorYN __fromPtr__(long addr)
```
  - setInputSize
```
public 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
    
    Parameters:
    
    input_size - the size of the input image
  - getInputSize
```
public Size getInputSize()
```
  - setScoreThreshold
```
public void 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
  - getScoreThreshold
```
public float getScoreThreshold()
```
  - setNMSThreshold
```
public void 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
  - getNMSThreshold
```
public float getNMSThreshold()
```
  - setTopK
```
public void 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
  - getTopK
```
public int getTopK()
```
  - detect
```
public int detect(Mat image,
                  Mat faces)
```
    A simple interface to detect face from given image
    
    Parameters:
    
    image - an image to detect
    
    faces - detection results stored in a cv::Mat
    
    Returns:
    
    automatically generated
  - create
```
public static FaceDetectorYN create(java.lang.String model,
                                    java.lang.String config,
                                    Size input_size,
                                    float score_threshold,
                                    float nms_threshold,
                                    int top_k,
                                    int backend_id,
                                    int target_id)
```
    Creates an instance of this 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
    
    Returns:
    
    automatically generated
  - create
```
public static FaceDetectorYN create(java.lang.String model,
                                    java.lang.String config,
                                    Size input_size,
                                    float score_threshold,
                                    float nms_threshold,
                                    int top_k,
                                    int backend_id)
```
    Creates an instance of this 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
    
    Returns:
    
    automatically generated
  - create
```
public static FaceDetectorYN create(java.lang.String model,
                                    java.lang.String config,
                                    Size input_size,
                                    float score_threshold,
                                    float nms_threshold,
                                    int top_k)
```
    Creates an instance of this 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
    
    Returns:
    
    automatically generated
  - create
```
public static FaceDetectorYN create(java.lang.String model,
                                    java.lang.String config,
                                    Size input_size,
                                    float score_threshold,
                                    float nms_threshold)
```
    Creates an instance of this 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
    
    Returns:
    
    automatically generated
  - create
```
public static FaceDetectorYN create(java.lang.String model,
                                    java.lang.String config,
                                    Size input_size,
                                    float score_threshold)
```
    Creates an instance of this 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
    
    Returns:
    
    automatically generated
  - create
```
public static FaceDetectorYN create(java.lang.String model,
                                    java.lang.String config,
                                    Size input_size)
```
    Creates an instance of this 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
    
    Returns:
    
    automatically generated
  - finalize
```
protected void finalize()
                 throws java.lang.Throwable
```
    Overrides:
    
    finalize in class java.lang.Object
    
    Throws:
    
    java.lang.Throwable

Class FaceDetectorYN

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

nativeObj

Constructor Detail

FaceDetectorYN

Method Detail

getNativeObjAddr

__fromPtr__

setInputSize

getInputSize

setScoreThreshold

getScoreThreshold

setNMSThreshold

getNMSThreshold

setTopK

getTopK

detect

create

create

create

create

create

create

finalize

fromPtr