org.bytedeco.opencv.opencv_objdetect

Class FaceDetectorYN

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.opencv.opencv_objdetect.FaceDetectorYN

All Implemented Interfaces:

AutoCloseable

@Namespace(value="cv")
 @Properties(inherit=opencv_objdetect.class)
public class FaceDetectorYN
extends Pointer

\addtogroup objdetect_dnn_face \{

/** \brief DNN-based face detector

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

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
FaceDetectorYN(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
static FaceDetectorYN	create(BytePointer model, BytePointer config, Size input_size)
static FaceDetectorYN	create(BytePointer model, BytePointer config, Size input_size, float score_threshold, float nms_threshold, int top_k, int backend_id, int target_id) \brief Creates an instance of this class with given parameters
static FaceDetectorYN	create(String model, String config, Size input_size)
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)
int	detect(GpuMat image, GpuMat faces)
int	detect(Mat image, Mat faces) \brief A simple interface to detect face from given image
int	detect(UMat image, UMat faces)
Size	getInputSize()
float	getNMSThreshold()
float	getScoreThreshold()
int	getTopK()
void	setInputSize(Size input_size) \brief Set the size for the network input, which overwrites the input size of creating model.
void	setNMSThreshold(float nms_threshold) \brief Set the Non-maximum-suppression threshold to suppress bounding boxes that have IoU greater than the given value
void	setScoreThreshold(float score_threshold) \brief Set the score threshold to filter out bounding boxes of score less than the given value
void	setTopK(int top_k) \brief Set the number of bounding boxes preserved before NMS

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FaceDetectorYN

public FaceDetectorYN(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

setInputSize

public void setInputSize(@Const @ByRef
                         Size input_size)

\brief 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

@ByVal
public Size getInputSize()

setScoreThreshold

public void setScoreThreshold(float score_threshold)

\brief 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)

\brief 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)

\brief 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(@ByVal
                  Mat image,
                  @ByVal
                  Mat faces)

\brief A simple interface to detect face from given image

Parameters:

image - an image to detect

faces - detection results stored in a cv::Mat

detect

public int detect(@ByVal
                  UMat image,
                  @ByVal
                  UMat faces)

detect

public int detect(@ByVal
                  GpuMat image,
                  @ByVal
                  GpuMat faces)

create

@opencv_core.Ptr
public static FaceDetectorYN create(@opencv_core.Str
                                                      BytePointer model,
                                                      @opencv_core.Str
                                                      BytePointer config,
                                                      @Const @ByRef
                                                      Size input_size,
                                                      float score_threshold,
                                                      float nms_threshold,
                                                      int top_k,
                                                      int backend_id,
                                                      int target_id)

\brief 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

create

@opencv_core.Ptr
public static FaceDetectorYN create(@opencv_core.Str
                                                      BytePointer model,
                                                      @opencv_core.Str
                                                      BytePointer config,
                                                      @Const @ByRef
                                                      Size input_size)

create

@opencv_core.Ptr
public static FaceDetectorYN create(@opencv_core.Str
                                                      String model,
                                                      @opencv_core.Str
                                                      String config,
                                                      @Const @ByRef
                                                      Size input_size,
                                                      float score_threshold,
                                                      float nms_threshold,
                                                      int top_k,
                                                      int backend_id,
                                                      int target_id)

create

@opencv_core.Ptr
public static FaceDetectorYN create(@opencv_core.Str
                                                      String model,
                                                      @opencv_core.Str
                                                      String config,
                                                      @Const @ByRef
                                                      Size input_size)