Struct FaceDetectorYN

pub struct FaceDetectorYN { /* private fields */ }

DNN-based face detector

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

Implementations

impl FaceDetectorYN

pub fn create( model: &str, config: &str, input_size: Size, score_threshold: f32, nms_threshold: f32, top_k: i32, backend_id: i32, target_id: i32, ) -> Result<Ptr<FaceDetectorYN>>

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

C++ default parameters

• score_threshold: 0.9f
• nms_threshold: 0.3f
• top_k: 5000
• backend_id: 0
• target_id: 0

pub fn create_def( model: &str, config: &str, input_size: Size, ) -> Result<Ptr<FaceDetectorYN>>

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

Note

This alternative version of FaceDetectorYN::create function uses the following default values for its arguments:

• score_threshold: 0.9f
• nms_threshold: 0.3f
• top_k: 5000
• backend_id: 0
• target_id: 0

pub fn create_1( framework: &str, buffer_model: &Vector<u8>, buffer_config: &Vector<u8>, input_size: Size, score_threshold: f32, nms_threshold: f32, top_k: i32, backend_id: i32, target_id: i32, ) -> Result<Ptr<FaceDetectorYN>>

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

Overloaded 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

C++ default parameters

• score_threshold: 0.9f
• nms_threshold: 0.3f
• top_k: 5000
• backend_id: 0
• target_id: 0

pub fn create_def_1( framework: &str, buffer_model: &Vector<u8>, buffer_config: &Vector<u8>, input_size: Size, ) -> Result<Ptr<FaceDetectorYN>>

@overload

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

Note

This alternative version of FaceDetectorYN::create function uses the following default values for its arguments:

• score_threshold: 0.9f
• nms_threshold: 0.3f
• top_k: 5000
• backend_id: 0
• target_id: 0

Trait Implementations

impl Boxed for FaceDetectorYN

unsafe fn from_raw( ptr: <FaceDetectorYN as OpenCVFromExtern>::ExternReceive, ) -> Self

Wrap the specified raw pointer

fn into_raw( self, ) -> <FaceDetectorYN as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying raw pointer while consuming this wrapper.

fn as_raw(&self) -> <FaceDetectorYN as OpenCVTypeExternContainer>::ExternSend

Return the underlying raw pointer.

fn as_raw_mut( &mut self, ) -> <FaceDetectorYN as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying mutable raw pointer

impl Debug for FaceDetectorYN

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for FaceDetectorYN

fn drop(&mut self)

Executes the destructor for this type.

impl FaceDetectorYNTrait for FaceDetectorYN

fn as_raw_mut_FaceDetectorYN(&mut self) -> *mut c_void

fn set_input_size(&mut self, input_size: Size) -> Result<()>

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

fn get_input_size(&mut self) -> Result<Size>

fn set_score_threshold(&mut self, score_threshold: f32) -> Result<()>

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

fn get_score_threshold(&mut self) -> Result<f32>

fn set_nms_threshold(&mut self, nms_threshold: f32) -> Result<()>

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

fn get_nms_threshold(&mut self) -> Result<f32>

fn set_top_k(&mut self, top_k: i32) -> Result<()>

Set the number of bounding boxes preserved before NMS

fn get_top_k(&mut self) -> Result<i32>

fn detect( &mut self, image: &impl ToInputArray, faces: &mut impl ToOutputArray, ) -> Result<i32>

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

impl FaceDetectorYNTraitConst for FaceDetectorYN

fn as_raw_FaceDetectorYN(&self) -> *const c_void

impl Send for FaceDetectorYN