identifies the properties associated with faces within the video frame. More...

#include "dfx/Face.h"

Public Attributes
std::string	id
	the identity of this face. More...

cv::Rect	faceRect
	the bounding rectangle of the face. More...

bool	poseValid
	if the pose points are valid for this face. More...

bool	detected
	if the face was detected or assumed based on prior knowledge. More...

std::map< std::string, dfx::PosePoint >	posePoints
	the PosePoint information for this face. More...

std::map< std::string, double >	attributes
	are used to augment the face with additional data. More...

Detailed Description

identifies the properties associated with faces within the video frame.

All faces must be represented by a unique id in order to correlate faces across video frames, if you only have one face it can be something as simple as "1".

Member Data Documentation

◆ attributes

std::map<std::string, double> dfx::Face::attributes

are used to augment the face with additional data.

While it is not required, applications can provide additional face attributes for studies which know how to interpret the labels.

An example of this might be "age" or "weight" of the individual depicted by the face is known, the attributes can include that metric data.

Some libraries provide "pitch", "roll", and "yaw" for a face.

All studies have a known set of attribute labels which they expect or optionally can accept and ignore all others.

◆ detected

bool dfx::Face::detected

if the face was detected or assumed based on prior knowledge.

It is used to help DFX know how much it should trust this face data when making predictions.

◆ faceRect

cv::Rect dfx::Face::faceRect

the bounding rectangle of the face.

Identifies the crude bounding box of a face. Face detection algorithms will typically identify the face rect and then perform pose estimation within the faceRect to obtain more detailed pose points for a face.

◆ id

std::string dfx::Face::id

the identity of this face.

All faces must be uniquely identified within the DFX Engine. If a facial recognition engine is being used, the name of the individual can be used otherwise a GUID or counter may be used.

◆ posePoints

std::map<std::string, dfx::PosePoint> dfx::Face::posePoints

the PosePoint information for this face.

PosePoint information is required in order for more accurate predictions which build regions of interest based on the defined PosePoints.

◆ poseValid

bool dfx::Face::poseValid

if the pose points are valid for this face.

In general, passing invalid poses will cause the Measurement constraints to be violated and the Measurement will need to be reset in order to continue.

The documentation for this struct was generated from the following file:

dfx/Face.h

Public Attributes