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

Classes

class  face_sdk::face_recognition
 Class used by tracker class to get the score of the face. More...
 
class  face_sdk::track
 The class is a track of a person. The class contains a vector of face_sdk::track_item. More...
 
class  face_sdk::itracker_events
 Callback-interface for handling tracker events. More...
 
struct  face_sdk::tracker_config
 Structure with parameters for the tracker object used in face_sdk::make_tracker() function. More...
 
class  face_sdk::tracker
 Tracker object tracks persons in the video stream and collects faces of the same person in one track. More...
 

Typedefs

typedef std::tuple< std::shared_ptr< face_sdk::video_frame >, std::shared_ptr< face_sdk::face > > face_sdk::track_item
 A tuple face_sdk::video_frame and face_sdk::face on it.
 

Functions

std::shared_ptr< face_recognitionface_sdk::make_face_recognition (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_recognition object with specified version, license, data container, batch size and compute_device. More...
 
std::shared_ptr< face_recognitionface_sdk::make_face_recognition (uint32_t version, const std::shared_ptr< face_sdk::license > &license, uint32_t batch_size, int32_t compute_device)
 Makes the face_sdk::face_recognition 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_recognitionface_sdk::make_face_recognition (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_recognition 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_recognitionface_sdk::make_face_recognition (uint32_t version, uint32_t batch_size, int32_t compute_device)
 Makes the face_sdk::face_recognition object with specified version, batch size and compute device. The data container and the license are loaded from known paths (see Known paths). More...
 
std::shared_ptr< trackerface_sdk::make_tracker (const tracker_config &config)
 Makes the face_sdk::tracker object with specified configuration. More...
 

Detailed Description

Module tracks persons in the video stream and collects faces of the same person in one track.

Function Documentation

◆ make_face_recognition() [1/4]

std::shared_ptr<face_recognition> face_sdk::make_face_recognition ( 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_recognition object with specified version, license, data container, batch size and compute_device.

Parameters
[in]versionRequired version of the algorithm. See Face Tracker versions.
[in]licenseThe license object. See Licensing.
[in]contanerThe 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_recognition() [2/4]

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

Makes the face_sdk::face_recognition 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 Tracker 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_recognition() [3/4]

std::shared_ptr<face_recognition> face_sdk::make_face_recognition ( 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_recognition 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 Tracker 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_recognition() [4/4]

std::shared_ptr<face_recognition> face_sdk::make_face_recognition ( uint32_t  version,
uint32_t  batch_size,
int32_t  compute_device 
)

Makes the face_sdk::face_recognition 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 Tracker 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.

◆ make_tracker()

std::shared_ptr<tracker> face_sdk::make_tracker ( const tracker_config config)

Makes the face_sdk::tracker object with specified configuration.

Parameters
[in]configConfiguration structure for the tracker object
Exceptions
face_sdk::invalid_parameter_exceptionIf any field of config structure is not initialized
face_sdk::version_not_available_exceptionIf there are no version of tracker algorithm specified in version field of config structure
Examples:
tracker.cpp.