Face SDK  1.13.0 Mozart release
Face Recognition Software Development Kit
Classes | Functions
cpp interface

Classes

class  face_sdk::face_detector
 Face detection algorithm. The Face detection find faces on images. More...
 

Functions

std::shared_ptr< face_sdk::face_detectorface_sdk::make_face_detector (uint32_t version, const std::shared_ptr< face_sdk::license > &license, const std::shared_ptr< face_sdk::data_container > &container, uint32_t batch_size, int32_t compute_device)
 Makes the face_sdk::face_detector object with specified version, license, data container, batch size and compute_device. More...
 
std::shared_ptr< face_sdk::face_detectorface_sdk::make_face_detector (uint32_t version, const std::shared_ptr< face_sdk::license > &license, uint32_t batch_size, int32_t compute_device)
 Makes the face_sdk::face_detector object with specified version, license, batch size and compute device. The data container is loaded from known paths (see Known paths). More...
 
std::shared_ptr< face_sdk::face_detectorface_sdk::make_face_detector (uint32_t version, const std::shared_ptr< face_sdk::data_container > &container, uint32_t batch_size, int32_t compute_device)
 Makes the face_sdk::face_detector object with specified version, data container, batch size and compute device. The license is loaded from known paths (see Known paths). More...
 
std::shared_ptr< face_sdk::face_detectorface_sdk::make_face_detector (uint32_t version, uint32_t batch_size, int32_t compute_device)
 Makes the face_sdk::face_detector object with specified version, batch size and compute device. The data container and the license are loaded from known paths (see Known paths). More...
 

Detailed Description

Module detects faces on the image and returns array of objects, where every object is coordinates of the boundary and confidence parameter.
Confidence parameter is the internal assessment of the detection error possibility (where 0 - definitely detection error, 1 - definitely a face).
In case of finding several faces on the image, Face detector returns several objects.
Following use case scenario is up to SDK user: user can send all detected objects to the following recognition, choose one of them based on boundary, confidence parameter or both.

Function Documentation

◆ make_face_detector() [1/4]

std::shared_ptr<face_sdk::face_detector> face_sdk::make_face_detector ( uint32_t  version,
const std::shared_ptr< face_sdk::license > &  license,
const std::shared_ptr< face_sdk::data_container > &  container,
uint32_t  batch_size,
int32_t  compute_device 
)

Makes the face_sdk::face_detector object with specified version, license, data container, batch size and compute_device.

Parameters
[in]versionRequired version of the algorithm. See Face Detector versions.
[in]licenseThe license object. See Licensing.
[in]containerThe container with algorithm data.
[in]batch_sizeThe batch size. See Batching.
[in]compute_deviceThe compute device. -1 = CPU. 0, 1, ..., N - GPU device.
Exceptions
face_sdk::exceptionSee Exceptions handling.
Examples:
complex.cpp.

◆ make_face_detector() [2/4]

std::shared_ptr<face_sdk::face_detector> face_sdk::make_face_detector ( uint32_t  version,
const std::shared_ptr< face_sdk::license > &  license,
uint32_t  batch_size,
int32_t  compute_device 
)

Makes the face_sdk::face_detector object with specified version, license, batch size and compute device. The data container is loaded from known paths (see Known paths).

Parameters
[in]versionRequired version of the algorithm. See Face Detector versions.
[in]licenseThe license object. See Licensing.
[in]batch_sizeThe batch size. See Batching.
[in]compute_deviceThe compute device. -1 = CPU. 0, 1, ..., N - GPU device.
Exceptions
face_sdk::exceptionSee Exceptions handling.

◆ make_face_detector() [3/4]

std::shared_ptr<face_sdk::face_detector> face_sdk::make_face_detector ( uint32_t  version,
const std::shared_ptr< face_sdk::data_container > &  container,
uint32_t  batch_size,
int32_t  compute_device 
)

Makes the face_sdk::face_detector object with specified version, data container, batch size and compute device. The license is loaded from known paths (see Known paths).

Parameters
[in]versionRequired version of the algorithm. See Face Detector versions.
[in]containerThe container with algorithm data.
[in]batch_sizeThe batch size. See Batching.
[in]compute_deviceThe compute device. -1 = CPU. 0, 1, ..., N - GPU device.
Exceptions
face_sdk::exceptionSee Exceptions handling.

◆ make_face_detector() [4/4]

std::shared_ptr<face_sdk::face_detector> face_sdk::make_face_detector ( uint32_t  version,
uint32_t  batch_size,
int32_t  compute_device 
)

Makes the face_sdk::face_detector object with specified version, batch size and compute device. The data container and the license are loaded from known paths (see Known paths).

Parameters
[in]versionRequired version of the algorithm. See Face Detector versions.
[in]batch_sizeThe batch size. See Batching.
[in]compute_deviceThe compute device. -1 = CPU. 0, 1, ..., N - GPU device.
Exceptions
face_sdk::exceptionSee Exceptions handling.