Open Source Face Image Quality (OFIQ)

Generated by Doxygen 1.10.0

 i

1 Open Source Face Image Quality (OFIQ) Library 1

1.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.2 License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.2.1 OFIQ License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.2.2 License of dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.3 Compilation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.3.1 Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.3.1.1 Ubuntu 22.04 (x86_64) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.3.1.2 Ubuntu 24.04 (x86_64) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.3.2 Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.3.2.1 Windows (x86_64) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.3.2.2 Windows (x86) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.4 MacOS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.4.0.1 MacOS (ARM64) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.4.1 MacOS (x86_64) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
1.4.2 Download model files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
1.4.3 Download conformance test images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.4.4 Download of external libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.4.5 Building without conan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.5 Running conformance tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.6 Running the sample executable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.6.1 Quality assessment for a single facial image . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.6.2 Quality assessment for multiple images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.6.3 Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.7 Supported platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.8 Precompiled binaries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.9 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.9.1 Configuration of the face detector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
1.9.2 Configuration of the landmark extractor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
1.9.3 Other required configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
1.9.4 Requesting measures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
1.9.5 Default configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
1.9.6 Configuration of the quality mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
1.10 C++ API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
1.11 Implementation and pre-processing workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
1.12 Release notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
1.12.1 Changelog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
1.12.1.1 Version 1.0.0-RC.2 (2024-07-31) . . . . . . . . . . . . . . . . . . . . . . . . . . 23
1.12.1.2 Version 1.0.0-RC.1 (2024-03-15) . . . . . . . . . . . . . . . . . . . . . . . . . . 24

2 Namespace Index 25
2.1 Namespace List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Generated by Doxygen
ii

3 Hierarchical Index 27
3.1 Class Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

4 Class Index 29
4.1 Class List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

5 File Index 33
5.1 File List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

6 Namespace Documentation 37
6.1 cv Namespace Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
6.1.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
6.2 OFIQ Namespace Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
6.2.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
6.2.2 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
6.2.2.1 Landmarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
6.2.2.2 QualityAssessments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
6.2.3 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
6.2.3.1 FaceDetectorType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
6.2.3.2 LandmarkType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
6.2.3.3 QualityMeasure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
6.2.3.4 QualityMeasureReturnCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
6.2.3.5 ReturnCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
6.2.4 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
6.2.4.1 operator<<() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
6.3 OFIQ_LIB Namespace Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
6.3.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
6.3.2 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
6.3.2.1 EulerAngle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
6.3.2.2 ExposureRange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
6.3.3 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
6.3.3.1 alignImage() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
6.3.3.2 CalculateExposure() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
6.3.3.3 calculateEyeCenter() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
6.3.3.4 CalculateReferencePoints() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
6.3.3.5 CalculateRegionOfInterest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
6.3.3.6 ColorConvert() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
6.3.3.7 ComputeBrightnessAspect() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
6.3.3.8 ConvertBGRToCIELAB() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
6.3.3.9 copyToCvImage() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
6.3.3.10 Cubic() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
6.3.3.11 findLargestBoundingBox() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
6.3.3.12 GetLuminanceImageFromBGR() . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Generated by Doxygen
 iii

6.3.3.13 GetNormalizedHistogram() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
6.3.3.14 MakeGreyImage() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
6.3.3.15 makeSquareBoundingBox() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
6.3.3.16 makeSquareBoundingBoxWithPadding() . . . . . . . . . . . . . . . . . . . . . . 49
6.3.3.17 readImage() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
6.3.3.18 tmetric() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
6.4 OFIQ_LIB::modules Namespace Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
6.5 OFIQ_LIB::modules::detectors Namespace Reference . . . . . . . . . . . . . . . . . . . . . . . . . 51
6.5.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
6.6 OFIQ_LIB::modules::landmarks Namespace Reference . . . . . . . . . . . . . . . . . . . . . . . . 52
6.6.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
6.6.2 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
6.6.2.1 FaceMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
6.6.2.2 FacePairMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
6.6.2.3 LandmarkId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
6.6.2.4 LandmarkIdPair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
6.6.2.5 LandmarkIdPairs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
6.6.2.6 LandmarkIds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
6.6.3 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
6.6.3.1 FaceParts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
6.7 OFIQ_LIB::modules::landmarks::adnet Namespace Reference . . . . . . . . . . . . . . . . . . . . 54
6.7.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
6.7.2 Variable Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
6.7.2.1 chin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
6.7.2.2 contour . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
6.7.2.3 FaceMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
6.7.2.4 FacePairMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
6.7.2.5 forehead . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
6.7.2.6 leftEye . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
6.7.2.7 leftEyeCorners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
6.7.2.8 mouthInner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
6.7.2.9 mouthOuter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
6.7.2.10 nosetip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
6.7.2.11 pairsInnerLip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
6.7.2.12 pairsLeftEye . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
6.7.2.13 pairsMouthCenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
6.7.2.14 pairsRightEye . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
6.7.2.15 rightEye . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
6.7.2.16 rightEyeCorners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
6.8 OFIQ_LIB::modules::measures Namespace Reference . . . . . . . . . . . . . . . . . . . . . . . . 58
6.8.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
6.8.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Generated by Doxygen
iv

6.8.2.1 log() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
6.8.3 Variable Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
6.8.3.1 ExecutorLogActive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
6.9 OFIQ_LIB::modules::poseEstimators Namespace Reference . . . . . . . . . . . . . . . . . . . . . 60
6.9.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
6.10 OFIQ_LIB::modules::segmentations Namespace Reference . . . . . . . . . . . . . . . . . . . . . 60
6.10.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
6.10.2 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
6.10.2.1 SegmentClassLabels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

7 Class Documentation 63
7.1 OFIQ_LIB::modules::landmarks::ADNetFaceLandmarkExtractor Class Reference . . . . . . . . . . . 63
7.1.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
7.1.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
7.1.2.1 ADNetFaceLandmarkExtractor() . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
7.1.2.2 ∼ADNetFaceLandmarkExtractor() . . . . . . . . . . . . . . . . . . . . . . . . . . 64
7.1.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
7.1.3.1 updateLandmarks() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
7.1.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
7.1.4.1 landmarkExtractor_ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
7.2 OFIQ_LIB::modules::measures::BackgroundUniformity Class Reference . . . . . . . . . . . . . . . 65
7.2.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
7.2.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
7.2.2.1 BackgroundUniformity() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
7.2.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
7.2.3.1 Execute() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
7.2.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
7.2.4.1 m_cropBottom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
7.2.4.2 m_cropLeft . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
7.2.4.3 m_cropRight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
7.2.4.4 m_cropTop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
7.2.4.5 m_erosionKernelSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
7.2.4.6 m_targetHeight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
7.2.4.7 m_targetWidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
7.3 OFIQ::BoundingBox Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
7.3.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
7.3.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
7.3.2.1 BoundingBox() [1/2] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
7.3.2.2 BoundingBox() [2/2] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
7.3.3 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
7.3.3.1 faceDetector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
7.3.3.2 height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Generated by Doxygen
 v

7.3.3.3 width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
7.3.3.4 xleft . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
7.3.3.5 ytop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
7.4 OFIQ_LIB::modules::measures::CompressionArtifacts Class Reference . . . . . . . . . . . . . . . . 71
7.4.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
7.4.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
7.4.2.1 CompressionArtifacts() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
7.4.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
7.4.3.1 Execute() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
7.4.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
7.4.4.1 m_crop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
7.4.4.2 m_dim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
7.4.4.3 m_onnxRuntimeEnv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
7.5 OFIQ_LIB::Configuration Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
7.5.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
7.5.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
7.5.2.1 Configuration() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
7.5.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
7.5.3.1 GetBool() [1/2] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
7.5.3.2 GetBool() [2/2] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
7.5.3.3 getDataDir() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
7.5.3.4 GetNumber() [1/2] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
7.5.3.5 GetNumber() [2/2] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
7.5.3.6 GetString() [1/2] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
7.5.3.7 GetString() [2/2] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
7.5.3.8 GetStringList() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
7.5.3.9 SetDataDir() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
7.5.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
7.5.4.1 m_dataDir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
7.5.4.2 parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
7.6 OFIQ_LIB::modules::measures::CropOfTheFaceImage Class Reference . . . . . . . . . . . . . . . 79
7.6.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
7.6.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
7.6.2.1 CropOfTheFaceImage() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
7.6.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
7.6.3.1 Execute() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
7.7 OFIQ_LIB::modules::measures::DynamicRange Class Reference . . . . . . . . . . . . . . . . . . . 81
7.7.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
7.7.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
7.7.2.1 DynamicRange() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
7.7.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
7.7.3.1 Execute() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Generated by Doxygen
vi

7.8 OFIQ_LIB::modules::measures::Executor Class Reference . . . . . . . . . . . . . . . . . . . . . . 83

7.8.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
7.8.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
7.8.2.1 Executor() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
7.8.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
7.8.3.1 ExecuteAll() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
7.8.3.2 GetMeasures() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
7.8.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
7.8.4.1 m_measures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
7.9 OFIQ_LIB::modules::measures::ExpressionNeutrality Class Reference . . . . . . . . . . . . . . . . 85
7.9.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
7.9.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
7.9.2.1 ExpressionNeutrality() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
7.9.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
7.9.3.1 Execute() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
7.9.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
7.9.4.1 m_classifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
7.9.4.2 m_onnxRuntimeEnvCNN1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
7.9.4.3 m_onnxRuntimeEnvCNN2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
7.10 OFIQ_LIB::modules::measures::EyesOpen Class Reference . . . . . . . . . . . . . . . . . . . . . 88
7.10.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
7.10.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
7.10.2.1 EyesOpen() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
7.10.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
7.10.3.1 Execute() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
7.11 OFIQ_LIB::modules::measures::EyesVisible Class Reference . . . . . . . . . . . . . . . . . . . . 90
7.11.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
7.11.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
7.11.2.1 EyesVisible() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
7.11.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
7.11.3.1 Execute() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
7.12 OFIQ_LIB::FaceDetectorInterface Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 92
7.12.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
7.12.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
7.12.2.1 ∼FaceDetectorInterface() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
7.12.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
7.12.3.1 detectFaces() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
7.12.3.2 UpdateFaces() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
7.13 OFIQ::FaceImageQualityAssessment Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . 94
7.13.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
7.13.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
7.13.2.1 FaceImageQualityAssessment() [1/2] . . . . . . . . . . . . . . . . . . . . . . . 94

Generated by Doxygen
 vii

7.13.2.2 FaceImageQualityAssessment() [2/2] . . . . . . . . . . . . . . . . . . . . . . . 94

7.13.3 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
7.13.3.1 boundingBox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
7.13.3.2 qAssessments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
7.14 OFIQ_LIB::FaceLandmarkExtractorInterface Class Reference . . . . . . . . . . . . . . . . . . . . 95
7.14.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
7.14.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
7.14.2.1 ∼FaceLandmarkExtractorInterface() . . . . . . . . . . . . . . . . . . . . . . . . 96
7.14.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
7.14.3.1 extractLandmarks() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
7.14.3.2 updateLandmarks() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
7.15 OFIQ::FaceLandmarks Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
7.15.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
7.15.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
7.15.2.1 FaceLandmarks() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
7.15.3 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
7.15.3.1 landmarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
7.15.3.2 type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
7.16 OFIQ_LIB::modules::landmarks::FaceMeasures Class Reference . . . . . . . . . . . . . . . . . . 98
7.16.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
7.16.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
7.16.2.1 FaceMeasures() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
7.16.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
7.16.3.1 GetDistance() [1/2] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
7.16.3.2 GetDistance() [2/2] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
7.16.3.3 GetFaceMask() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
7.16.3.4 GetMaxPairDistance() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
7.16.3.5 GetMiddle() [1/3] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
7.16.3.6 GetMiddle() [2/3] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
7.16.3.7 GetMiddle() [3/3] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
7.16.3.8 InterEyeDistance() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
7.17 OFIQ_LIB::modules::measures::FaceOcclusionPrevention Class Reference . . . . . . . . . . . . . 102
7.17.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
7.17.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
7.17.2.1 FaceOcclusionPrevention() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
7.17.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
7.17.3.1 Execute() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
7.18 OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation Class Reference . . . . . . . . . 104
7.18.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
7.18.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
7.18.2.1 FaceOcclusionSegmentation() . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
7.18.2.2 ∼FaceOcclusionSegmentation() . . . . . . . . . . . . . . . . . . . . . . . . . . 106

Generated by Doxygen
viii

7.18.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

7.18.3.1 GetFaceOcclusionSegmentation() . . . . . . . . . . . . . . . . . . . . . . . . . 106
7.18.3.2 UpdateMask() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
7.18.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
7.18.4.1 m_cropBottom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
7.18.4.2 m_cropLeft . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
7.18.4.3 m_cropRight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
7.18.4.4 m_cropTop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
7.18.4.5 m_modelConfigItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
7.18.4.6 m_onnxRuntimeEnv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
7.18.4.7 m_scaledHeight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
7.18.4.8 m_scaledWidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
7.18.4.9 m_segmentationImage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
7.19 OFIQ_LIB::modules::segmentations::FaceParsing Class Reference . . . . . . . . . . . . . . . . . 108
7.19.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
7.19.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
7.19.2.1 FaceParsing() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
7.19.2.2 ∼FaceParsing() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
7.19.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
7.19.3.1 CalculateClassIds() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
7.19.3.2 CreateBlob() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
7.19.3.3 SetImage() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
7.19.3.4 UpdateMask() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
7.19.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
7.19.4.1 m_cropBottom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
7.19.4.2 m_cropLeft . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
7.19.4.3 m_cropRight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
7.19.4.4 m_cropTop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
7.19.4.5 m_imageSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
7.19.4.6 m_modelConfigItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
7.19.4.7 m_onnxRuntimeEnv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
7.19.4.8 m_segmentationImage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
7.20 OFIQ_LIB::modules::measures::HeadPose Class Reference . . . . . . . . . . . . . . . . . . . . . 114
7.20.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
7.20.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
7.20.2.1 HeadPose() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
7.20.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
7.20.3.1 Execute() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
7.21 OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2 Class Reference . . . . . . . . . . . . . 116
7.21.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
7.21.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
7.21.2.1 HeadPose3DDFAV2() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

Generated by Doxygen
 ix

7.21.2.2 ∼HeadPose3DDFAV2() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

7.21.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
7.21.3.1 CropImage() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
7.21.3.2 updatePose() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
7.21.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
7.21.4.1 m_expectedImageHeight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
7.21.4.2 m_expectedImageNumberOfChannels . . . . . . . . . . . . . . . . . . . . . . . 119
7.21.4.3 m_expectedImageWidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
7.21.4.4 m_inputShape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
7.21.4.5 m_numberOfInputElements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
7.21.4.6 m_ortenv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
7.21.4.7 m_ortSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
7.21.4.8 m_paramPoseEstimatorModel . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
7.22 OFIQ_LIB::modules::measures::HeadSize Class Reference . . . . . . . . . . . . . . . . . . . . . 120
7.22.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
7.22.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
7.22.2.1 HeadSize() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
7.22.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
7.22.3.1 Execute() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
7.23 OFIQ_LIB::modules::measures::IlluminationUniformity Class Reference . . . . . . . . . . . . . . . 122
7.23.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
7.23.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
7.23.2.1 IlluminationUniformity() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
7.23.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
7.23.3.1 Execute() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
7.24 OFIQ::Image Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
7.24.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
7.24.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
7.24.2.1 Image() [1/2] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
7.24.2.2 Image() [2/2] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
7.24.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
7.24.3.1 size() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
7.24.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
7.24.4.1 data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
7.24.4.2 depth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
7.24.4.3 height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
7.24.4.4 width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
7.25 OFIQ_LIB::modules::measures::InterEyeDistance Class Reference . . . . . . . . . . . . . . . . . 126
7.25.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
7.25.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
7.25.2.1 InterEyeDistance() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
7.25.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

Generated by Doxygen
x

7.25.3.1 Execute() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

7.26 OFIQ::Interface Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
7.26.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
7.26.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
7.26.2.1 ∼Interface() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
7.26.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
7.26.3.1 getImplementation() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
7.26.3.2 getVersion() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
7.26.3.3 initialize() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
7.26.3.4 scalarQuality() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
7.26.3.5 vectorQuality() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
7.27 OFIQ_LIB::modules::landmarks::LandmarkPair Struct Reference . . . . . . . . . . . . . . . . . . . 131
7.27.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
7.27.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
7.27.2.1 LandmarkPair() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
7.27.3 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
7.27.3.1 Lower . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
7.27.3.2 Upper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
7.28 OFIQ::LandmarkPoint Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
7.28.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
7.28.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
7.28.2.1 LandmarkPoint() [1/2] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
7.28.2.2 LandmarkPoint() [2/2] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
7.28.3 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
7.28.3.1 x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
7.28.3.2 y . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
7.29 OFIQ_LIB::modules::measures::Luminance Class Reference . . . . . . . . . . . . . . . . . . . . . 133
7.29.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
7.29.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
7.29.2.1 Luminance() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
7.29.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
7.29.3.1 Execute() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
7.30 OFIQ_LIB::modules::measures::Measure Class Reference . . . . . . . . . . . . . . . . . . . . . . 135
7.30.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
7.30.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
7.30.2.1 Measure() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
7.30.2.2 ∼Measure() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
7.30.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
7.30.3.1 AddSigmoid() [1/2] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
7.30.3.2 AddSigmoid() [2/2] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
7.30.3.3 Execute() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
7.30.3.4 ExecuteScalarConversion() [1/2] . . . . . . . . . . . . . . . . . . . . . . . . . 139

Generated by Doxygen
 xi

7.30.3.5 ExecuteScalarConversion() [2/2] . . . . . . . . . . . . . . . . . . . . . . . . . 139

7.30.3.6 ExpandKey() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
7.30.3.7 GetMeasureName() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
7.30.3.8 GetName() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
7.30.3.9 GetQualityMeasure() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
7.30.3.10 ScalarConversion() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
7.30.3.11 SetQualityMeasure() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
7.30.3.12 Sigmoid() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
7.30.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
7.30.4.1 configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
7.30.4.2 m_measure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
7.30.4.3 m_sigmoidMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
7.31 OFIQ_LIB::modules::measures::MeasureFactory Class Reference . . . . . . . . . . . . . . . . . . 142
7.31.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
7.31.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
7.31.2.1 MeasureFactory() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
7.31.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
7.31.3.1 CreateMeasure() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
7.32 OFIQ_LIB::modules::measures::MouthClosed Class Reference . . . . . . . . . . . . . . . . . . . 143
7.32.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
7.32.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
7.32.2.1 MouthClosed() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
7.32.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
7.32.3.1 Execute() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
7.33 OFIQ_LIB::modules::measures::MouthOcclusionPrevention Class Reference . . . . . . . . . . . . 146
7.33.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
7.33.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
7.33.2.1 MouthOcclusionPrevention() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
7.33.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
7.33.3.1 Execute() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
7.34 OFIQ_LIB::modules::measures::NaturalColour Class Reference . . . . . . . . . . . . . . . . . . . 148
7.34.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
7.34.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
7.34.2.1 NaturalColour() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
7.34.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
7.34.3.1 CalculateScore() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
7.34.3.2 CreateMaskedImage() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
7.34.3.3 Execute() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
7.34.3.4 ReduceImageToRegionOfInterest() . . . . . . . . . . . . . . . . . . . . . . . . . 151
7.35 OFIQ_LIB::NeuronalNetworkContainer Struct Reference . . . . . . . . . . . . . . . . . . . . . . . 151
7.35.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
7.35.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

Generated by Doxygen
xii

7.35.2.1 NeuronalNetworkContainer() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

7.35.3 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
7.35.3.1 faceDetector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
7.35.3.2 faceOcclusionExtractor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
7.35.3.3 landmarkExtractor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
7.35.3.4 poseEstimator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
7.35.3.5 segmentationExtractor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
7.36 OFIQ_LIB::modules::measures::NoHeadCoverings Class Reference . . . . . . . . . . . . . . . . . 154
7.36.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
7.36.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
7.36.2.1 NoHeadCoverings() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
7.36.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
7.36.3.1 Execute() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
7.36.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
7.36.4.1 m_t0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
7.36.4.2 m_t1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
7.36.4.3 m_w . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
7.36.4.4 m_x0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
7.37 OFIQ_LIB::OFIQError Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
7.37.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
7.37.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
7.37.2.1 OFIQError() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
7.37.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
7.37.3.1 what() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
7.37.3.2 whatCode() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
7.37.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
7.37.4.1 m_extendedMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
7.37.4.2 m_message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
7.37.4.3 m_returnCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
7.38 OFIQ_LIB::OFIQImpl Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
7.38.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
7.38.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
7.38.2.1 OFIQImpl() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
7.38.2.2 ∼OFIQImpl() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
7.38.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
7.38.3.1 alignFaceImage() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
7.38.3.2 CreateExecutor() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
7.38.3.3 CreateNetworks() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
7.38.3.4 initialize() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
7.38.3.5 performPreprocessing() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
7.38.3.6 scalarQuality() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
7.38.3.7 vectorQuality() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

Generated by Doxygen
 xiii

7.38.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

7.38.4.1 config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
7.38.4.2 dummyAssement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
7.38.4.3 dummyImage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
7.38.4.4 m_emptySession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
7.38.4.5 m_executorPtr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
7.38.4.6 networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
7.39 ONNXRuntimeSegmentation Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
7.39.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
7.39.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
7.39.2.1 ONNXRuntimeSegmentation() . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
7.39.2.2 ∼ONNXRuntimeSegmentation() . . . . . . . . . . . . . . . . . . . . . . . . . . 165
7.39.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
7.39.3.1 getNumberOfOutputNodes() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
7.39.3.2 init_session() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
7.39.3.3 initialize() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
7.39.3.4 run() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
7.39.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
7.39.4.1 m_inputShape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
7.39.4.2 m_memoryInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
7.39.4.3 m_ortenv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
7.39.4.4 m_ortSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
7.40 OFIQ_LIB::modules::measures::OverExposurePrevention Class Reference . . . . . . . . . . . . . 167
7.40.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
7.40.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
7.40.2.1 OverExposurePrevention() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
7.40.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
7.40.3.1 Execute() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
7.41 OFIQ_LIB::modules::landmarks::PartExtractor Class Reference . . . . . . . . . . . . . . . . . . . 169
7.41.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
7.41.2 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
7.41.2.1 getFacePart() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
7.41.2.2 getPairsForPart() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
7.42 Point2f Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
7.42.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
7.42.2 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
7.42.2.1 x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
7.42.2.2 y . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
7.43 OFIQ_LIB::Point2i Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
7.43.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
7.43.2 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
7.43.2.1 x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

Generated by Doxygen
xiv

7.43.2.2 y . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
7.44 OFIQ_LIB::PoseEstimatorInterface Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . 172
7.44.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
7.44.2 Member Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
7.44.2.1 EulerAngle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
7.44.3 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
7.44.3.1 ∼PoseEstimatorInterface() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
7.44.4 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
7.44.4.1 estimatePose() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
7.44.4.2 updatePose() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
7.44.5 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
7.44.5.1 m_lastSessionId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
7.44.5.2 m_pose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
7.45 OFIQ::QualityMeasureResult Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
7.45.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
7.45.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
7.45.2.1 QualityMeasureResult() [1/2] . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
7.45.2.2 QualityMeasureResult() [2/2] . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
7.45.3 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
7.45.3.1 code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
7.45.3.2 rawScore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
7.45.3.3 scalar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
7.46 OFIQ::ReturnStatus Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
7.46.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
7.46.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
7.46.2.1 ReturnStatus() [1/2] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
7.46.2.2 ReturnStatus() [2/2] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
7.46.3 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
7.46.3.1 code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
7.46.3.2 info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
7.47 OFIQ_LIB::SegmentationExtractorInterface Class Reference . . . . . . . . . . . . . . . . . . . . . 177
7.47.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
7.47.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
7.47.2.1 ∼SegmentationExtractorInterface() . . . . . . . . . . . . . . . . . . . . . . . . . 178
7.47.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
7.47.3.1 GetLastSessionId() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
7.47.3.2 GetMask() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
7.47.3.3 UpdateMask() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
7.47.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
7.47.4.1 m_lastSessionId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
7.47.4.2 m_masks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
7.48 OFIQ_LIB::Session Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

Generated by Doxygen
 xv

7.48.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

7.48.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
7.48.2.1 Session() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
7.48.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
7.48.3.1 assessment() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
7.48.3.2 GenerateId() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
7.48.3.3 getAlignedFace() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
7.48.3.4 getAlignedFaceLandmarkedRegion() . . . . . . . . . . . . . . . . . . . . . . . . 182
7.48.3.5 getAlignedFaceLandmarks() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
7.48.3.6 getAlignedFaceTransformationMatrix() . . . . . . . . . . . . . . . . . . . . . . . 183
7.48.3.7 getDetectedFaces() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
7.48.3.8 getFaceOcclusionSegmentationImage() . . . . . . . . . . . . . . . . . . . . . . 183
7.48.3.9 getFaceParsingImage() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
7.48.3.10 getLandmarks() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
7.48.3.11 getPose() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
7.48.3.12 Id() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
7.48.3.13 image() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
7.48.3.14 setAlignedFace() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
7.48.3.15 setAlignedFaceLandmarkedRegion() . . . . . . . . . . . . . . . . . . . . . . . 185
7.48.3.16 setAlignedFaceLandmarks() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
7.48.3.17 setAlignedFaceTransformationMatrix() . . . . . . . . . . . . . . . . . . . . . . . 185
7.48.3.18 setDetectedFaces() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
7.48.3.19 setFaceOcclusionSegmentationImage() . . . . . . . . . . . . . . . . . . . . . . 186
7.48.3.20 setFaceParsingImage() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
7.48.3.21 setLandmarks() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
7.48.3.22 setPose() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
7.48.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
7.48.4.1 m_alignedFace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
7.48.4.2 m_alignedFacelandmarkedRegion . . . . . . . . . . . . . . . . . . . . . . . . . 187
7.48.4.3 m_alignedFaceLandmarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
7.48.4.4 m_alignedFaceTransformationMatrix . . . . . . . . . . . . . . . . . . . . . . . . 187
7.48.4.5 m_assessment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
7.48.4.6 m_detectedFaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
7.48.4.7 m_faceOcclusionSegmentationImage . . . . . . . . . . . . . . . . . . . . . . . . 188
7.48.4.8 m_faceParsingImage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
7.48.4.9 m_id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
7.48.4.10 m_image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
7.48.4.11 m_landmarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
7.48.4.12 m_pose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
7.49 OFIQ_LIB::modules::measures::Sharpness Class Reference . . . . . . . . . . . . . . . . . . . . . 189
7.49.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
7.49.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

Generated by Doxygen
xvi

7.49.2.1 Sharpness() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

7.49.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
7.49.3.1 Execute() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
7.49.3.2 GetClassifierFocusFeatures() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
7.49.3.3 GetCroppedImages() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
7.49.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
7.49.4.1 m_faceRegionAlpha . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
7.49.4.2 m_modelFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
7.49.4.3 m_numTrees . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
7.49.4.4 m_rtree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
7.49.4.5 m_useAligned . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
7.50 OFIQ_LIB::modules::measures::SigmoidParameters Struct Reference . . . . . . . . . . . . . . . . 193
7.50.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
7.50.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
7.50.2.1 SigmoidParameters() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
7.50.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
7.50.3.1 Reset() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
7.50.3.2 setInverse() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
7.50.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
7.50.4.1 a . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
7.50.4.2 h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
7.50.4.3 round . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
7.50.4.4 s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
7.50.4.5 w . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
7.50.4.6 x0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
7.51 OFIQ_LIB::modules::measures::SingleFacePresent Class Reference . . . . . . . . . . . . . . . . 195
7.51.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
7.51.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
7.51.2.1 SingleFacePresent() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
7.51.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
7.51.3.1 Execute() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
7.52 OFIQ_LIB::modules::detectors::SSDFaceDetector Class Reference . . . . . . . . . . . . . . . . . 197
7.52.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
7.52.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
7.52.2.1 SSDFaceDetector() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
7.52.2.2 ∼SSDFaceDetector() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
7.52.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
7.52.3.1 UpdateFaces() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
7.52.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
7.52.4.1 m_confidenceThreshold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
7.52.4.2 m_dnnNet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
7.52.4.3 m_minimalRelativeFaceSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

Generated by Doxygen
 xvii

7.52.4.4 m_padding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

7.53 OFIQ_LIB::modules::measures::UnderExposurePrevention Class Reference . . . . . . . . . . . . 200
7.53.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
7.53.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
7.53.2.1 UnderExposurePrevention() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
7.53.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
7.53.3.1 Execute() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
7.54 OFIQ_LIB::modules::measures::UnifiedQualityScore Class Reference . . . . . . . . . . . . . . . . 202
7.54.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
7.54.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
7.54.2.1 UnifiedQualityScore() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
7.54.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
7.54.3.1 Execute() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
7.54.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
7.54.4.1 m_onnxRuntimeEnv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

8 File Documentation 205

8.1 mainpage.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
8.1.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
8.2 mainpage.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
8.3 ofiq_lib.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
8.3.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
8.3.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
8.3.2.1 OFIQ_EXPORT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
8.4 ofiq_lib.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
8.5 ofiq_lib_impl.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
8.5.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
8.6 ofiq_lib_impl.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
8.7 ofiq_structs.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
8.7.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
8.8 ofiq_structs.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
8.9 AllDetectors.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
8.9.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
8.10 AllDetectors.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
8.11 detectors.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
8.11.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
8.12 detectors.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
8.13 opencv_ssd_face_detector.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
8.13.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
8.14 opencv_ssd_face_detector.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
8.15 adnet_FaceMap.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
8.15.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

Generated by Doxygen
xviii

8.16 adnet_FaceMap.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

8.17 adnet_landmarks.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
8.17.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
8.18 adnet_landmarks.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
8.19 AllLandmarks.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
8.19.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
8.20 AllLandmarks.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
8.21 FaceMeasures.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
8.21.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
8.22 FaceMeasures.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
8.23 FaceParts.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
8.23.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
8.24 FaceParts.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
8.25 landmarks.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
8.25.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
8.26 landmarks.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
8.27 PartExtractor.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
8.27.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
8.28 PartExtractor.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
8.29 AllMeasures.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
8.29.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
8.30 AllMeasures.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
8.31 BackgroundUniformity.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
8.31.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
8.32 BackgroundUniformity.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
8.33 CompressionArtifacts.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
8.33.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
8.34 CompressionArtifacts.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
8.35 CropOfTheFaceImage.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
8.35.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
8.36 CropOfTheFaceImage.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
8.37 DynamicRange.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
8.37.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
8.38 DynamicRange.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
8.39 Executor.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
8.39.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
8.40 Executor.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
8.41 ExpressionNeutrality.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
8.41.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
8.42 ExpressionNeutrality.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
8.43 EyesOpen.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
8.43.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

Generated by Doxygen
 xix

8.44 EyesOpen.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

8.45 EyesVisible.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
8.45.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
8.46 EyesVisible.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
8.47 FaceOcclusionPrevention.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
8.47.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
8.48 FaceOcclusionPrevention.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
8.49 HeadPose.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
8.49.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
8.50 HeadPose.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
8.51 HeadSize.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
8.51.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
8.52 HeadSize.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
8.53 IlluminationUniformity.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
8.53.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
8.54 IlluminationUniformity.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
8.55 InterEyeDistance.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
8.55.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
8.56 InterEyeDistance.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
8.57 Luminance.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
8.57.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
8.58 Luminance.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
8.59 Measure.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
8.59.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
8.60 Measure.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
8.61 MeasureFactory.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
8.61.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
8.62 MeasureFactory.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
8.63 MouthClosed.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
8.63.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
8.64 MouthClosed.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
8.65 MouthOcclusionPrevention.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
8.65.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
8.66 MouthOcclusionPrevention.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
8.67 NaturalColour.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
8.67.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
8.68 NaturalColour.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
8.69 NoHeadCoverings.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
8.69.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
8.70 NoHeadCoverings.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
8.71 OverExposurePrevention.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
8.71.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

Generated by Doxygen
xx

8.72 OverExposurePrevention.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

8.73 Sharpness.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
8.73.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
8.74 Sharpness.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
8.75 SingleFacePresent.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
8.75.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
8.76 SingleFacePresent.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
8.77 UnderExposurePrevention.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
8.77.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
8.78 UnderExposurePrevention.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
8.79 UnifiedQualityScore.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
8.79.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
8.80 UnifiedQualityScore.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
8.81 AllPoseEstimators.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
8.81.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
8.82 AllPoseEstimators.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
8.83 HeadPose3DDFAV2.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
8.83.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
8.84 HeadPose3DDFAV2.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
8.85 poseEstimators.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
8.85.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
8.86 poseEstimators.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
8.87 FaceOcclusionSegmentation.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
8.87.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
8.88 FaceOcclusionSegmentation.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
8.89 FaceParsing.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
8.89.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
8.90 FaceParsing.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
8.91 ONNXRTSegmentation.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
8.91.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
8.92 ONNXRTSegmentation.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
8.93 segmentations.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
8.93.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
8.94 segmentations.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
8.95 Configuration.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
8.95.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
8.96 Configuration.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
8.97 image_io.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
8.97.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
8.98 image_io.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
8.99 image_utils.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
8.99.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279

Generated by Doxygen
 xxi

8.100 image_utils.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279

8.101 NeuronalNetworkContainer.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
8.102 NeuronalNetworkContainer.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
8.103 OFIQError.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
8.103.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
8.104 OFIQError.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
8.105 Session.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
8.105.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
8.106 Session.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
8.107 utils.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
8.107.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
8.108 utils.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286

Index 289

Generated by Doxygen
Chapter 1

Open Source Face Image Quality (OFIQ)

Library

1.1 Introduction

OFIQ (Open Source Face Image Quality) is a software library for computing quality aspects of a facial image. OFIQ
is written in the C/C++ programming language. OFIQ is the reference implementation for the ISO/IEC 29794-5
international standard; see https://bsi.bund.de/dok/OFIQ-e.

1.2 License

This is the source code of OFIQ. OFIQ is a software for assessing the quality of facial image properties and potential
defects. OFIQ is licensed under the MIT licenses (see text below). It includes dependencies that may be licensed
otherwise. A documentation on the license situation of dependencies can be found in the table below.

1.2.1 OFIQ License

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

1.2.2 License of dependencies

In the table the license situation of the files shipped with the OFIQ source is documented.

Generated by Doxygen
2 Open Source Face Image Quality (OFIQ) Library

File/directory Description Reference Original license

CMakeLists.txt CMake file for building OFIQ - OFIQ license
README.md Readme file - OFIQ license
LICENSE.md File containing license infor- - OFIQ license
mation
Version.txt Contains OFIQ's current - OFIQ license
version information.
cmake/ Folder containing cmake https://cmake.←- OFIQ license
helper scripts org/
data/ofiq_config.jaxn OFIQ's configuration file - OFIQ license
data/models/ Folder containing a single - -
readme file; to this folder,
model files are downloaded
from the ISO portal when
running one of the building
scripts. Note, the readme
file is subject to OFIQ's li-
cense. The license situ-
ation of the model files is
documented separately in li-
cense files placed in the
sub-directories after down-
load.
data/tests/expected_←- CSV file with expected - OFIQ license
results/expected_results.←- native quality scores and
csv quality component values
used for running confor-
mance tests.
data/tests/images/ Folder containing a single - -
readme file; to this folder,
conformance test images
are downloaded from the
ISO portal when running
one of the building scripts.
Note, the readme file is
subject to OFIQ's license.
The license situation of the
image files is documented
separately in a license file
downloaded with the im-
ages.
conan/ Directory containing files https://conan.io/ OFIQ license
that are used for the Conan
package manager.
OFIQlib/ Directory containing the - OFIQ license
OFIQ source code (includ-
ing headers).
doc/src/mainpage.h Doxygen documentation of - OFIQ license
OFIQ

Generated by Doxygen
1.2 License 3

File/directory Description Reference Original license

doc/src/ofiq-doxygen.cfg Configuration for building https://www.←- mixed
doxygen documentation. doxygen.org/
Has been generated by
doxygen and was edited
afterwards. May be affected
by copyleft. Was used to
generate doc/refman.pdf
which does not, however,
need to be linked with any
software compilation using
OFIQ.
doc/refman.pdf Documentation of OFIQ. https://www.←- mixed
Generated by doxygen and doxygen.org/,
LaTeX. The documenta- https://www.←-
tion does not need to be latex-project.org/
linked with any software
compilation using OFIQ.
scripts/build.cmd Script for building OFIQ-←- - OFIQ license
Release on Windows; in-
cludes steps for installing
packages via conan and
downloading models and
conformance test images
from ISO portal.
scripts/build_debug.cmd Script for building OFIQ-←- - OFIQ license
Debug on Windows; in-
cludes steps for installing
packages via conan and
downloading models and
conformance test images
from ISO portal.
scripts/build.sh Script for building OFIQ-←- - OFIQ license
Release on Linux; includes
steps for installing pack-
ages via conan and down-
loading models and confor-
mance test images from ISO
portal.
scripts/build_debug.sh Script for building OFIQ-←- - OFIQ license
Debug on Linux; includes
steps for installing pack-
ages via conan and down-
loading models and confor-
mance test images from ISO
portal.
scripts/conformance_←- Runs conformance tests - OFIQ license
tests.cmd with OFIQ-Release on
Windows
scripts/conformance_←- Runs conformance tests - OFIQ license
tests_debug.cmd with OFIQ-Debug on Win-
dows
scripts/conformance_←- Runs conformance tests - OFIQ license
tests.sh with OFIQ-Release on Linux
scripts/conformance_←- Runs conformance tests - OFIQ license
tests_debug.sh with OFIQ-Debug on Linux

Generated by Doxygen
4 Open Source Face Image Quality (OFIQ) Library

File/directory Description Reference Original license

testing/ Directory containing OFIQ - OFIQ license
source code running confor-
mance tests

1.3 Compilation

To build OFIQ you need to install Python with pip, cmake and conan.

• Python (version 3.10.12 or higher)

• Download and install cmake (version 3.26 or higher)

• Download and install conan (version 2.0.17)

1.3.1 Linux

1.3.1.1 Ubuntu 22.04 (x86_64)

Install necessary packages.

$ sudo apt-get install build-essential python3-pip

To install cmake (in a version 3.26 or higher) use snap (and not apt) as follows.

$ sudo snap install cmake --classic

Conan is installed via Python with

pip install conan==2.0.17

In order to build OFIQ and installing all required packages via conan run the following.

$ cd /path/to/OFIQ_Project/scripts
$ sh build.sh

where /path/to/OFIQ_Project/ denotes the root folder of the OFIQ source files.
This will create the following output.

file/directory description
build/ Folder with the Linux build including the binaries OFIQSampleApp and libofiq←-
_lib.so.
build/conan/ Conan cache with packages downloaded.
install_x86_64_linux/ Folder with the installation including the binaries Release/bin/OFIQSampleApp,
Release/lib/libofiq_lib.so, Release/lib/libonnxruntime.←-
so.1.17.3, and the header files in Release/include/.
data/models/ Model files downloaded from the ISO portal during build process.
data/tests/images/ Conformance test images downloaded from the ISO portal.
Generated by Doxygen
1.3 Compilation 5

1.3.1.2 Ubuntu 24.04 (x86_64)

Install necessary packages.

$ sudo apt-get install build-essential python3-pip cmake python3.12-venv

To install conan, a virtual Python environment needs to be generated first.

$ python3 -m venv /path/to/py_ofiq_env

where /path/to/py_ofiq_env is the path where the python environment will be stored and py_ofiq_env
is the name of the new environment. Then install conan as follows.

$ source /path/to/py_ofiq_env/bin/activate
$ pip install conan==2.0.17

In order to build OFIQ and installing all required packages via conan run the following.

$ source /path/to/py_ofiq_env/bin/activate
$ cd /path/to/OFIQ_Project/scripts
$ sh build.sh

where /path/to/OFIQ_Project/ denotes the root folder of the OFIQ source files.
This will create the following output.

file/directory description
build/ Folder with the Linux build including the binaries OFIQSampleApp and libofiq←-
_lib.so.
build/conan/ Conan cache with packages downloaded.
install_x86_64_linux/ Folder with the installation including the binaries Release/bin/OFIQSampleApp,
Release/lib/libofiq_lib.so, Release/lib/libonnxruntime.←-
so.1.17.3, and the header files in Release/include/.
data/models/ Model files downloaded from the ISO portal during build process.
data/tests/images/ Conformance test images downloaded from the ISO portal.

1.3.2 Windows

1.3.2.1 Windows (x86_64)

The following has been tested on a Windows 10 (64 bit) installation using a Python installation version 3.11.5 with
pip package such that the pip command can be executed from the command prompt. Furthermore, an installation
of cmake version 3.29 has been used. As the compiler, Microsoft's Visual Studio 2019 was used.

To install conan, run

$ pip install conan==2.0.17

from the command prompt.

In order to build OFIQ and install all required packages run the following.

Generated by Doxygen
6 Open Source Face Image Quality (OFIQ) Library

$ cd C:\Path\To\OFIQ_Project\scripts\
$ .\build.cmd

where C:\Path\To\OFIQ-Project\ denotes the root folder of the OFIQ source files.
This will create the following output.

file/directory description
build\build_win\ Folder with the Visual Studio solution files placed and pre-compilation.
build\conan\ Conan cache with packages downloaded.
install_x86_64\ Folder with the OFIQ installation files. This includes the binaries
Release\bin\OFIQSampleApp, Release\bin\libofiq_lib.so,
Release\bin\libonnxruntime.so.1.17.3, and the header files in
Release\include\.
data\models\ Model files downloaded from the ISO portal during build process.
data\tests\images\ Conformance test images downloaded from the ISO portal.

1.3.2.2 Windows (x86)

To compile Win32 binaries, one proceeds in the same way as for x86_64 described above. But the building script is
run with the -arch x86 argument:

$ cd C:\Path\To\OFIQ_Project\scripts\
$ .\build.cmd --arch x86

1.4 MacOS

1.4.0.1 MacOS (ARM64)

The following has been tested on macOS Sonoma Version 14.4.1 with ARM64 processor.

Install Homebrew

$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Then update profiles

$ (echo; echo ’eval "$(/opt/homebrew/bin/brew shellenv)"’) >> ~/.zprofile

$ eval "$(/opt/homebrew/bin/brew shellenv)"

where /opt/homebrew/bin/brew is the path to the homebrew executable and can vary among MacOS
systems.

NOTE The two commands from above for updating profiles are output by the Homebrew installation script.

Install CMake.

Generated by Doxygen
1.4 MacOS 7

$ brew install cmake

Install Python using Miniconda by

$ mkdir -p /path/to/miniconda3/
$ curl https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-arm64.sh -o /path/to/minicond
$ bash /path/to/miniconda3/miniconda.sh -b -u -p /path/to/miniconda3
$ rm -rf /path/to/miniconda3/miniconda.sh
$ /path/to/miniconda3/bin/conda init bash
$ /path/to/miniconda3/bin/conda init zsh

where /path/to/miniconda3 can be replaced by the path where Miniconda is installed.

Install conan.

$ python -m pip install conan==2.0.17

Finally, to build OFIQ run the following.

$ cd /path/to/OFIQ_Project/scripts/
$ sh build.sh --os macos

1.4.1 MacOS (x86_64)

To compile OFIQ on MacOS x86_64 one needs to edit /path/to/OFIQ_Project/conan/conan←-

_profile_release_macos.txt and /path/to/OFIQ_Project/conan/conan_profile_←-
debug_macos.txt first. In both files replace the line

arch=armv8

by

arch=x86_64

Then apply the same actions as for MacOS compilation on ARM64.

1.4.2 Download model files

To run OFIQ, the model files from the ISO portal need to be downloaded and be placed in the
./data/models/ directory so that the file structure matches the following.

/path/to/OFIQ-Project/data/models/expression_neutrality/∗
/path/to/OFIQ-Project/data/models/face_detection/∗
/path/to/OFIQ-Project/data/models/face_landmark_estimation/∗
/path/to/OFIQ-Project/data/models/face_occlusion_segmentation/∗
/path/to/OFIQ-Project/data/models/face_parsing/∗
Generated by Doxygen /path/to/OFIQ-Project/data/models/head_pose_estimation/∗
/path/to/OFIQ-Project/data/models/no_compression_artifacts/∗
/path/to/OFIQ-Project/data/models/sharpness/∗
/path/to/OFIQ-Project/data/models/unified_quality_score/∗
8 Open Source Face Image Quality (OFIQ) Library

Here, /path/to/OFIQ-Project/ denotes the path to OFIQ's root folder.

This step is integrated in the cmake building process.

1.4.3 Download conformance test images

To run conformance tests, the conformance test images need to be downloaded from the ISO portal and
be placed in the ./data/tests/images/ directory so that the file structure matches the following.

/path/to/OFIQ-Project/data/tests/images/b-01-smile.png
...
/path/to/OFIQ-Project/data/tests/images/r-09-background.png

Here, /path/to/OFIQ-Project/ denotes the path to OFIQ's root folder. Download and extraction of
conformance test images can be performed when running the cmake building process.

1.4.4 Download of external libraries

The source of the external libraries that are used by OFIQ can be downloaded from the ISO portal.

NOTE: At the date of publication, the link to the external libraries were not available.

To build OFIQ without conan (described below), we need to extract the archive so that file structure matches
the following:

/path/to/OFIQ-Project/extern/di/∗
/path/to/OFIQ-Project/extern/flatbuffers/∗
/path/to/OFIQ-Project/extern/googletest/∗
/path/to/OFIQ-Project/extern/json/∗
/path/to/OFIQ-Project/extern/magic_enum/∗
/path/to/OFIQ-Project/extern/onnxruntime/∗
/path/to/OFIQ-Project/extern/openvc-4.5.5/∗
/path/to/OFIQ-Project/extern/PEGTL/∗
/path/to/OFIQ-Project/extern/spdlog/∗

Here, /path/to/OFIQ-Project/ denotes the path to OFIQ's root folder.

Note, download and extraction of the external libraries can be done automatically by the cmake building pro-
cess described below.

1.4.5 Building without conan

To build OFIQ without conan, one can run

Generated by Doxygen
1.5 Running conformance tests 9

$ cd C:\Path\To\OFIQ-Project\scripts\
$ .\build.cmd --no-conan

on Windows or

$ cd /path/to/OFIQ-Project/scripts/
$ sh build.sh --no-conan

on Linux and MacOS. This will download and extract the model files, conformance test images, and external
libraries from the ISO portal as described above.

To suppress download of the dependencies (e.g., when one wants to compile without an internet connection),
one can run

$ cd C:\Path\To\OFIQ-Project\scripts\
$ .\build.cmd --no-conan --no-download

on Windows or

$ cd /path/to/OFIQ-Project/scripts/
$ sh build.sh --no-conan --no-download

on Linux and MacOS. Note that this requires that the extraction of model files and external library dependencies
(and perhaps conformance test images) is done manually before running the building scripts.

1.5 Running conformance tests

The conformance tests are executed by going to /path/to/OFIQ_Project/scripts/ and run

conformance_tests.cmd (Windows). conformance_tests.sh (Linux). conformance_tests.sh
-os (MacOS).

1.6 Running the sample executable

In this section, we describe how to run the sample application of OFIQ after compilation.

1.6.1 Quality assessment for a single facial image

The sample application takes an images and outputs the computed quality assessments. For example, to output
the quality assessments for one of the conformance test images using OFIQ's configuration (in ./data), run the
following commands on Linux.

$ cd /path/to/OFIQ-Project/install_x86_64_linux/Release/bin/
$ ./OFIQSampleApp -c ../../../data/ofiq_config.jaxn -i
../../../data/tests/images/b-01-smile.png

On Windows run the following commands.

$ cd C:\Path\To\OFIQ-Project\install_x86_64\Release\bin
$ .\OFIQSampleApp -c ..\..\..\data\ofiq_config.jaxn -i
..\..\..\data\tests\images\b-01-smile.png

Generated by Doxygen
10 Open Source Face Image Quality (OFIQ) Library

1.6.2 Quality assessment for multiple images

To reproduce the conformance test table given in Annex A of the ISO/IEC 29794-5 international standard for all
conformance test images, run the following commands on Linux.

$ cd /path/to/OFIQ-Project/install_x86_64_linux/Release/bin/
$ ./OFIQSampleApp -c ../../../data/ofiq_config.jaxn -i
../../../data/tests/images/ -o table.csv

The result will be written in the file /path/to/OFIQ_Project/install_x86_64_linux/←-

Release/bin/table.csv.

On Windows run the following commands.

$ cd C:\Path\To\OFIQ-Project\install_x86_64\Release\bin\
$ .\OFIQSampleApp -c ..\..\..\data\ -i
..\..\..\data\tests\images\ -o table.csv

The result will be written in the file C:\Path\To\OFIQ-Project\install_x86_64\Release\bin\table.←-

csv.

1.6.3 Arguments

The usage pattern of the sample application is the following.

OFIQSampleApp
-c <directory or file path>
[-cf <config file name>]
-i <directory or image file path>
[-o <csv file path>]

The following table documents the usage of the sample application.

flag argument
-c Path to a directory containing the file ofiq_config.jaxn or a path to a JAXN configuration file (see
doc/refman.pdf).
-cf Name of the JAXN configuration file contained in the directory specified by the flag -c. Must be omitted if
-c specifies a path to a file.
-i Path to a directory containing facial images or a path to a facial image file. If a directory path is specified,
all images in PNG and JPEG format will be processed.
-o Path to a CSV file to where the quality assessment is written. If -o is not specified, the output is written to
the standard output.

1.7 Supported platforms

OFIQ compilation has been successfully tested to compile and run on a variety of platforms. The following table
gives an overview of platforms that have been successfully tested by the OFIQ development team.

Generated by Doxygen
1.8 Precompiled binaries 11

platform compiler compiles via building remarks

script?
Ubuntu 22.04 (x86_64) g++ 11.4.0 yes -
Ubuntu 24.04 (x86_64) g++ 13.2.0 yes -
Windows 10 (x86_←- Visual Studio 2019 yes To compile external li-
64/win64) braries, i.e., to run com-
pilation without conan, an
installation of Visual Stu-
dio 2022 was used which
was required to build the
onnxruntime depency.
Windows 10 (x86/win32) Visual Studio 2019 yes Building script needs spec-
ification of the argument
-arch x86. To compile
external libraries, i.e., to run
compilation without conan,
an installation of Visual Stu-
dio 2022 was used which
was required to build the
onnxruntime depency.
MacOS (ARM64) clang 15.0.0 yes Building script needs spec-
ification of the argument
-os macos.
MacOS (x86_64) clang 15.0.0 yes Building script needs spec-
ification of the arguments
-os macos. Further-
more, see the details
on compiling for MacOS
(x86_64) above.
Android clang 12.0.8 no Manual compilation includ-
ing linking of dependencies
is required. Not supported
by OFIQ's building scripts.
iOS clang 15.0.0 no Manual compilation includ-
ing linking of dependencies
is required. Not supported
by OFIQ's building scripts.

OFIQ may compile on other configurations that have not been tested by the OFIQ development team. Compilation
for 32-bit Linux systems, however, were not successful due to the onnxruntime being not supported by 32-bit gcc
compiler. Also, compilation on Windows using gcc (for 32- nor 64-bit) did not work since onnxruntime did not build.

1.8 Precompiled binaries

A set of pre-compiled library binaries and the OFIQSampleApp will be made available on the ISO portal:
https://standards.iso.org/iso-iec/29794/-5/ed-1/en/

1.9 Configuration

In this section, we describe the configuration file for OFIQ. OFIQ uses a JSON-like configuration based on the
taoJSON library. Using taoJSON, OFIQ reads its configuration from a JAXN-formatted file.

A minimal configuration working with OFIQ looks as follows.

Generated by Doxygen
12 Open Source Face Image Quality (OFIQ) Library

{
"config": {
"detector": "ssd",
"landmarks": "ADNet",
"measures": [
"UnifiedQualityScore"
],
"params": {
"detector": {
"ssd": {
"model_path": "models/face_detection/ssd_facedetect.caffemodel",
"prototxt_path": "models/face_detection/ssd_facedetect.prototxt.txt",
"confidence_thr": 0.4,
"min_rel_face_size": 0.01,
"padding": 0.2
}
},
"landmarks": {
"ADNet": {
"model_path": "models/face_landmark_estimation/ADNet.onnx"
}
},
"measures": {
"UnifiedQualityScore": {
"model_path": "models/unified_quality_score/magface_iresnet50_norm.onnx"
},
"HeadPose": {
"model_path": "models/head_pose_estimation/mb1_120x120.onnx"
},
"FaceOcclusionSegmentation": {
"model_path": "models/face_occlusion_segmentation/face_occlusion_segmentation_ort.onnx"
},
"FaceParsing": {
"model_path": "models/face_parsing/bisenet_400.onnx"
}
}
}
}
}

OFIQ's C/C++ library provides the class Configuration which is responsible for reading and managing JAXN config-
urations.

Note that the model paths are specified as paths relative to the directory of the JAXN configuration file. We
assume that the file above is stored in <OFIQ-SOURCE>/data.

1.9.1 Configuration of the face detector

The face detector (SSD) must be configured explicitly:

{
"config": {
"detector": "ssd",
...
}
}

Generated by Doxygen
1.9 Configuration 13

Additionally, the path to the model file and other parameters need to be configured:

{
...
"params": {
"detector": {
"ssd": {
"model_path": "models/face_detection/ssd_facedetect.caffemodel",
"prototxt_path": "models/face_detection/ssd_facedetect.prototxt.txt",
"confidence_thr": 0.4,
"min_rel_face_size": 0.01,
"padding": 0.2
}
},
...
}

A documentation on the parameters are given in the following table.

Parameter Description
model_path path to the SSD model file in CAFEE format
prototxt_path path to SSD's CAFFE protype file
confidence_thr minimum value for the confidence the detected faces; detected faces with a lower confi-
dence are discarded. Note, the specified value 0.4 (fixed for OFIQ) has been determined
experimentally.
min_rel_face_size the minimum width of the face bounding boxes relative to the width w of the input image;
detected faces, with a bounding box width smaller than min_rel_face_size∗w are discarded.
Note, the specified value 0.01 (fixed for OFIQ) has been determined experimentally.
padding horizontal and vertical padding of the original image prior face detection. Note, the specified
value 0.2 (fixed for OFIQ) has been determined experimentally.

1.9.2 Configuration of the landmark extractor

The face landmark extractor (ADNet) must be configured explicitly:

{
"config": {
...
"landmarks": "ADNet",
...
}
}

Additionally, the path to the ADNet model file in ONNX format needs to be configured:

{
...
"params": {
...
"landmarks": {
"ADNet": {
"model_path": "models/face_landmark_estimation/ADNet.onnx"
}
},
...
}

Generated by Doxygen
14 Open Source Face Image Quality (OFIQ) Library

1.9.3 Other required configurations

As suggested by the minimal configuration file given in Configuration, there are model files that need to be configured
and their configurations cannot be omitted. These model files are detailed in the following table and shall be
configured in the "config"."measures" environment.

Algorithm Description
HeadPose Head pose angles are pre-processed and used by some measures; therefore,
the measure shall be configured. The path to the 3DDFAV2 model file in
ONNX format should be set using the model_path key.
FaceOcclusionSegmentation Face occlusion segmentation pre-processing used by some measures assess-
ing occlusion prevention. The path to the FaceExtraction model file in
ONNX format should be set using the model_path key. NOTE: The OFIQ de-
velopment team has been permitted by the FaceExtraction authors for inclusion
of the model in OFIQ without any restrictions; therefore, the referenced ONNX
model file is subject to the OFIQ license agreement.
FaceParsing Face parsing is pre-processed and used by some measures; therefore, the
measure shall be configured (even if no measure is requested that uses the
pre-processing result). The path to the BiSeNet model file in ONNX format
should be set using the model_path key.

1.9.4 Requesting measures

OFIQ implements a variety of measures for assessing properties of a facial image. For a measure to be executed
by OFIQ, it must be explicitly requested. For example, to only request the unified quality score measure, one can
request it as follows.

{
"config": {
...
"measures": [
"UnifiedQualityScore"
],
...
}
}

At least one measure must be requested. An empty request list will result in OFIQ throwing an error. A full list of
requestable measures and its measure keys can be found in the table of the default configuration section.

1.9.5 Default configuration

OFIQ is the reference implementation for the ISO/IEC 29794-5 standard. To reproduce the conformance tests
of the ISO/IEC 29794-5 standard one should use the (default) configuration provided by the file <OFIQ-←-
SOURCE>/data/ofiq_config.jaxn; other configurations can be used; however, the resulting outputs of
the quality assessment may not comply with the ISO/IEC 29794-5 standard.

The entries of the default configuration are documented in the following table. Details on the algorithms can
be found in the ISO/IEC 29794-5 document. Details on the implementations can be found in the OFIQ source code.
Note, the QAA identifiers listed in the table are defined in ISO/IEC 29794-5.

Generated by Doxygen
1.9 Configuration 15

QAA identifier description config key request key configuration supports qual-
parameters ity mapping
config? - see
details here

- Face detector "config">"params".- see here -

"detector"
- Face landmark "config">"params".- see here -
estimator "landmarks"
- Face parsing "config". - see here -
"params".
"measures".
"FaceParsing"
- Face occlusion "config". - see here -
segmentation "params".
"measures".
"Face←-
Occlusion←-
Segmentation"
- Landmarked re- "config". - alpha: is 0 -
gion "params". per default and
"measures". only used for in-
"FaceRegion" ternal purposes
0x41 Unified quality "config". "config". model_←- yes
score "params". "measures". path: Path to
"measures". "Unified←- an iResNet50
"Unified←- QualityScore" model file in
QualityScore" ONNX format
0x42 Background "config". "config". none yes
uniformity "params". "measures".
"measures". "Background←-
"Background←- Uniformity"
Uniformity"
0x43 Illumination un- "config". "config". none yes
formity "params". "measures".
"measures". "Illumination←-
"Illumination←- Uniformity"
Uniformity"
0x44 Luminance "config". "config". none yes
brightness "params". "measures".
"measures". "Luminance"
"Luminance"
0x45 Luminance "config". "config". none yes
contrast "params". "measures".
"measures". "Luminance"
"Luminance"
0x46 Abscence of "config". "config". none yes
under-exposure "params". "measures".
"measures". "Under←-
"Under←- Exposure←-
Exposure←- Prevention"
Prevention"

Generated by Doxygen
16 Open Source Face Image Quality (OFIQ) Library

0x47 Abscence of "config". "config". none yes

over-exposure "params". "measures".
"measures". "Over←-
"Over←- Exposure←-
Exposure←- Prevention"
Prevention"
0x48 Pixel intensity "config". "config". none yes
variation "params". "measures".
"measures". "Dynamic←-
"Dynamic←- Range"
Range"
0x49 Sharpness "config". "config". model_←- yes
"params". "measures". path: Path
"measures". "Sharpness" to the random
"Sharpness" forest model file
0x4A Abscence of "config". "config". model_←- yes
compression "params". "measures". path: Path to
artifacts "measures". "No←- OFIQ's com-
"No←- Compression←- pression artifact
Compression←- Artifacts" CNN in ONNX
Artifacts" format
0x4B Colour natural- "config". "config". none yes
ity "params". "measures".
"measures". "NaturalColour"
"NaturalColour"
0x4C Face unique- "config". "config". none no
ness "params". "measures".
"measures". "SingleFace←-
"SingleFace←- Present"
Present"
0x4D Eyes openess "config". "config". none yes
"params". "measures".
"measures". "EyesOpen"
"EyesOpen"
0x4E Mouth closed- "config". "config". none yes
ness "params". "measures".
"measures". "MouthClosed"
"MouthClosed"
0x4F Eyes visibility "config". "config". none yes
"params". "measures".
"measures". "EyesVisible"
"EyesVisible"
0x50 Mouth occlu- "config". "config". none yes
sion prevention "params". "measures".
"measures". "Mouth←-
"Mouth←- Occlusion←-
Occlusion←- Prevention"
Prevention"
0x51 Face occlusion "config". "config". none yes
prevention "params". "measures".
"measures". "Face←-
"Face←- Occlusion←-
Occlusion←- Prevention"
Prevention"

Generated by Doxygen
1.9 Configuration 17

0x52 Inter-eye dis- "config". "config". none yes

tance length "params". "measures".
"measures". "InterEye←-
"InterEye←- Distance"
Distance"
0x53 Size of the head "config". "config". none yes - the ar-
in the image "params". "measures". gument to the
"measures". "HeadSize" quality mapping
"HeadSize" is ∥x − 0.45∥
where x is the
native quality
score

0x54 Leftward crop of "config">"params"."config". none yes

the face image "measures". "measures".
"Leftward←- "CropOfThe←-
CropOfThe←- FaceImage"
FaceImage"
0x55 Rightward crop "config">"params"."config". none yes
of the face im- "measures". "measures".
age "Rightward←- "CropOfThe←-
CropOfThe←- FaceImage"
FaceImage"
0x56 Margin above of "config">"params"."config". none yes
the face image "measures". "measures".
"Margin←- "CropOfThe←-
AboveOfThe←- FaceImage"
FaceImage"
0x57 Margin below of "config">"params"."config". none yes
the face image "measures". "measures".
"Margin←- "CropOfThe←-
BelowOfThe←- FaceImage"
FaceImage"
0x58 Pose angle "config">- "config". none no
yaw frontal "measures".
alignment "HeadPose"
0x59 Pose angle - "config". none no
pitch frontal "measures".
alignment "HeadPose"
0x5A Pose angle - "config". none no
roll frontal "measures".
alignment "HeadPose"

Generated by Doxygen
18 Open Source Face Image Quality (OFIQ) Library

0x5B Expression "config">"params"."config". cnn_model←- yes

neutrality "measures". "measures". _path1: Path
"Expression←- "Expression←- to the CNN
Neutrality" Neutrality" model enet_←-
b0_8_best_←-
vgaf_embed←-
_zeroed.onnx
derived from
here in ONNX
format

cnn_model←-
_path2:
Path to the
CNN model
enet_b2_←-
8_embed_←-
zeroed.←-
onnx derived
from here in
ONNX format.

adaboost←-
_model_←-
path: Path to
the AdaBoost
classifier model
file hse_←-
1_2_C_←-
adaboost.←-
yml.gz from
here

Generated by Doxygen
1.9 Configuration 19

0x5C Abscence of "config">"params"."config". T0 - Proportion no

head coverings "measures". "measures". of pixels clas-
"NoHead←- "NoHead←- sified as head
Covering" Covering" covering <= T0
will lead to a
quality compo-
nent value of
100 (best)
T1 - Proportion
of pixels clas-
sified as head
covering >= T1
will lead to a
quality compo-
nent value of 0
(worst)
w -Proportion
of pixels clas-
sified as head
covering in
(T0,T1) will be
interpolated
using a sigmoid
function with
w as standard
deviation
x0 - Propor-
tion of pixels
classified as
head covering
in (T0,T1) will
be interpolated
using a sigmoid
function with x0
as development
point

1.9.6 Configuration of the quality mapping

Each measure implemented in OFIQ outputs a pair of values. The first value is called native quality score. The
second value is called quality component value which is an integer between 0 (worst quality) and 100 (best quality).
The quality component value and is derived from the native quality score using a mapping function. Whether this
mapping function can be configured for the measure is stated in the table of section Default configuration.

Note, the OFIQ library implements hard-coded default quality mappings as a fallback.

A configurable quality mapping has the form of

Q(h, a, s, x, x0 , w) = h · (a + s · sigmoid(x, x0 , w))

where
sigmoid(x, x0 , w) = (1 + exp((x0 − x)/w)−1 .
Note, x is the native quality score which is mapped to the quality component value. The other symbols denote
parameters that can be configured (see the example at the end of this section).

Generated by Doxygen
20 Open Source Face Image Quality (OFIQ) Library

parameter description default value

"h" scale factor 100
"a" constant shift 0
"s" signed weight for sigmoid part 1
"x0" center point within sigmoid function; the default value has been chosen arbitrarily 4
and should specified when a mapping is configured.
"w" divisor within the sigmoid function; the default value has been chosen arbitrarily 0.7
and should specified when a mapping is configured.
"round" applies the compiler's native rounding function (std::round) such that only true
integer values are used as the quality value

All parameters are optional and can be omitted. In this case, the default value is chosen. Note, if a mapping results
in a value not within 0 and 100, then a clipping is applied choosing the value 0 or 100 being closest to the mapped
value.

For example, OFIQ's configuration for the background uniformity measure looks as follows

{
"config" :
...
"params": {
...
"BackgroundUniformity": {
"Sigmoid" : {
"h": 190,
"a": 1,
"s": -1,
"x0": 10,
"w" : 100,
"round": true
}
}
...
}
}

1.10 C++ API

To use OFIQ in a C++ application one needs to include the following header file.

include <ofiq_lib.h>

In the following, we assume that the namespace OFIQ and OFIQ_LIB are used.

using namespace OFIQ;

using namespace OFIQ_LIB;

An OFIQ instance is initialized using the Interface class as follows.

Generated by Doxygen
1.11 Implementation and pre-processing workflow 21

// Get implementation pointer

auto implPtr = Interface::getImplementation();
// Initialization
auto ret = implPtr->initialize(configDir,configFile);

Here configDir is a std::string-representation of the path to the directory in which a JAXN configuration
file of name configFile is stored - as documented in the configuration section. Note, that the path can be
absolute or relative to the path of the current working directory.

The input image is read by using the readImage function as follows

Image image;
ReturnStatus retStatus = readImage(imagePath, image);

where imagePath is a std::string-representation of a path to an image file. The representation is written to

the image object of type Image.

To compute the quality assessments, run

FaceImageQualityAssessment assessment;
ReturnStatus retStatus = implPtr->vectorQuality(image, assessment);

A successful computation is indicated by retStatus.code if it is of value ReturnCode::Success.

Then the assessment result is stored in a FaceImageQualityAssessment struct object. The obtained
FaceImageQualityAssessment object has a std::map member which, for a specified QualityMeasure key,
returns the QualityMeasureResult. A QualityMeasureResult struct object contains the native quality score stored
in the rawScore member and the quality component value stored in the scalar member. Note, both members are
encoded as a double values although the scalar member should (on successful quality measure computation) be
an integer value between 0 and 100. To check whether a QualityMeasureResult has been computed successfully,
one checks if its code member agrees with the value QualityMeasureReturnCode::Success.

1.11 Implementation and pre-processing workflow

Quality assessment is controlled by the implementation of the OFIQImpl class. A shared pointer to an OFIQImpl
object is returned by the Interface::getImplementation() function. The implementation needs to be initialized once
using the OFIQImpl::initialize() function. Note, the OFIQImpl::initialize() function loads all model files as specified in
the input configuration into memory; thus, one should avoid creating repeated instances of the OFIQImpl.

After successful initialization, the implementation object can be used and one can repeatedly invoke the
OFIQImpl::vectorQuality() function to assess the quality of a series of facial images.

The internal workflow of the OFIQImpl::vectorQuality() implementation is as follows.

1. Pre-processing of the input image using the OFIQImpl::performPreprocessing() function.

(a) Face detection implemented by SSDFaceDetector::UpdateFaces().

(b) Pose estimation implemented by HeadPose3DDFAV2::updatePose().
(c) Landmark extraction implemented by ADNetFaceLandmarkExtractor::updateLandmarks().
(d) Facial alignment implemented by OFIQImpl::alignFaceImage().
(e) Face parsing implemented by FaceParsing::UpdateMask().
(f) Face occlusion segmentation implemented by FaceOcclusionSegmentation::UpdateMask().

2. Quality assessment using the Executor::ExecuteAll() function: For all requested measures

(a) its Execute()

(b) and then its SetQualityMeasure() functions are invoked.

Generated by Doxygen
22 Open Source Face Image Quality (OFIQ) Library

1.12 Release notes

This is OFIQ Version 1.0.0-RC.2 (2024-07-31). The following table lists all measures and its implementation pro-
vided by this release of OFIQ. Details on the configuration and on requesting measures can be found here. Note,
the QAA identifiers listed in the table are defined in ISO/IEC 29794-5.

QAA identifier Description OFIQ implementation reference

0x41 MagFace-based unified quality score measure. UnifiedQualityScore

0x42 Gradient-based background uniformity. BackgroundUniformity

0x43 Illumination uniformity by summing up the minima of the IlluminationUniformity

histograms of the left and the right side of the face.
0x44 Luminance mean measure computed from the lumi- Luminance
nance histogram
0x45 Luminance variance measure computed from the lumi- Luminance
nance histogram
0x46 Under-exposure prevention by computing the proportion UnderExposurePrevention
of low-intensity pixels in the luminance image to assess
the abscence of under-exposure
0x47 Over-exposure prevention by computing the proportion OverExposurePrevention
of high-intensity pixels in the luminance image to assess
the abscence of over-exposur
0x48 Dynamic range computed from the luminance histogram. DynamicRange

0x49 Sharpness assessment based on a random forest clas- Sharpness

sifier trained by the OFIQ development team.
0x4A Assessment of the absence of compression artifact (both CompressionArtifacts
JPEG and JPEG2000) based on a CNN trained by the
OFIQ development team.
0x4B Assessment of the naturalness of the colour based on NaturalColour
the conversion of the RGB presentation of the image to
the CIELAB colour space.
0x4C Assessment of the uniqueness of the most dominant SingleFacePresent
face detected by comparing its size with the size of the
second largest face detected
0x4D Eyes openness assessment based on computing eyes EyesOpen
aspect ratio from eye landmarks
0x4E Mouth closed assessment based on computing a ratio MouthClosed
from mouth landmarks
0x4F Eyes visibility assessment by measuring the coverage of EyesVisible
the eye visibility zone with the result of face occlusion
segmentation computed during pre-processing.
0x50 Assessment of the absence of mouth occlusion by mea- MouthOcclusionPrevention
suring the coverage of the mouth region from mouth
landmarks with the result of face occlusion segmentation
computed on pre-processing.
0x51 Assessment of the absence of face occlusion by mea- FaceOcclusionPrevention
suring the coverage of the landmarked region with the
result of face occlusion segmentation computed during
pre-processing.
0x52 Inter-eye distance assessment based on computing the InterEyeDistance
Euclidean length of eyes' centres and multiplication with
the secant of the yaw angle computed during pre-
processing.

Generated by Doxygen
1.12 Release notes 23

0x53 Size of the head based on computing the height of the HeadSize
face computed from facial landmarks with the height of
the image.
0x54 Leftward crop of the face image CropOfTheFaceImage

0x55 Rightward crop of the face image CropOfTheFaceImage

0x56 Margin above of the face image CropOfTheFaceImage

0x57 Margin below of the face image CropOfTheFaceImage

0x58 Pose angle yaw frontal alignment based on the HeadPose

3DDFAV2.
0x59 Pose angle pitch frontal alignment based on the HeadPose
3DDFAV2
0x5A Pose angle roll frontal alignment based on the HeadPose
3DDFAV2
0x5B Expression neutrality estimation based on a fu- ExpressionNeutrality
sion of HSEMotion with with Efficient-←-
Expression-Neutrality-Estimation.
0x5C Assessment of the absence of head coverings by count- NoHeadCoverings
ing the pixels being labeled as head covers in the
mask output by the face parsing computed during pre-
processing.

1.12.1 Changelog

1.12.1.1 Version 1.0.0-RC.2 (2024-07-31)

Second release of OFIQ's release candidate. The following changes have been implemented.

• Supports compilation on MacOS

• Successfully tested that it is possible (with some effort) to compile for and be conformant with mobile devices
such as Android and iOS.

• Revisions as per up coming FDIS (e.g., quality mappings, update of conformance test table, etc.)

• Fix of the default config file: Changes to the CropOfTheFaceImage measures did not affect the quality map-
pings

• Fixes link to the OFIQ-MODELS.zip archive: https://github.com/BSI-OFIQ/OFIQ-←-

Project/issues/12
• Removes libgtk dependency: https://github.com/BSI-OFIQ/OFIQ-Project/issues/18
• Removes Lapack from ubuntu cmake file which wasn't used: https://github.com/BSI-OFIQ/←-
OFIQ-Project/issues/20
• Improves readability of source code by applying a style guide to member variables: https←-
://github.com/BSI-OFIQ/OFIQ-Project/issues/27
• Fixes from static code analyses, for example:

– https://github.com/BSI-OFIQ/OFIQ-Project/issues/28
– https://github.com/BSI-OFIQ/OFIQ-Project/issues/29
– https://github.com/BSI-OFIQ/OFIQ-Project/issues/30
– https://github.com/BSI-OFIQ/OFIQ-Project/issues/31

Generated by Doxygen
24 Open Source Face Image Quality (OFIQ) Library

– and others

• Removes mis-leading usage hint in the sample app: https://github.com/BSI-OFIQ/OFIQ-←-

Project/issues/34

• Avoids redundant RGB conversions: https://github.com/BSI-OFIQ/OFIQ-Project/issues/36

• Fixes a bug on continuous OpenCV matrices: https://github.com/BSI-OFIQ/OFIQ-←-
Project/issues/41
• Fixes further issues and bugs and code beautification

1.12.1.2 Version 1.0.0-RC.1 (2024-03-15)

Initial release of OFIQ's release candidate.

Generated by Doxygen
Chapter 2

Namespace Index

2.1 Namespace List

Here is a list of all namespaces with brief descriptions:

cv
OpenCV's namespace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
OFIQ
Namespace for OFIQ API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
OFIQ_LIB
Namespace for OFIQ implementations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
OFIQ_LIB::modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
OFIQ_LIB::modules::detectors
Provides face detector implementations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
OFIQ_LIB::modules::landmarks
Provides implementations of a landmark extractors . . . . . . . . . . . . . . . . . . . . . . . 52
OFIQ_LIB::modules::landmarks::adnet
Namespace for ADNet-specific landmarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
OFIQ_LIB::modules::measures
Provides measures implemented in OFIQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
OFIQ_LIB::modules::poseEstimators
Provides implementation of a head pose estimator . . . . . . . . . . . . . . . . . . . . . . . 60
OFIQ_LIB::modules::segmentations
Provides segmentation-related implementations . . . . . . . . . . . . . . . . . . . . . . . . . 60

Generated by Doxygen
26 Namespace Index

Generated by Doxygen
Chapter 3

Hierarchical Index

3.1 Class Hierarchy

This inheritance list is sorted roughly, but not completely, alphabetically:

OFIQ::BoundingBox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
OFIQ_LIB::Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
std::exception
OFIQ_LIB::OFIQError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
OFIQ_LIB::modules::measures::Executor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
OFIQ_LIB::FaceDetectorInterface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
OFIQ_LIB::modules::detectors::SSDFaceDetector . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
OFIQ::FaceImageQualityAssessment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
OFIQ_LIB::FaceLandmarkExtractorInterface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
OFIQ_LIB::modules::landmarks::ADNetFaceLandmarkExtractor . . . . . . . . . . . . . . . . . . . . . 63
OFIQ::FaceLandmarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
OFIQ_LIB::modules::landmarks::FaceMeasures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
OFIQ::Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
OFIQ::Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
OFIQ_LIB::OFIQImpl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
OFIQ_LIB::modules::landmarks::LandmarkPair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
OFIQ::LandmarkPoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
OFIQ_LIB::modules::measures::Measure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
OFIQ_LIB::modules::measures::BackgroundUniformity . . . . . . . . . . . . . . . . . . . . . . . . . . 65
OFIQ_LIB::modules::measures::CompressionArtifacts . . . . . . . . . . . . . . . . . . . . . . . . . . 71
OFIQ_LIB::modules::measures::CropOfTheFaceImage . . . . . . . . . . . . . . . . . . . . . . . . . 79
OFIQ_LIB::modules::measures::DynamicRange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
OFIQ_LIB::modules::measures::ExpressionNeutrality . . . . . . . . . . . . . . . . . . . . . . . . . . 85
OFIQ_LIB::modules::measures::EyesOpen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
OFIQ_LIB::modules::measures::EyesVisible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
OFIQ_LIB::modules::measures::FaceOcclusionPrevention . . . . . . . . . . . . . . . . . . . . . . . . 102
OFIQ_LIB::modules::measures::HeadPose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
OFIQ_LIB::modules::measures::HeadSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
OFIQ_LIB::modules::measures::IlluminationUniformity . . . . . . . . . . . . . . . . . . . . . . . . . . 122
OFIQ_LIB::modules::measures::InterEyeDistance . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
OFIQ_LIB::modules::measures::Luminance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
OFIQ_LIB::modules::measures::MouthClosed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
OFIQ_LIB::modules::measures::MouthOcclusionPrevention . . . . . . . . . . . . . . . . . . . . . . . 146
OFIQ_LIB::modules::measures::NaturalColour . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

Generated by Doxygen
28 Hierarchical Index

OFIQ_LIB::modules::measures::NoHeadCoverings . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
OFIQ_LIB::modules::measures::OverExposurePrevention . . . . . . . . . . . . . . . . . . . . . . . . 167
OFIQ_LIB::modules::measures::Sharpness . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
OFIQ_LIB::modules::measures::SingleFacePresent . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
OFIQ_LIB::modules::measures::UnderExposurePrevention . . . . . . . . . . . . . . . . . . . . . . . 200
OFIQ_LIB::modules::measures::UnifiedQualityScore . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
OFIQ_LIB::modules::measures::MeasureFactory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
OFIQ_LIB::NeuronalNetworkContainer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
ONNXRuntimeSegmentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
OFIQ_LIB::modules::landmarks::PartExtractor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Point2f . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
OFIQ_LIB::Point2i . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
OFIQ_LIB::PoseEstimatorInterface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2 . . . . . . . . . . . . . . . . . . . . . . . . 116
OFIQ::QualityMeasureResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
OFIQ::ReturnStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
OFIQ_LIB::SegmentationExtractorInterface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation . . . . . . . . . . . . . . . . . . . 104
OFIQ_LIB::modules::segmentations::FaceParsing . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
OFIQ_LIB::Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
OFIQ_LIB::modules::measures::SigmoidParameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

Generated by Doxygen
Chapter 4

Class Index

4.1 Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

OFIQ_LIB::modules::landmarks::ADNetFaceLandmarkExtractor
Class implementing the FaceLandmarkExtractorInterface interface . . . . . . . . . . . . . . . 63
OFIQ_LIB::modules::measures::BackgroundUniformity
Implementation of the background uniformity measure . . . . . . . . . . . . . . . . . . . . . 65
OFIQ::BoundingBox
Data structure for descibing bounding boxes, e.g. the face region of the faces found by a face
detector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
OFIQ_LIB::modules::measures::CompressionArtifacts
Implementation of the no compression artifacts measure . . . . . . . . . . . . . . . . . . . . 71
OFIQ_LIB::Configuration
Configuration class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
OFIQ_LIB::modules::measures::CropOfTheFaceImage
Implementation of the crop of the face image measure . . . . . . . . . . . . . . . . . . . . . 79
OFIQ_LIB::modules::measures::DynamicRange
Implementation of the dynamic range measure . . . . . . . . . . . . . . . . . . . . . . . . . 81
OFIQ_LIB::modules::measures::Executor
This class takes care of the computation of the measures activated . . . . . . . . . . . . . . . 83
OFIQ_LIB::modules::measures::ExpressionNeutrality
Provides a class implementing the expression neutrality measure . . . . . . . . . . . . . . . . 85
OFIQ_LIB::modules::measures::EyesOpen
Implementation of the eyes open measure . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
OFIQ_LIB::modules::measures::EyesVisible
Implementation of the eyes visible measure . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
OFIQ_LIB::FaceDetectorInterface
Provides the interface class to the face detector implementations . . . . . . . . . . . . . . . . 92
OFIQ::FaceImageQualityAssessment
Data structure storing the results of the different measurement computations . . . . . . . . . . 94
OFIQ_LIB::FaceLandmarkExtractorInterface
Implements the base class for the face landmark extractors . . . . . . . . . . . . . . . . . . . 95
OFIQ::FaceLandmarks
Data structure for storing facial landmarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
OFIQ_LIB::modules::landmarks::FaceMeasures
Provides static functions doing computations with landmarks . . . . . . . . . . . . . . . . . . 98
OFIQ_LIB::modules::measures::FaceOcclusionPrevention
Implementation of the face occlusion prevention measure . . . . . . . . . . . . . . . . . . . . 102

Generated by Doxygen
30 Class Index

OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation
Class managing the separation of facial parts not occluded by non-facial parts from other parts 104
OFIQ_LIB::modules::segmentations::FaceParsing
Class managing the separation of facial parts not occluded by non-facial parts from other parts 108
OFIQ_LIB::modules::measures::HeadPose
Implementation of head pose measures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2
Implementation of a head pose estimator . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
OFIQ_LIB::modules::measures::HeadSize
Implementation of the head size measure . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
OFIQ_LIB::modules::measures::IlluminationUniformity
Implementation of the illumination uniformity measure . . . . . . . . . . . . . . . . . . . . . . 122
OFIQ::Image
Struct representing a single image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
OFIQ_LIB::modules::measures::InterEyeDistance
Implementation of the inter-eye distance measure . . . . . . . . . . . . . . . . . . . . . . . . 126
OFIQ::Interface
The interface to FACE QA implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
OFIQ_LIB::modules::landmarks::LandmarkPair
Data container for storing pairs of landmarks . . . . . . . . . . . . . . . . . . . . . . . . . . 131
OFIQ::LandmarkPoint
Data structure to describe the x and y coordinate of a landmark . . . . . . . . . . . . . . . . . 132
OFIQ_LIB::modules::measures::Luminance
Implementation of two luminance measures . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
OFIQ_LIB::modules::measures::Measure
Base class for measures implemented in OFIQ . . . . . . . . . . . . . . . . . . . . . . . . . 135
OFIQ_LIB::modules::measures::MeasureFactory
Measure factor class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
OFIQ_LIB::modules::measures::MouthClosed
Implementation of the mouth closed measure . . . . . . . . . . . . . . . . . . . . . . . . . . 143
OFIQ_LIB::modules::measures::MouthOcclusionPrevention
Implementation of the mouth occlusion prevention measure . . . . . . . . . . . . . . . . . . . 146
OFIQ_LIB::modules::measures::NaturalColour
Implementation of the natural colour measure . . . . . . . . . . . . . . . . . . . . . . . . . . 148
OFIQ_LIB::NeuronalNetworkContainer
Neural network container for OFIQ's preprocessing steps . . . . . . . . . . . . . . . . . . . . 151
OFIQ_LIB::modules::measures::NoHeadCoverings
Implementation of the no head covering measure . . . . . . . . . . . . . . . . . . . . . . . . 154
OFIQ_LIB::OFIQError
Implementation of a custom exception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
OFIQ_LIB::OFIQImpl
Implementation of the OFIQ_LIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
ONNXRuntimeSegmentation
Helper class to manage the ONNXRuntime session object . . . . . . . . . . . . . . . . . . . 164
OFIQ_LIB::modules::measures::OverExposurePrevention
Implementation of the over-exposure prevention measure . . . . . . . . . . . . . . . . . . . . 167
OFIQ_LIB::modules::landmarks::PartExtractor
Class that provides helper methods for the administration of landmarks . . . . . . . . . . . . . 169
Point2f
Representation of a point with floating point arithmetics . . . . . . . . . . . . . . . . . . . . . 170
OFIQ_LIB::Point2i
Representation of a point with integer arithmetics . . . . . . . . . . . . . . . . . . . . . . . . 171
OFIQ_LIB::PoseEstimatorInterface
Implementation of the base class for integrating pose estimation algorithms capable of estimating
three head orientation angles (yaw, pitch and roll) from a face image . . . . . . . . . . . . . . 172
OFIQ::QualityMeasureResult
Data structure to handle the results of a quality measure . . . . . . . . . . . . . . . . . . . . 174

Generated by Doxygen
4.1 Class List 31

OFIQ::ReturnStatus
A structure to contain information about a failure by the software under test . . . . . . . . . . 175
OFIQ_LIB::SegmentationExtractorInterface
Base class for the different implementation of segmentation algorithms . . . . . . . . . . . . . 177
OFIQ_LIB::Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
OFIQ_LIB::modules::measures::Sharpness
Implemantation of the sharpness measure . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
OFIQ_LIB::modules::measures::SigmoidParameters
Parameters of the sigmoid function based quality mapping . . . . . . . . . . . . . . . . . . . 193
OFIQ_LIB::modules::measures::SingleFacePresent
Implementation of the single face present measure . . . . . . . . . . . . . . . . . . . . . . . 195
OFIQ_LIB::modules::detectors::SSDFaceDetector
Implementation of a face detector using the SSD face detector CNN . . . . . . . . . . . . . . 197
OFIQ_LIB::modules::measures::UnderExposurePrevention
Implementation of the under-exposure prevention measure . . . . . . . . . . . . . . . . . . . 200
OFIQ_LIB::modules::measures::UnifiedQualityScore
Implementation of the unified quality measure . . . . . . . . . . . . . . . . . . . . . . . . . . 202

Generated by Doxygen
32 Class Index

Generated by Doxygen
Chapter 5

File Index

5.1 File List

Here is a list of all files with brief descriptions:

mainpage.h
This header file is for generating the doxygen documentation for OFIQ . . . . . . . . . . . . . 205
ofiq_lib.h
Class describing the interface to the OFIQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
ofiq_lib_impl.h
Implementation of the OFIQ_LIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
ofiq_structs.h
PRovides several helper classes, enums and functions used in the OFIQ framework . . . . . . 209
AllDetectors.h
Provides the include statements to all classes derived from FaceDetectorInterface . . . . . . . 214
detectors.h
Provides the interface class to the face detector implementations . . . . . . . . . . . . . . . . 215
opencv_ssd_face_detector.h
Implementation of a face detector using the SSD face detector CNN . . . . . . . . . . . . . . 216
adnet_FaceMap.h
Provides definitions of landmark indices to access specific parts of ADNet landmarks . . . . . 217
adnet_landmarks.h
Provides the ADNetFaceLandmarkExtractor class . . . . . . . . . . . . . . . . . . . . . . . . 220
AllLandmarks.h
Provides the include statements to all classes derived from FaceLandmarkExtractorInterface . 221
FaceMeasures.h
Provides a class implementing two luminance measures . . . . . . . . . . . . . . . . . . . . 222
FaceParts.h
PRovides several helper classes, enums and functions used in the OFIQ framework . . . . . . 224
landmarks.h
Provides the base class for the implementation of face landmark extractors . . . . . . . . . . . 226
PartExtractor.h
Provides helper class for face landmark handling . . . . . . . . . . . . . . . . . . . . . . . . 227
AllMeasures.h
Provides all classes derived from the OFIQ_LIB::modules::measures::Measure class . . . . . 228
BackgroundUniformity.h
Provides a class implementing the background uniformity measure . . . . . . . . . . . . . . . 230
CompressionArtifacts.h
Provides a class implemtenting the no compression artifact measure . . . . . . . . . . . . . . 231
CropOfTheFaceImage.h
Provides a class implementing the crop of the face image measure . . . . . . . . . . . . . . . 233

Generated by Doxygen
34 File Index

DynamicRange.h
Provides a class implemtenting the dynamic range measure . . . . . . . . . . . . . . . . . . 234
Executor.h
This class takes care of the computation of the measures activated . . . . . . . . . . . . . . . 235
ExpressionNeutrality.h
Provides a class implementing the expression neutrality measure . . . . . . . . . . . . . . . . 237
EyesOpen.h
Provides a class implementing the eyes open measure . . . . . . . . . . . . . . . . . . . . . 238
EyesVisible.h
Provides a class implementing the eyes visible measure . . . . . . . . . . . . . . . . . . . . 240
FaceOcclusionPrevention.h
Provides a class implementing the face occlusion prevention measure . . . . . . . . . . . . . 241
HeadPose.h
Provides a class implementing head pose measures . . . . . . . . . . . . . . . . . . . . . . 242
HeadSize.h
Provides a class implementing the head size measure . . . . . . . . . . . . . . . . . . . . . 244
IlluminationUniformity.h
Provides a class implementing the illumination uniformity measure . . . . . . . . . . . . . . . 245
InterEyeDistance.h
Provides a class implementing the inter-eye distance measure . . . . . . . . . . . . . . . . . 246
Luminance.h
Provides a class implementing two luminance measures . . . . . . . . . . . . . . . . . . . . 248
Measure.h
Provides the base class for all measures implemented in OFIQ . . . . . . . . . . . . . . . . . 249
MeasureFactory.h
Provides a class for requesting creation of measure implementations . . . . . . . . . . . . . . 251
MouthClosed.h
Provides a class implementing the mouth closed measure . . . . . . . . . . . . . . . . . . . 253
MouthOcclusionPrevention.h
Provides a class implementing the mouth occlusion prevention measure . . . . . . . . . . . . 254
NaturalColour.h
Provides a class implementing the natural colour measure . . . . . . . . . . . . . . . . . . . 255
NoHeadCoverings.h
Provides a class implementing the no head covering measure . . . . . . . . . . . . . . . . . 257
OverExposurePrevention.h
Provides a class implementing the background uniformity measure . . . . . . . . . . . . . . . 258
Sharpness.h
Provides a class implementing the sharpness measure . . . . . . . . . . . . . . . . . . . . . 259
SingleFacePresent.h
Provides a class implementing the single face present measure . . . . . . . . . . . . . . . . . 261
UnderExposurePrevention.h
Provides a class implemtenting the under-exposure prevention measure . . . . . . . . . . . . 262
UnifiedQualityScore.h
Provides a class implemtenting the unified quality measure . . . . . . . . . . . . . . . . . . . 263
AllPoseEstimators.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
HeadPose3DDFAV2.h
Provides a class implementing a head pose estimator based on https://github.←-
com/cleardusk/3DDFA_V2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
poseEstimators.h
Base class for the different implementation of pose estimation algorithms . . . . . . . . . . . . 267
FaceOcclusionSegmentation.h
Provides a class for segmenting the facial part not occluded by any non-facial parts from an
image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
FaceParsing.h
Provides a class implementing the face parsing pre-processing . . . . . . . . . . . . . . . . . 270
ONNXRTSegmentation.h
Helper class to manage the ONNXRuntime session object . . . . . . . . . . . . . . . . . . . 272

Generated by Doxygen
5.1 File List 35

segmentations.h
Base class for the different implementation of segmentation algorithms . . . . . . . . . . . . . 273
Configuration.h
Provides a configuration class for handling configurations . . . . . . . . . . . . . . . . . . . . 275
image_io.h
Provides helper functions for reading/writing images from/to disk . . . . . . . . . . . . . . . . 277
image_utils.h
Provides image utility functions such as color conversion, luminance computation etc . . . . . 278
NeuronalNetworkContainer.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
OFIQError.h
Provides a class for the error handling within the QFIQ . . . . . . . . . . . . . . . . . . . . . 281
Session.h
The session class is the data container used to distribute the image and additional data, including
the data computed during the pre-processing . . . . . . . . . . . . . . . . . . . . . . . . . . 282
utils.h
Helper functions used by several classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284

Generated by Doxygen
36 File Index

Generated by Doxygen
Chapter 6

Namespace Documentation

6.1 cv Namespace Reference

OpenCV's namespace.

6.1.1 Detailed Description

OpenCV's namespace.

6.2 OFIQ Namespace Reference

Namespace for OFIQ API.

Classes

• struct BoundingBox
Data structure for descibing bounding boxes, e.g. the face region of the faces found by a face detector.
• struct FaceImageQualityAssessment
Data structure storing the results of the different measurement computations.
• struct FaceLandmarks
Data structure for storing facial landmarks.
• struct Image
Struct representing a single image.
• class Interface
The interface to FACE QA implementation.
• struct LandmarkPoint
Data structure to describe the x and y coordinate of a landmark.
• struct QualityMeasureResult
Data structure to handle the results of a quality measure.
• struct ReturnStatus
A structure to contain information about a failure by the software under test.

Generated by Doxygen
38 Namespace Documentation

Typedefs

• using QualityAssessments = std::map<QualityMeasure, QualityMeasureResult>

Data structure that stores key-value pairs, with each entry representing a quality element and its value.
• using Landmarks = std::vector<LandmarkPoint>
container for a collection of landmarks, e.g. belonging to all the landmarks detected on a face image.

Enumerations

• enum class ReturnCode {

Success = 0 , ImageReadingError , ImageWritingError , MissingConfigParamError ,
UnknownConfigParamError , FaceDetectionError , FaceLandmarkExtractionError , FaceOcclusionSegmentationError
,
FaceParsingError , UnknownError , QualityAssessmentError , NotImplemented }
Return codes for functions specified in this API.
• enum class QualityMeasure {
UnifiedQualityScore = 0x41 , BackgroundUniformity = 0x42 , IlluminationUniformity = 0x43 , Luminance =
-0x44 ,
LuminanceMean = 0x44 , LuminanceVariance = 0x45 , UnderExposurePrevention = 0x46 , OverExposurePrevention
= 0x47 ,
DynamicRange = 0x48 , Sharpness = 0x49 , CompressionArtifacts = 0x4a , NaturalColour = 0x4b ,
SingleFacePresent = 0x4c , EyesOpen = 0x4d , MouthClosed = 0x4e , EyesVisible = 0x4f ,
MouthOcclusionPrevention = 0x50 , FaceOcclusionPrevention = 0x51 , InterEyeDistance = 0x52 , HeadSize
= 0x53 ,
CropOfTheFaceImage = -0x54 , LeftwardCropOfTheFaceImage = 0x54 , RightwardCropOfTheFaceImage =
0x55 , MarginAboveOfTheFaceImage = 0x56 ,
MarginBelowOfTheFaceImage = 0x57 , HeadPose = -0x58 , HeadPoseYaw = 0x58 , HeadPosePitch = 0x59 ,
HeadPoseRoll = 0x5a , ExpressionNeutrality = 0x5b , NoHeadCoverings = 0x5c , NotSet = -1 }
Enums presenting the measure labels.
• enum class QualityMeasureReturnCode { Success = 0 , FailureToAssess , NotInitialized }
Return codes for QualityMeasureResult.
• enum class FaceDetectorType { OPENCVSSD , NotSet }
Enum describing the different face detector implementations.
• enum class LandmarkType { LM_98 , NotSet }
Enum describing the different implementations of landmarks.

Functions

• std::ostream & operator<< (std::ostream &s, const ReturnCode &rc)

6.2.1 Detailed Description

Namespace for OFIQ API.

Namespace for OFIQ API.

6.2.2 Typedef Documentation

6.2.2.1 Landmarks

using OFIQ::Landmarks = std::vector<LandmarkPoint>

container for a collection of landmarks, e.g. belonging to all the landmarks detected on a face image.

Generated by Doxygen
6.2 OFIQ Namespace Reference 39

6.2.2.2 QualityAssessments

using OFIQ::QualityAssessments = std::map<QualityMeasure, QualityMeasureResult>

Data structure that stores key-value pairs, with each entry representing a quality element and its value.

6.2.3 Enumeration Type Documentation

6.2.3.1 FaceDetectorType

enum class OFIQ::FaceDetectorType [strong]

Enum describing the different face detector implementations.

Enumerator

OPENCVSSD face detector based on the ssd implementation in opencv.

NotSet unknown face detector

6.2.3.2 LandmarkType

enum class OFIQ::LandmarkType [strong]

Enum describing the different implementations of landmarks.

Enumerator
LM_98 Landmarks extracted with the adnet detector.
NotSet used for iterating through the enums.

6.2.3.3 QualityMeasure

enum class OFIQ::QualityMeasure [strong]

Enums presenting the measure labels.

Enumerator

UnifiedQualityScore UnifiedQualityScore
BackgroundUniformity BackgroundUniformity
IlluminationUniformity IlluminationUniformity
Luminance the common measure implementation for LuminanceMean,
LuminanceVariance
LuminanceMean LuminanceMean
LuminanceVariance LuminanceVariance
UnderExposurePrevention UnderExposurePrevention
OverExposurePrevention OverExposurePrevention

Generated by Doxygen
40 Namespace Documentation

Enumerator
DynamicRange DynamicRange
Sharpness Sharpness
CompressionArtifacts CompressionArtifacts
NaturalColour NaturalColour
SingleFacePresent SingleFacePresent
EyesOpen EyesOpen
MouthClosed MouthClosed
EyesVisible EyesVisible
MouthOcclusionPrevention MouthOcclusionPrevention
FaceOcclusionPrevention FaceOcclusionPrevention
InterEyeDistance InterEyeDistance
HeadSize HeadSize
CropOfTheFaceImage CropOfTheFaceImage: common measure for
{Left,Right}wardCropOfTheFaceImage, MarginAbove, and MarginBelow
LeftwardCropOfTheFaceImage LeftwardCropOfTheFaceImage
RightwardCropOfTheFaceImage RightwardCropOfTheFaceImage
MarginAboveOfTheFaceImage MarginAbove
MarginBelowOfTheFaceImage MarginBelow
HeadPose HeadPose
HeadPoseYaw HeadPoseYaw
HeadPosePitch HeadPosePitch
HeadPoseRoll HeadPoseRoll
ExpressionNeutrality ExpressionNeutrality
NoHeadCoverings NoHeadCoverings
NotSet unknown measure

6.2.3.4 QualityMeasureReturnCode

enum class OFIQ::QualityMeasureReturnCode [strong]

Return codes for QualityMeasureResult.

Enumerator

Success Success
FailureToAssess Unable to assess a quality measure
NotInitialized Quality measure is not initialized

6.2.3.5 ReturnCode

enum class OFIQ::ReturnCode [strong]

Return codes for functions specified in this API.

Generated by Doxygen
6.3 OFIQ_LIB Namespace Reference 41

Enumerator

Success Success
ImageReadingError Failed to read an image.
ImageWritingError failed to write an image to disk.
MissingConfigParamError A required config parameter is missing
UnknownConfigParamError A required config parameter is missing
FaceDetectionError Unable to detect a face in the image
FaceLandmarkExtractionError Unable to extract landmarks from face
FaceOcclusionSegmentationError Unable to extract occlusion segments from face
FaceParsingError Unable to parse face
UnknownError Catch-all error
QualityAssessmentError Failure to generate a quality score on the input image
NotImplemented Function is not implemented

6.2.4 Function Documentation

6.2.4.1 operator<<()

std::ostream & OFIQ::operator<< (

std::ostream & s,
const ReturnCode & rc ) [inline]

Output stream operator for a ReturnCode object.

6.3 OFIQ_LIB Namespace Reference

Namespace for OFIQ implementations.

Namespaces

• namespace modules

Classes

• class Configuration
Configuration class.
• class FaceDetectorInterface
Provides the interface class to the face detector implementations.
• class FaceLandmarkExtractorInterface
Implements the base class for the face landmark extractors.
• struct NeuronalNetworkContainer
Neural network container for OFIQ's preprocessing steps.
• class OFIQError
Implementation of a custom exception.
• class OFIQImpl

Generated by Doxygen
42 Namespace Documentation

Implementation of the OFIQ_LIB.

• struct Point2i
Representation of a point with integer arithmetics.
• class PoseEstimatorInterface
Implementation of the base class for integrating pose estimation algorithms capable of estimating three head orienta-
tion angles (yaw, pitch and roll) from a face image.
• class SegmentationExtractorInterface
Base class for the different implementation of segmentation algorithms.
• class Session

Typedefs

• using ExposureRange = std::array<int, 2>

• using EulerAngle = std::array<double, 3>

Functions

• OFIQ_EXPORT OFIQ::ReturnStatus readImage (const std::string &filename, OFIQ::Image &image)

Read image from disk.
• OFIQ_EXPORT double ColorConvert (double v)
Converts a color as specified in ISO/IEC 29794-5.
• OFIQ_EXPORT double Cubic (double x, double k, double eps)
Cubic flattening function.
• OFIQ_EXPORT void ConvertBGRToCIELAB (const cv::Mat &bgrImage, double &a, double &b)
Computes CIELAB values a∗ and b∗ from a BGR image.
• OFIQ_EXPORT cv::Mat GetLuminanceImageFromBGR (const cv::Mat &bgrImage)
Converts a BGR image to the luminance image.
• OFIQ_EXPORT void CalculateReferencePoints (const OFIQ::FaceLandmarks &landmarks, OFIQ::LandmarkPoint
&leftEyeCenter, OFIQ::LandmarkPoint &rightEyeCenter, double &interEyeDistance, double &eyeMouth←-
Distance)
Computes the left eye center, the right eye center, the (planar) inter-eye-distance and the eye to mouth distance from
facial landmarks.
• OFIQ_EXPORT void CalculateRegionOfInterest (cv::Rect &leftRegionOfInterest, cv::Rect &rightRegionOf←-
Interest, const OFIQ::LandmarkPoint &leftEyeCenter, const OFIQ::LandmarkPoint &rightEyeCenter, const
double interEyeDistance, const double eyeMouthDistance)
Extracts regions being of interest for some measures (e.g. NaturalColour).
• OFIQ_EXPORT void GetNormalizedHistogram (const cv::Mat &luminanceImage, const cv::Mat &maskImage,
cv::Mat1f &histogram)
Computes the normalized histogram from a luminance image in 256 chunks.
• OFIQ_EXPORT double CalculateExposure (const Session &session, const ExposureRange &exposure←-
Range)
Helper function for some measures.
• OFIQ_EXPORT double ComputeBrightnessAspect (const cv::Mat &luminanceImage, const cv::Mat &mask←-
Image, const ExposureRange &exposureRange)
Helper function for some measures.
• OFIQ_EXPORT void makeSquareBoundingBoxWithPadding (const OFIQ::BoundingBox &i_bb, const cv::Mat
&i_input_image, cv::Mat &o_output_image, OFIQ::BoundingBox &o_bb, Point2i &o_translation_vector)
Some computations, especially neural networks, need a squarred image as input. This funtion consumes a boundig
box and an input image. The greater parameter of width or height is used to define the side length of the new squarred
bounding box. The face will be centered in the bounding box. Padding is added if needed. The squarred bounding box
is used generate a new cropped image, the o_output_image. Required translations are described by the translation
vector o_translation_vector.

Generated by Doxygen
6.3 OFIQ_LIB Namespace Reference 43

• OFIQ_EXPORT OFIQ::BoundingBox makeSquareBoundingBox (const OFIQ::BoundingBox &i_bb)

This function converts a non-squarred bounding box into an squarred one. The side length is defined by the greater
one of height or width.
• OFIQ_EXPORT size_t findLargestBoundingBox (const std::vector< OFIQ::BoundingBox > &faceRects)
This function returns the position of the largest bounding box (largest in terms of area) from a vector of bounding
boxes.
• OFIQ_EXPORT cv::Mat copyToCvImage (const OFIQ::Image &sourceImage, bool asGrayImage=false)
Convert images in OFIQ::Image format into the OpenCV cv::Mat format. The image can be converted from color to
gray scale by setting the parameter asGrayImage to true.
• OFIQ_EXPORT cv::Mat alignImage (const OFIQ::Image &faceImage, const OFIQ::FaceLandmarks &face←-
Landmarks, OFIQ::FaceLandmarks &alignedFaceLandmarks, cv::Mat &transformationMatrix)
This function transforms a face image so that the position of the eyes, nose and mouth are roughly at a pre-defined
position. Face alignment is the translation, rotation and scaling of the image to do this.
• OFIQ_EXPORT void calculateEyeCenter (const OFIQ::FaceLandmarks &faceLandmarks, Point2f &leftEye←-
Center, Point2f &rightEyeCenter)
Based on face landmarks the center of the left and right eye are computed.
• OFIQ_EXPORT OFIQ::Image MakeGreyImage (uint16_t width, uint16_t height)
This function generates a gray scaled image with the resolution passed by the call.
• OFIQ_EXPORT float tmetric (const OFIQ::FaceLandmarks &faceLandmarks)
Based on the provided landmarks this function computes the distance between the point between the eyes and the
chin.

6.3.1 Detailed Description

Namespace for OFIQ implementations.

Provides implementations in OFIQ.

Namespace for OFIQ implementations.

6.3.2 Typedef Documentation

6.3.2.1 EulerAngle

using OFIQ_LIB::EulerAngle = std::array<double, 3>

6.3.2.2 ExposureRange

using OFIQ_LIB::ExposureRange = std::array<int, 2>

6.3.3 Function Documentation

6.3.3.1 alignImage()

OFIQ_EXPORT cv::Mat OFIQ_LIB::alignImage (

const OFIQ::Image & faceImage,
const OFIQ::FaceLandmarks & faceLandmarks,
OFIQ::FaceLandmarks & alignedFaceLandmarks,
cv::Mat & transformationMatrix )

This function transforms a face image so that the position of the eyes, nose and mouth are roughly at a pre-defined
position. Face alignment is the translation, rotation and scaling of the image to do this.

Generated by Doxygen
44 Namespace Documentation

Parameters

faceImage Input image.

faceLandmarks Face landmarks, based on the face represented in the input image.
alignedFaceLandmarks Face landmarks of the aligned face image.
transformationMatrix Transformation matrix used to transform the landmarks.

Returns

cv::Mat Aligned face image with a resolution of 616x616.

6.3.3.2 CalculateExposure()

OFIQ_EXPORT double OFIQ_LIB::CalculateExposure (

const Session & session,
const ExposureRange & exposureRange )

Helper function for some measures.

The function is used by UnderExposurePrevention and OverExposurePrevention class. Details can be found in the
ISO/IEC 29794-5 standard.

Parameters

session Session object containing the original facial image and pre-processing results computed by the
OFIQImpl::performPreprocessing() method
exposureRange Range of pixels for which the aspect is computed.

Returns

Exposure computed from the inputs.

6.3.3.3 calculateEyeCenter()

OFIQ_EXPORT void OFIQ_LIB::calculateEyeCenter (

const OFIQ::FaceLandmarks & faceLandmarks,
Point2f & leftEyeCenter,
Point2f & rightEyeCenter )

Based on face landmarks the center of the left and right eye are computed.

Parameters

faceLandmarks Input face landmarks.

leftEyeCenter Point coordinates of the left eye center.
rightEyeCenter Point coordinates of the right eye center.

Generated by Doxygen
6.3 OFIQ_LIB Namespace Reference 45

6.3.3.4 CalculateReferencePoints()

OFIQ_EXPORT void OFIQ_LIB::CalculateReferencePoints (

const OFIQ::FaceLandmarks & landmarks,
OFIQ::LandmarkPoint & leftEyeCenter,
OFIQ::LandmarkPoint & rightEyeCenter,
double & interEyeDistance,
double & eyeMouthDistance )

Computes the left eye center, the right eye center, the (planar) inter-eye-distance and the eye to mouth distance
from facial landmarks.

Parameters
in landmarks Facial landmarks
out leftEyeCenter Left eye center computed from landmarks
out rightEyeCenter Right eye center computed from landmarks
out interEyeDistance Inter-eye distance computed from landmarks (does not consider the yaw angle).
out eyeMouthDistance Distance from the eyes' midpoint to the mouth.

6.3.3.5 CalculateRegionOfInterest()

OFIQ_EXPORT void OFIQ_LIB::CalculateRegionOfInterest (

cv::Rect & leftRegionOfInterest,
cv::Rect & rightRegionOfInterest,
const OFIQ::LandmarkPoint & leftEyeCenter,
const OFIQ::LandmarkPoint & rightEyeCenter,
const double interEyeDistance,
const double eyeMouthDistance )

Extracts regions being of interest for some measures (e.g. NaturalColour).

Details can be found in the ISO/IEC 29794-5 standard for the Natural colour measure.

Parameters

out leftRegionOfInterest Rectangular region corresponding to the left eye

out rightRegionOfInterest Rectangular region corresponding to the right eye
in leftEyeCenter Center of the left eye
in rightEyeCenter Center of the right eye
in interEyeDistance Planar inter-eye distance
in eyeMouthDistance Distance from the eyes' centers midpoint to the mouth

Returns

Applies a heuristic to estimate two regions being of interest for the natural colour measure.

6.3.3.6 ColorConvert()

OFIQ_EXPORT double OFIQ_LIB::ColorConvert (

double v )

Generated by Doxygen
46 Namespace Documentation

Converts a color as specified in ISO/IEC 29794-5.

Parameters

v An intensity value between 0 (black) and 1 (white).

Returns

If v > 0.04045, then ((v + 0.055)/1.055)2.4 is returned; otherwise, if v ≤ 0.04045, then v/12.92 is returned.

6.3.3.7 ComputeBrightnessAspect()

OFIQ_EXPORT double OFIQ_LIB::ComputeBrightnessAspect (

const cv::Mat & luminanceImage,
const cv::Mat & maskImage,
const ExposureRange & exposureRange )

Helper function for some measures.

The function is used by UnderExposurePrevention and OverExposurePrevention class. Details can be found in the
ISO/IEC 29794-5 standard.

Parameters
luminanceImage luminance image.
maskImage The mask on which the aspect is computed
exposureRange Range of pixels for which the aspect is computed.

Returns

Brightness aspect computed from the inputs.

6.3.3.8 ConvertBGRToCIELAB()

OFIQ_EXPORT void OFIQ_LIB::ConvertBGRToCIELAB (

const cv::Mat & bgrImage,
double & a,
double & b )

Computes CIELAB values a∗ and b∗ from a BGR image.

Parameters

in bgrImage BGR image

out a CIELAB value a∗
out b CIELAB value b∗

Generated by Doxygen
6.3 OFIQ_LIB Namespace Reference 47

6.3.3.9 copyToCvImage()

OFIQ_EXPORT cv::Mat OFIQ_LIB::copyToCvImage (

const OFIQ::Image & sourceImage,
bool asGrayImage = false )

Convert images in OFIQ::Image format into the OpenCV cv::Mat format. The image can be converted from color to
gray scale by setting the parameter asGrayImage to true.

Parameters
sourceImage Input image.
asGrayImage Switch for adding gray scale conversion.

Returns

cv::Mat Input image in cv::Mat format.

6.3.3.10 Cubic()

OFIQ_EXPORT double OFIQ_LIB::Cubic (

double x,
double k,
double eps )

Cubic flattening function.

Parameters
x Argument
k Argument
eps Argument ϵ

Returns
√
If x ≤ ϵ, then (k · x + 16)/116 is returned; otherwise, if x > ϵ, then 3
x is returned.

6.3.3.11 findLargestBoundingBox()

OFIQ_EXPORT size_t OFIQ_LIB::findLargestBoundingBox (

const std::vector< OFIQ::BoundingBox > & faceRects )

This function returns the position of the largest bounding box (largest in terms of area) from a vector of bounding
boxes.

Parameters

faceRects Vector containing bounding boxes.

Generated by Doxygen
48 Namespace Documentation

Returns

size_t Position of the largest bounding box in the vector.

6.3.3.12 GetLuminanceImageFromBGR()

OFIQ_EXPORT cv::Mat OFIQ_LIB::GetLuminanceImageFromBGR (

const cv::Mat & bgrImage )

Converts a BGR image to the luminance image.

The conversion is specified in the ISO/IEC 29794-5 standard and uses the function ColorConvert() .

Parameters

bgrImage BGR image

Returns

Luminance image.

6.3.3.13 GetNormalizedHistogram()

OFIQ_EXPORT void OFIQ_LIB::GetNormalizedHistogram (

const cv::Mat & luminanceImage,
const cv::Mat & maskImage,
cv::Mat1f & histogram )

Computes the normalized histogram from a luminance image in 256 chunks.

Parameters

in luminanceImage Luminance image as returned by GetLuminanceImageFromBGR() .

in maskImage The histogram is computed on pixels where the values of maskImage are non-zero.
out histogram Array of length 256 where the histogram is stored.

6.3.3.14 MakeGreyImage()

OFIQ_EXPORT OFIQ::Image OFIQ_LIB::MakeGreyImage (

uint16_t width,
uint16_t height )

This function generates a gray scaled image with the resolution passed by the call.

Parameters

width Width of the generated image.

height Height of the generated image.

Generated by Doxygen
6.3 OFIQ_LIB Namespace Reference 49

Returns

OFIQ::Image Generated gray scaled image.

6.3.3.15 makeSquareBoundingBox()

OFIQ_EXPORT OFIQ::BoundingBox OFIQ_LIB::makeSquareBoundingBox (

const OFIQ::BoundingBox & i_bb )

This function converts a non-squarred bounding box into an squarred one. The side length is defined by the greater
one of height or width.

Parameters
i_bb Input bounding box.

Returns

OFIQ::BoundingBox Squarred bounding box.

6.3.3.16 makeSquareBoundingBoxWithPadding()

OFIQ_EXPORT void OFIQ_LIB::makeSquareBoundingBoxWithPadding (

const OFIQ::BoundingBox & i_bb,
const cv::Mat & i_input_image,
cv::Mat & o_output_image,
OFIQ::BoundingBox & o_bb,
Point2i & o_translation_vector )

Some computations, especially neural networks, need a squarred image as input. This funtion consumes a boundig
box and an input image. The greater parameter of width or height is used to define the side length of the new
squarred bounding box. The face will be centered in the bounding box. Padding is added if needed. The squarred
bounding box is used generate a new cropped image, the o_output_image. Required translations are described by
the translation vector o_translation_vector.

Parameters
i_bb Initial bounding box.
i_input_image Input image.
o_output_image Cropped output image. Cropping is based on the computed squarred bounding box.
o_bb Squarred bounding box.
o_translation_vector Translation vector.

6.3.3.17 readImage()

OFIQ_EXPORT OFIQ::ReturnStatus OFIQ_LIB::readImage (

const std::string & filename,
OFIQ::Image & image )

Generated by Doxygen
50 Namespace Documentation

Read image from disk.

Generated by Doxygen
6.4 OFIQ_LIB::modules Namespace Reference 51

Parameters

in filename Path and file name of the image being read from disk.
out image Reference to the image object where the data is loaded to.

Returns

OFIQ::ReturnStatus

6.3.3.18 tmetric()

OFIQ_EXPORT float OFIQ_LIB::tmetric (

const OFIQ::FaceLandmarks & faceLandmarks )

Based on the provided landmarks this function computes the distance between the point between the eyes and the
chin.

Parameters

faceLandmarks Input face landmarks.

Returns

float Computed distance.

6.4 OFIQ_LIB::modules Namespace Reference

Namespaces

• namespace detectors
Provides face detector implementations.
• namespace landmarks
Provides implementations of a landmark extractors.
• namespace measures
Provides measures implemented in OFIQ.
• namespace poseEstimators
Provides implementation of a head pose estimator.
• namespace segmentations
Provides segmentation-related implementations.

6.5 OFIQ_LIB::modules::detectors Namespace Reference

Provides face detector implementations.

Generated by Doxygen
52 Namespace Documentation

Classes

• class SSDFaceDetector
Implementation of a face detector using the SSD face detector CNN.

6.5.1 Detailed Description

Provides face detector implementations.

6.6 OFIQ_LIB::modules::landmarks Namespace Reference

Provides implementations of a landmark extractors.

Namespaces

• namespace adnet
Namespace for ADNet-specific landmarks.

Classes

• class ADNetFaceLandmarkExtractor
Class implementing the FaceLandmarkExtractorInterface interface.
• class FaceMeasures
Provides static functions doing computations with landmarks.
• struct LandmarkPair
Data container for storing pairs of landmarks.
• class PartExtractor
Class that provides helper methods for the administration of landmarks.

Typedefs

• using LandmarkId = int

Type definition of a landmark index.
• using LandmarkIds = std::vector<LandmarkId>
Type definition of a list of landmark indices.
• using FaceMap = std::map<FaceParts, LandmarkIds>
Type definition of a face map to access landmark indices for a queried face part.
• using LandmarkIdPair = std::array<LandmarkId, 2>
Type definition for a pair of landmark index.
• using LandmarkIdPairs = std::vector<LandmarkIdPair>
Type definition for a list of landmark index pairs.
• using FacePairMap = std::map<FaceParts, LandmarkIdPairs>
Structure defining pairs of landmark indices.

Generated by Doxygen
6.6 OFIQ_LIB::modules::landmarks Namespace Reference 53

Enumerations

• enum class FaceParts {

LEFT_EYE , RIGHT_EYE , LEFT_EYE_CORNERS , RIGHT_EYE_CORNERS ,
MOUTH_OUTER , MOUTH_INNER , FACE_CONTOUR , MOUTH_CENTER ,
CHIN , NOSETIP , FOREHEAD }
Enumeration of facial landmark parts.

6.6.1 Detailed Description

Provides implementations of a landmark extractors.

Provides implementations for computations with landmarks.

Provides implementations related to facial landmarks.

6.6.2 Typedef Documentation

6.6.2.1 FaceMap

using OFIQ_LIB::modules::landmarks::FaceMap = std::map<FaceParts, LandmarkIds>

Type definition of a face map to access landmark indices for a queried face part.

6.6.2.2 FacePairMap

using OFIQ_LIB::modules::landmarks::FacePairMap = std::map<FaceParts, LandmarkIdPairs>

Structure defining pairs of landmark indices.

6.6.2.3 LandmarkId

using OFIQ_LIB::modules::landmarks::LandmarkId = int

Type definition of a landmark index.

6.6.2.4 LandmarkIdPair

using OFIQ_LIB::modules::landmarks::LandmarkIdPair = std::array<LandmarkId, 2>

Type definition for a pair of landmark index.

6.6.2.5 LandmarkIdPairs

using OFIQ_LIB::modules::landmarks::LandmarkIdPairs = std::vector<LandmarkIdPair>

Type definition for a list of landmark index pairs.

Generated by Doxygen
54 Namespace Documentation

6.6.2.6 LandmarkIds

using OFIQ_LIB::modules::landmarks::LandmarkIds = std::vector<LandmarkId>

Type definition of a list of landmark indices.

6.6.3 Enumeration Type Documentation

6.6.3.1 FaceParts

enum class OFIQ_LIB::modules::landmarks::FaceParts [strong]

Enumeration of facial landmark parts.

Enumerator

LEFT_EYE left as seen on the image, it's the persons right eye
RIGHT_EYE right as seen on the image, it's the persons left eye
LEFT_EYE_CORNERS two landmarks - outer, inner corner
RIGHT_EYE_CORNERS two landmarks - outer, inner corner
MOUTH_OUTER outer landmarks of mouth
MOUTH_INNER inner landmarks of mouth
FACE_CONTOUR contour of the face
MOUTH_CENTER center of the mouth
CHIN chin
NOSETIP nosetip
FOREHEAD forehead

6.7 OFIQ_LIB::modules::landmarks::adnet Namespace Reference

Namespace for ADNet-specific landmarks.

Variables

• const LandmarkIds leftEye {60,61,62,63,64,65,66,67}

Landmark indices (ADNet) of the left eye.
• const LandmarkIds rightEye {68,69,70,71,72,73,74,75}
Landmark indices (ADNet) of the right eye.
• const LandmarkIds leftEyeCorners {60,64}
Landmark indices (ADNet) of the left eyes' corners.
• const LandmarkIds rightEyeCorners {68,72}
Landmark indices (ADNet) of the right eyes' corners.
• const LandmarkIds nosetip {54}
Landmark index (ADNet) of the nose tip.
• const LandmarkIds mouthOuter {76,77,78,79,80,81,82,83,84,85,86,87}
Landmark indices (ADNet) on the mouth's outer contour.

Generated by Doxygen
6.7 OFIQ_LIB::modules::landmarks::adnet Namespace Reference 55

• const LandmarkIds mouthInner {88,89,90,91,92,93,94,95}

Landmark indices (ADNet) on the mouth's inner lip borders.
• const LandmarkIds contour {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32}
Landmark indices (ADNet) of the face contour.
• const LandmarkIds forehead {}
Landmark indices (ADNet) of the forehead (empty for ADNet).
• const LandmarkIds chin {16}
Landmark index (ADNet) of the chin.
• const landmarks::FaceMap FaceMap
ADNets face map definition.
• const LandmarkIdPairs pairsLeftEye
Pair indices of landmarks (ADNet) for the left eye.
• const LandmarkIdPairs pairsRightEye
Landmark index pairs (ADNet) of landmarks for the right eye.
• const LandmarkIdPairs pairsInnerLip
Landmark index pairs (ADNet) of inner lip pairs.
• const LandmarkIdPairs pairsMouthCenter
Landmark index pair (ADNet) of the inner mouth (lips) center.
• const landmarks::FacePairMap FacePairMap
ADNets face pair map definition.

6.7.1 Detailed Description

Namespace for ADNet-specific landmarks.

6.7.2 Variable Documentation

6.7.2.1 chin

const LandmarkIds OFIQ_LIB::modules::landmarks::adnet::chin {16}

Landmark index (ADNet) of the chin.

6.7.2.2 contour

const LandmarkIds OFIQ_LIB::modules::landmarks::adnet::contour {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18

Landmark indices (ADNet) of the face contour.

6.7.2.3 FaceMap

const landmarks::FaceMap OFIQ_LIB::modules::landmarks::adnet::FaceMap

Initial value:
{
{FaceParts::LEFT_EYE, leftEye },
{FaceParts::RIGHT_EYE, rightEye },
{FaceParts::LEFT_EYE_CORNERS, leftEyeCorners},
{FaceParts::RIGHT_EYE_CORNERS, rightEyeCorners},
{FaceParts::MOUTH_OUTER, mouthOuter },
{FaceParts::MOUTH_INNER, mouthInner },
{FaceParts::FACE_CONTOUR, contour },
{FaceParts::CHIN, chin },
{FaceParts::NOSETIP, nosetip },
{FaceParts::FOREHEAD, forehead }
}

ADNets face map definition.

Generated by Doxygen
56 Namespace Documentation

6.7.2.4 FacePairMap

const landmarks::FacePairMap OFIQ_LIB::modules::landmarks::adnet::FacePairMap

Initial value:
{
{FaceParts::LEFT_EYE, pairsLeftEye },
{FaceParts::RIGHT_EYE, pairsRightEye },
{FaceParts::MOUTH_INNER, pairsInnerLip },
{FaceParts::MOUTH_CENTER, pairsMouthCenter}
}

ADNets face pair map definition.

6.7.2.5 forehead

const LandmarkIds OFIQ_LIB::modules::landmarks::adnet::forehead {}

Landmark indices (ADNet) of the forehead (empty for ADNet).

6.7.2.6 leftEye

const LandmarkIds OFIQ_LIB::modules::landmarks::adnet::leftEye {60,61,62,63,64,65,66,67}

Landmark indices (ADNet) of the left eye.

The left eye is defined as seen on the image; it is actually the person's right eye (physically).

6.7.2.7 leftEyeCorners

const LandmarkIds OFIQ_LIB::modules::landmarks::adnet::leftEyeCorners {60,64}

Landmark indices (ADNet) of the left eyes' corners.

6.7.2.8 mouthInner

const LandmarkIds OFIQ_LIB::modules::landmarks::adnet::mouthInner {88,89,90,91,92,93,94,95}

Landmark indices (ADNet) on the mouth's inner lip borders.

6.7.2.9 mouthOuter

const LandmarkIds OFIQ_LIB::modules::landmarks::adnet::mouthOuter {76,77,78,79,80,81,82,83,84,85,86,87}

Landmark indices (ADNet) on the mouth's outer contour.

6.7.2.10 nosetip

const LandmarkIds OFIQ_LIB::modules::landmarks::adnet::nosetip {54}

Landmark index (ADNet) of the nose tip.

Generated by Doxygen
6.7 OFIQ_LIB::modules::landmarks::adnet Namespace Reference 57

6.7.2.11 pairsInnerLip

const LandmarkIdPairs OFIQ_LIB::modules::landmarks::adnet::pairsInnerLip

Initial value:
{
{89, 95},
{90, 94},
{91, 93}
}

Landmark index pairs (ADNet) of inner lip pairs.

Useful to measure closedness of mouth.

6.7.2.12 pairsLeftEye

const LandmarkIdPairs OFIQ_LIB::modules::landmarks::adnet::pairsLeftEye

Initial value:
{
{61, 67},
{62, 66},
{63, 65}
}

Pair indices of landmarks (ADNet) for the left eye.

Useful to measure eye openess.

6.7.2.13 pairsMouthCenter

const LandmarkIdPairs OFIQ_LIB::modules::landmarks::adnet::pairsMouthCenter

Initial value:
{
{90, 94}
}

Landmark index pair (ADNet) of the inner mouth (lips) center.

Useful to measure closedness of mouth.

6.7.2.14 pairsRightEye

const LandmarkIdPairs OFIQ_LIB::modules::landmarks::adnet::pairsRightEye

Initial value:
{
{69, 75},
{70, 74},
{71, 73}
}

Landmark index pairs (ADNet) of landmarks for the right eye.

Useful to measure eye openess.

Generated by Doxygen
58 Namespace Documentation

6.7.2.15 rightEye

const LandmarkIds OFIQ_LIB::modules::landmarks::adnet::rightEye {68,69,70,71,72,73,74,75}

Landmark indices (ADNet) of the right eye.

The right eye is defined as seen on the image; it is actually the person's left eye (physically).

6.7.2.16 rightEyeCorners

const LandmarkIds OFIQ_LIB::modules::landmarks::adnet::rightEyeCorners {68,72}

Landmark indices (ADNet) of the right eyes' corners.

6.8 OFIQ_LIB::modules::measures Namespace Reference

Provides measures implemented in OFIQ.

Classes

• class BackgroundUniformity
Implementation of the background uniformity measure.
• class CompressionArtifacts
Implementation of the no compression artifacts measure.
• class CropOfTheFaceImage
Implementation of the crop of the face image measure.
• class DynamicRange
Implementation of the dynamic range measure.
• class Executor
This class takes care of the computation of the measures activated.
• class ExpressionNeutrality
Provides a class implementing the expression neutrality measure.
• class EyesOpen
Implementation of the eyes open measure.
• class EyesVisible
Implementation of the eyes visible measure.
• class FaceOcclusionPrevention
Implementation of the face occlusion prevention measure.
• class HeadPose
Implementation of head pose measures.
• class HeadSize
Implementation of the head size measure.
• class IlluminationUniformity
Implementation of the illumination uniformity measure.
• class InterEyeDistance
Implementation of the inter-eye distance measure.
• class Luminance
Implementation of two luminance measures.

Generated by Doxygen
6.8 OFIQ_LIB::modules::measures Namespace Reference 59

• class Measure
Base class for measures implemented in OFIQ.
• class MeasureFactory
Measure factor class.
• class MouthClosed
Implementation of the mouth closed measure.
• class MouthOcclusionPrevention
Implementation of the mouth occlusion prevention measure.
• class NaturalColour
Implementation of the natural colour measure.
• class NoHeadCoverings
Implementation of the no head covering measure.
• class OverExposurePrevention
Implementation of the over-exposure prevention measure.
• class Sharpness
Implemantation of the sharpness measure.
• struct SigmoidParameters
Parameters of the sigmoid function based quality mapping.
• class SingleFacePresent
Implementation of the single face present measure.
• class UnderExposurePrevention
Implementation of the under-exposure prevention measure.
• class UnifiedQualityScore
Implementation of the unified quality measure.

Functions

• void log (const std::string_view &msg)

Logging function for writing debug messages to std::cout.

Variables

• static const bool ExecutorLogActive = false

This variable enables logging to std::cout for debug purposes. By default the logging is switched off.

6.8.1 Detailed Description

Provides measures implemented in OFIQ.

6.8.2 Function Documentation

6.8.2.1 log()

void OFIQ_LIB::modules::measures::log (
const std::string_view & msg )

Logging function for writing debug messages to std::cout.

Generated by Doxygen
60 Namespace Documentation

Parameters
msg Message to be logged.

6.8.3 Variable Documentation

6.8.3.1 ExecutorLogActive

const bool OFIQ_LIB::modules::measures::ExecutorLogActive = false [static]

This variable enables logging to std::cout for debug purposes. By default the logging is switched off.

6.9 OFIQ_LIB::modules::poseEstimators Namespace Reference

Provides implementation of a head pose estimator.

Classes

• class HeadPose3DDFAV2
Implementation of a head pose estimator.

6.9.1 Detailed Description

Provides implementation of a head pose estimator.

6.10 OFIQ_LIB::modules::segmentations Namespace Reference

Provides segmentation-related implementations.

Classes

• class FaceOcclusionSegmentation
Class managing the separation of facial parts not occluded by non-facial parts from other parts.
• class FaceParsing
Class managing the separation of facial parts not occluded by non-facial parts from other parts.

Enumerations

• enum class SegmentClassLabels {

background , skin , l_brow , r_brow ,
l_eye , r_eye , eye_g , l_ear ,
r_ear , ear_r , nose , mouth ,
u_lip , l_lip , neck , neck_l ,
cloth , hair , hat , face }
Enum class of the different face regioons that can be segmented.

Generated by Doxygen
6.10 OFIQ_LIB::modules::segmentations Namespace Reference 61

6.10.1 Detailed Description

Provides segmentation-related implementations.

Namespace for implementations related to facial segmentations.

6.10.2 Enumeration Type Documentation

6.10.2.1 SegmentClassLabels

enum class OFIQ_LIB::modules::segmentations::SegmentClassLabels [strong]

Enum class of the different face regioons that can be segmented.

Enumerator
background background label
skin skin label
l_brow left eye brow
r_brow right eye brow
l_eye left eye
r_eye right eye brow
eye_g eye glasses
l_ear left ear
r_ear right eye brow
ear_r earring
nose nose
mouth mouth
u_lip upper lip
l_lip lower lip
neck neck
neck_l necklace
cloth clothing
hair hair
hat head covering
face face

Generated by Doxygen
62 Namespace Documentation

Generated by Doxygen
Chapter 7

Class Documentation

7.1 OFIQ_LIB::modules::landmarks::ADNetFaceLandmarkExtractor
Class Reference

Class implementing the FaceLandmarkExtractorInterface interface.

#include <adnet_landmarks.h>

Inheritance diagram for OFIQ_LIB::modules::landmarks::ADNetFaceLandmarkExtractor:

OFIQ_LIB::FaceLandmarkExtractorInterface

OFIQ_LIB::modules::landmarks::ADNetFaceLandmarkExtractor

Public Member Functions

• ADNetFaceLandmarkExtractor (const Configuration &config)

Constructor.
• ∼ADNetFaceLandmarkExtractor () override
Destructor.

Public Member Functions inherited from OFIQ_LIB::FaceLandmarkExtractorInterface

• virtual ∼FaceLandmarkExtractorInterface ()=default

Destructor.
• OFIQ::FaceLandmarks extractLandmarks (OFIQ_LIB::Session &session)
Public method to extract landmarks from the image passed in the session object.

Protected Member Functions

• OFIQ::FaceLandmarks updateLandmarks (OFIQ_LIB::Session &session) override

Computes landmarks of the face detected in the session.

Generated by Doxygen
64 Class Documentation

Private Attributes

• std::unique_ptr< ADNetFaceLandmarkExtractorImpl > landmarkExtractor_

Encapsulated implementation class.

7.1.1 Detailed Description

Class implementing the FaceLandmarkExtractorInterface interface.

7.1.2 Constructor & Destructor Documentation

7.1.2.1 ADNetFaceLandmarkExtractor()

OFIQ_LIB::modules::landmarks::ADNetFaceLandmarkExtractor::ADNetFaceLandmarkExtractor (
const Configuration & config ) [explicit]

Constructor.

Parameters

config Configuration object

7.1.2.2 ∼ADNetFaceLandmarkExtractor()

OFIQ_LIB::modules::landmarks::ADNetFaceLandmarkExtractor::∼ADNetFaceLandmarkExtractor ( )
[override]

Destructor.

7.1.3 Member Function Documentation

7.1.3.1 updateLandmarks()

OFIQ::FaceLandmarks OFIQ_LIB::modules::landmarks::ADNetFaceLandmarkExtractor::updateLandmarks
(
OFIQ_LIB::Session & session ) [override], [protected], [virtual]

Computes landmarks of the face detected in the session.

The landmarks are computed using ADNet.

Parameters

session Session object containing preprocessing results used by the function to compute the landmarks.

Generated by Doxygen
7.2 OFIQ_LIB::modules::measures::BackgroundUniformity Class Reference 65

Returns

Facial landmarks.

Implements OFIQ_LIB::FaceLandmarkExtractorInterface.

7.1.4 Member Data Documentation

7.1.4.1 landmarkExtractor_

std::unique_ptr<ADNetFaceLandmarkExtractorImpl> OFIQ_LIB::modules::landmarks::ADNetFace←-
LandmarkExtractor::landmarkExtractor_ [private]

Encapsulated implementation class.

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

• adnet_landmarks.h

7.2 OFIQ_LIB::modules::measures::BackgroundUniformity Class

Reference

Implementation of the background uniformity measure.

#include <BackgroundUniformity.h>
Inheritance diagram for OFIQ_LIB::modules::measures::BackgroundUniformity:

OFIQ_LIB::modules::measures::Measure

OFIQ_LIB::modules::measures::BackgroundUniformity

Public Member Functions

• BackgroundUniformity (const Configuration &configuration)

Constructor.
• void Execute (OFIQ_LIB::Session &session) override
Assesses uniformity of the background.

Public Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• Measure (const Configuration &configuration, OFIQ::QualityMeasure measure)
Constructor.
• virtual ∼Measure ()=default
Destructor.
• virtual std::string GetName () const
Returns the name of the measure.
• virtual OFIQ::QualityMeasure GetQualityMeasure () const
Returns an enum encoding the measure.
• void SetQualityMeasure (OFIQ_LIB::Session &session, OFIQ::QualityMeasure measure, double rawValue,
OFIQ::QualityMeasureReturnCode code)
Inserts the result of a quality assessment in the session object.

Generated by Doxygen
66 Class Documentation

Private Attributes

• uint16_t m_targetHeight = 292

The aligned image and the face parsing mask is brought to an image of the target height before gradient computations
and assessment is applied.
• uint16_t m_targetWidth = 354
The aligned image and the face parsing mask is brought to an image of the target width before gradient computations
and assessment is applied.
• uint16_t m_cropLeft = 62
Crop from the left side of the aligned image (returned by OFIQ_LIB::Session::getAlignedFace()) before scaling to the
target dimension is applied.
• uint16_t m_cropRight = 62
Crop from the right side of the aligned image (returned by OFIQ_LIB::Session::getAlignedFace()) before scaling to
the target dimension is applied.
• uint16_t m_cropTop = 0
Crop from the top of the aligned image (returned by OFIQ_LIB::Session::getAlignedFace()) before scaling to the target
dimension is applied.
• uint16_t m_cropBottom = 210
Crop from the bottom of the aligned image (returned by OFIQ_LIB::Session::getAlignedFace()) before scaling to the
target dimension is applied.
• uint16_t m_erosionKernelSize = 4
Size of the erosion kernel applied to the background as per OFIQ_LIB::modules::segmentations::FaceParsing to
reduce the risk that background unformity estimation is applied to part of the subject.

Additional Inherited Members

Protected Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• void AddSigmoid (OFIQ::QualityMeasure measure, const SigmoidParameters &defaultValues)

Reads sigmoid-function based quality mapping from the configuration.
• void AddSigmoid (const std::string &key, SigmoidParameters defaultValues)
Reads sigmoid-function based quality mapping from the configuration.
• double ExecuteScalarConversion (OFIQ::QualityMeasure measure, double rawValue)
Maps a native quality score to a quality component value.
• double ExecuteScalarConversion (const std::string &key, double rawValue)
Maps a native quality score to a quality component value.

Static Protected Member Functions inherited from

OFIQ_LIB::modules::measures::Measure

• static double Sigmoid (double x, double x0, double w)

Sigmoid function.

Protected Attributes inherited from OFIQ_LIB::modules::measures::Measure

• const Configuration & configuration

Reference to the configuration with which the measure constructor has been invoked.

Generated by Doxygen
7.2 OFIQ_LIB::modules::measures::BackgroundUniformity Class Reference 67

7.2.1 Detailed Description

Implementation of the background uniformity measure.

Uniformity of the backgound is measured on basis of the mean of the gradients computed on the background as
per face parsing (see OFIQ_LIB::modules::segmentations::FaceParsing).

7.2.2 Constructor & Destructor Documentation

7.2.2.1 BackgroundUniformity()

OFIQ_LIB::modules::measures::BackgroundUniformity::BackgroundUniformity (
const Configuration & configuration ) [explicit]

Constructor.

Parameters

configuration Configuration object from which the measure related configuration is read.

7.2.3 Member Function Documentation

7.2.3.1 Execute()

void OFIQ_LIB::modules::measures::BackgroundUniformity::Execute (
OFIQ_LIB::Session & session ) [override], [virtual]

Assesses uniformity of the background.

Assessment of the background uniformity is done by computing the mean of the background as per face parsing
(see OFIQ_LIB::modules::segmentations::FaceParsing).

Parameters

session Session object computed by the OFIQImpl::performPreprocessing() .

Implements OFIQ_LIB::modules::measures::Measure.

7.2.4 Member Data Documentation

7.2.4.1 m_cropBottom

uint16_t OFIQ_LIB::modules::measures::BackgroundUniformity::m_cropBottom = 210 [private]

Crop from the bottom of the aligned image (returned by OFIQ_LIB::Session::getAlignedFace()) before scaling to the
target dimension is applied.

Generated by Doxygen
68 Class Documentation

7.2.4.2 m_cropLeft

uint16_t OFIQ_LIB::modules::measures::BackgroundUniformity::m_cropLeft = 62 [private]

Crop from the left side of the aligned image (returned by OFIQ_LIB::Session::getAlignedFace()) before scaling to
the target dimension is applied.

7.2.4.3 m_cropRight

uint16_t OFIQ_LIB::modules::measures::BackgroundUniformity::m_cropRight = 62 [private]

Crop from the right side of the aligned image (returned by OFIQ_LIB::Session::getAlignedFace()) before scaling to
the target dimension is applied.

7.2.4.4 m_cropTop

uint16_t OFIQ_LIB::modules::measures::BackgroundUniformity::m_cropTop = 0 [private]

Crop from the top of the aligned image (returned by OFIQ_LIB::Session::getAlignedFace()) before scaling to the
target dimension is applied.

7.2.4.5 m_erosionKernelSize

uint16_t OFIQ_LIB::modules::measures::BackgroundUniformity::m_erosionKernelSize = 4 [private]

Size of the erosion kernel applied to the background as per OFIQ_LIB::modules::segmentations::FaceParsing to

reduce the risk that background unformity estimation is applied to part of the subject.

7.2.4.6 m_targetHeight

uint16_t OFIQ_LIB::modules::measures::BackgroundUniformity::m_targetHeight = 292 [private]

The aligned image and the face parsing mask is brought to an image of the target height before gradient computa-
tions and assessment is applied.

7.2.4.7 m_targetWidth

uint16_t OFIQ_LIB::modules::measures::BackgroundUniformity::m_targetWidth = 354 [private]

The aligned image and the face parsing mask is brought to an image of the target width before gradient computations
and assessment is applied.

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

• BackgroundUniformity.h

Generated by Doxygen
7.3 OFIQ::BoundingBox Struct Reference 69

7.3 OFIQ::BoundingBox Struct Reference

Data structure for descibing bounding boxes, e.g. the face region of the faces found by a face detector.

#include <ofiq_structs.h>

Public Member Functions

• BoundingBox ()=default
Default constructor.
• BoundingBox (int16_t xleft, int16_t ytop, int16_t width, int16_t height, FaceDetectorType i_faceDetector)
Parameterized constructor.

Public Attributes

• int16_t xleft { -1 }
leftmost point on head, typically subject's right ear value must be on [0, imageWidth-1]
• int16_t ytop { -1 }
high point of head, typically top of hair; value must be on [0, imageHeight-1]
• int16_t width { -1 }
bounding box width
• int16_t height { -1 }
bounding box height
• FaceDetectorType faceDetector = FaceDetectorType::NotSet
Description of the face detector used.

7.3.1 Detailed Description

Data structure for descibing bounding boxes, e.g. the face region of the faces found by a face detector.

7.3.2 Constructor & Destructor Documentation

7.3.2.1 BoundingBox() [1/2]

OFIQ::BoundingBox::BoundingBox ( ) [default]

Default constructor.

7.3.2.2 BoundingBox() [2/2]

OFIQ::BoundingBox::BoundingBox (
int16_t xleft,
int16_t ytop,
int16_t width,
int16_t height,
FaceDetectorType i_faceDetector ) [inline]

Parameterized constructor.

Generated by Doxygen
70 Class Documentation

Parameters

xleft x coordinate of the upper left point of the bounding box.

ytop y coordinate of the upper left point of the bounding box.
width width of the bounding box.
height height of the bounding box.
i_faceDetector used face detector.

7.3.3 Member Data Documentation

7.3.3.1 faceDetector

FaceDetectorType OFIQ::BoundingBox::faceDetector = FaceDetectorType::NotSet

Description of the face detector used.

7.3.3.2 height

int16_t OFIQ::BoundingBox::height { -1 }

bounding box height

7.3.3.3 width

int16_t OFIQ::BoundingBox::width { -1 }

bounding box width

7.3.3.4 xleft

int16_t OFIQ::BoundingBox::xleft { -1 }

leftmost point on head, typically subject's right ear value must be on [0, imageWidth-1]

7.3.3.5 ytop

int16_t OFIQ::BoundingBox::ytop { -1 }

high point of head, typically top of hair; value must be on [0, imageHeight-1]

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

• ofiq_structs.h

Generated by Doxygen
7.4 OFIQ_LIB::modules::measures::CompressionArtifacts Class Reference 71

7.4 OFIQ_LIB::modules::measures::CompressionArtifacts Class

Reference

Implementation of the no compression artifacts measure.

#include <CompressionArtifacts.h>

Inheritance diagram for OFIQ_LIB::modules::measures::CompressionArtifacts:

OFIQ_LIB::modules::measures::Measure

OFIQ_LIB::modules::measures::CompressionArtifacts

Public Member Functions

• CompressionArtifacts (const Configuration &configuration)

Constructor.
• void Execute (OFIQ_LIB::Session &session) override
Assesses abscence of compression artifacts.

Public Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• Measure (const Configuration &configuration, OFIQ::QualityMeasure measure)

Constructor.
• virtual ∼Measure ()=default
Destructor.
• virtual std::string GetName () const
Returns the name of the measure.
• virtual OFIQ::QualityMeasure GetQualityMeasure () const
Returns an enum encoding the measure.
• void SetQualityMeasure (OFIQ_LIB::Session &session, OFIQ::QualityMeasure measure, double rawValue,
OFIQ::QualityMeasureReturnCode code)
Inserts the result of a quality assessment in the session object.

Private Attributes

• int m_crop
Top, right, left, and bottom margin by which the aligned image is cropped.
• int m_dim
Target dimension of cropped image being scaled before input to the CNN .
• ONNXRuntimeSegmentation m_onnxRuntimeEnv
Manages CNN estimations.

Generated by Doxygen
72 Class Documentation

Additional Inherited Members

Protected Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• void AddSigmoid (OFIQ::QualityMeasure measure, const SigmoidParameters &defaultValues)
Reads sigmoid-function based quality mapping from the configuration.
• void AddSigmoid (const std::string &key, SigmoidParameters defaultValues)
Reads sigmoid-function based quality mapping from the configuration.
• double ExecuteScalarConversion (OFIQ::QualityMeasure measure, double rawValue)
Maps a native quality score to a quality component value.
• double ExecuteScalarConversion (const std::string &key, double rawValue)
Maps a native quality score to a quality component value.

Static Protected Member Functions inherited from

OFIQ_LIB::modules::measures::Measure
• static double Sigmoid (double x, double x0, double w)
Sigmoid function.

Protected Attributes inherited from OFIQ_LIB::modules::measures::Measure

• const Configuration & configuration
Reference to the configuration with which the measure constructor has been invoked.

7.4.1 Detailed Description

Implementation of the no compression artifacts measure.

Assessment of the abscence of compression artifact (both JPEG and JPEG2000) based on a CNN trained by the
OFIQ development team.

7.4.2 Constructor & Destructor Documentation

7.4.2.1 CompressionArtifacts()

OFIQ_LIB::modules::measures::CompressionArtifacts::CompressionArtifacts (
const Configuration & configuration ) [explicit]

Constructor.

The configuration parameter must contain the following entry:

• params.measures.CompressionArtifacts.model_path: Path to the CNN model file in ONNX

format.

The following entries can (but do not need to) be configured.

• params.measures.CompressionArtifacts.dim: If configured, the value must be 248 which cor-

responds to the dimension of the CNN's input layer; other values will result in an error being thrown when
OFIQ's CNN is invoked.

• params.measures.CompressionArtifacts.crop: Top, right, bottom, and left margin by which

the aligned input image will be cropped before being scaled to the target dimension input of the CNN.

Generated by Doxygen
7.4 OFIQ_LIB::modules::measures::CompressionArtifacts Class Reference 73

Parameters

configuration Configuration object from which measure-related configuration is read.

Exceptions

OFIQ_LIB::OFIQError if no valid model path is configured.

7.4.3 Member Function Documentation

7.4.3.1 Execute()

void OFIQ_LIB::modules::measures::CompressionArtifacts::Execute (
OFIQ_LIB::Session & session ) [override], [virtual]

Assesses abscence of compression artifacts.

Assessment of the abscence of compression artifact (both JPEG and JPEG2000) based on a CNN trained by the
OFIQ development team.

Parameters

session Session object computed by the OFIQImpl::performPreprocessing() method.

Implements OFIQ_LIB::modules::measures::Measure.

7.4.4 Member Data Documentation

7.4.4.1 m_crop

int OFIQ_LIB::modules::measures::CompressionArtifacts::m_crop [private]

Top, right, left, and bottom margin by which the aligned image is cropped.
The value can be configured by passing a corresponding configuration to the constructor.

Warning

The value should be 184 such that an aligned input image of dimension 616 x 616 is cropped to an image of
dimension 248 x 248.

7.4.4.2 m_dim

int OFIQ_LIB::modules::measures::CompressionArtifacts::m_dim [private]

Target dimension of cropped image being scaled before input to the CNN .
The cropped image is scaled to the dimension m_dim x m_dim. The value can be configured by passing a corre-
sponding configuration to the constructor.

Warning

The value should be 248; if configured differently, do not expect that the cropped image can be successfully
be passed to the CNN.

Generated by Doxygen
74 Class Documentation

7.4.4.3 m_onnxRuntimeEnv

ONNXRuntimeSegmentation OFIQ_LIB::modules::measures::CompressionArtifacts::m_onnxRuntimeEnv
[private]

Manages CNN estimations.

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

• CompressionArtifacts.h

7.5 OFIQ_LIB::Configuration Class Reference

Configuration class.

#include <Configuration.h>

Public Member Functions

• Configuration (const std::string &configDir, const std::string &configFilename)

Constructor.
• bool GetBool (const std::string &key, bool &value) const
Accesses a boolean configuration.
• bool GetString (const std::string &key, std::string &value) const
Accesses a string configuration.
• bool GetNumber (const std::string &key, double &value) const
Accesses a double configuration.
• bool GetStringList (const std::string &key, std::vector< std::string > &value) const
Accesses an array of strings configured.
• bool GetBool (const std::string &key) const
Accesses a boolean configuration.
• std::string GetString (const std::string &key) const
Accesses a string configuration.
• double GetNumber (const std::string &key) const
Accesses a double configuration.
• std::string getDataDir () const
Access configuration directory.
• void SetDataDir (std::string dataDir)
Sets the configuration directory.

Private Attributes

• std::map< std::string, tao::json::value, std::less<> > parameters

Map holding all configuration that can be accessed using a string key.
• std::filesystem::path m_dataDir
Path to the configuration directory.

Generated by Doxygen
7.5 OFIQ_LIB::Configuration Class Reference 75

7.5.1 Detailed Description

Configuration class.

The class consumes the taoJSON library. A configuration is read from a JAXN-formatted file.

7.5.2 Constructor & Destructor Documentation

7.5.2.1 Configuration()

OFIQ_LIB::Configuration::Configuration (
const std::string & configDir,
const std::string & configFilename )

Constructor.

Parameters

configDir Directory from which a JAXN configuration is read. The path can be absolute or relative to
the path of the current working directory.
configFilename Name of the JAXN configuration file in configDir.

7.5.3 Member Function Documentation

7.5.3.1 GetBool() [1/2]

bool OFIQ_LIB::Configuration::GetBool (
const std::string & key ) const

Accesses a boolean configuration.

Parameters

key Key of the configuration.

Returns

The accessed boolean configuration.

Exceptions

OFIQ_LIB::OFIQError if the configuration was not successfully accessed.

7.5.3.2 GetBool() [2/2]

bool OFIQ_LIB::Configuration::GetBool (

Generated by Doxygen
76 Class Documentation

const std::string & key,

bool & value ) const

Accesses a boolean configuration.

Parameters

key Key of the configuration.

value Boolean reference to where the configuration result is stored.

Returns

true if the configuration was successfully accessed; otherwise, if the configuration was not successfully
accessed, the function returns false.

7.5.3.3 getDataDir()

std::string OFIQ_LIB::Configuration::getDataDir ( ) const

Access configuration directory.

The configuration directory has been specified in the constructor or afterwards by the SetDataDir() method.

Returns

String representation of the configuration directory.

7.5.3.4 GetNumber() [1/2]

double OFIQ_LIB::Configuration::GetNumber (
const std::string & key ) const

Accesses a double configuration.

Parameters

key Key of the configuration.

Returns

The accessed double configuration.

Exceptions

OFIQ_LIB::OFIQError if the configuration was not successfully accessed.

Generated by Doxygen
7.5 OFIQ_LIB::Configuration Class Reference 77

7.5.3.5 GetNumber() [2/2]

bool OFIQ_LIB::Configuration::GetNumber (
const std::string & key,
double & value ) const

Accesses a double configuration.

Parameters

key Key of the configuration.

value Reference to a double type to where the configuration result is stored.

Returns

true if the configuration was successfully accessed; otherwise, if the configuration was not successfully
accessed, the function returns false.

7.5.3.6 GetString() [1/2]

std::string OFIQ_LIB::Configuration::GetString (
const std::string & key ) const

Accesses a string configuration.

Parameters

key Key of the configuration.

Returns

The accessed string configuration.

Exceptions

OFIQ_LIB::OFIQError if the configuration was not successfully accessed.

7.5.3.7 GetString() [2/2]

bool OFIQ_LIB::Configuration::GetString (
const std::string & key,
std::string & value ) const

Accesses a string configuration.

Parameters

key Key of the configuration.

value std::string reference to where the configuration result is stored.
Generated by Doxygen
78 Class Documentation

Returns

true if the configuration was successfully accessed; otherwise, if the configuration was not successfully
accessed, the function returns false.

7.5.3.8 GetStringList()

bool OFIQ_LIB::Configuration::GetStringList (
const std::string & key,
std::vector< std::string > & value ) const

Accesses an array of strings configured.

The string list will not be emptied; any strings read will be appended.

Parameters

key Key of the configuration.

value Reference to a string list to where the configuration result is stored.

Returns

true if the configuration was successfully accessed; otherwise, if the configuration was not successfully
accessed, the function returns false.

7.5.3.9 SetDataDir()

void OFIQ_LIB::Configuration::SetDataDir (
std::string dataDir )

Sets the configuration directory.

Parameters

dataDir String representation of the configuration directory.

Attention

The configurations will not be updated when this method is called; it causes only an update of an internal
private path member.

7.5.4 Member Data Documentation

7.5.4.1 m_dataDir

std::filesystem::path OFIQ_LIB::Configuration::m_dataDir [private]

Path to the configuration directory.

The member is set either by the constructor or by the SetDataDir() method.

Generated by Doxygen
7.6 OFIQ_LIB::modules::measures::CropOfTheFaceImage Class Reference 79

7.5.4.2 parameters

std::map<std::string, tao::json::value, std::less<> > OFIQ_LIB::Configuration::parameters

[private]

Map holding all configuration that can be accessed using a string key.

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

• Configuration.h

7.6 OFIQ_LIB::modules::measures::CropOfTheFaceImage Class

Reference

Implementation of the crop of the face image measure.

#include <CropOfTheFaceImage.h>

Inheritance diagram for OFIQ_LIB::modules::measures::CropOfTheFaceImage:

OFIQ_LIB::modules::measures::Measure

OFIQ_LIB::modules::measures::CropOfTheFaceImage

Public Member Functions

• CropOfTheFaceImage (const Configuration &configuration)

Constructor.
• void Execute (OFIQ_LIB::Session &session) override
Implementation of the crop of the face image measure.

Public Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• Measure (const Configuration &configuration, OFIQ::QualityMeasure measure)

Constructor.
• virtual ∼Measure ()=default
Destructor.
• virtual std::string GetName () const
Returns the name of the measure.
• virtual OFIQ::QualityMeasure GetQualityMeasure () const
Returns an enum encoding the measure.
• void SetQualityMeasure (OFIQ_LIB::Session &session, OFIQ::QualityMeasure measure, double rawValue,
OFIQ::QualityMeasureReturnCode code)
Inserts the result of a quality assessment in the session object.

Generated by Doxygen
80 Class Documentation

Additional Inherited Members

Protected Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• void AddSigmoid (OFIQ::QualityMeasure measure, const SigmoidParameters &defaultValues)

Reads sigmoid-function based quality mapping from the configuration.
• void AddSigmoid (const std::string &key, SigmoidParameters defaultValues)
Reads sigmoid-function based quality mapping from the configuration.
• double ExecuteScalarConversion (OFIQ::QualityMeasure measure, double rawValue)
Maps a native quality score to a quality component value.
• double ExecuteScalarConversion (const std::string &key, double rawValue)
Maps a native quality score to a quality component value.

Static Protected Member Functions inherited from

OFIQ_LIB::modules::measures::Measure

• static double Sigmoid (double x, double x0, double w)

Sigmoid function.

Protected Attributes inherited from OFIQ_LIB::modules::measures::Measure

• const Configuration & configuration

Reference to the configuration with which the measure constructor has been invoked.

7.6.1 Detailed Description

Implementation of the crop of the face image measure.

The crop of the face images measures whether the face is centered on the input image by comparing the resolution
of the image with the landmarks detected during the pre-processing.

7.6.2 Constructor & Destructor Documentation

7.6.2.1 CropOfTheFaceImage()

OFIQ_LIB::modules::measures::CropOfTheFaceImage::CropOfTheFaceImage (
const Configuration & configuration ) [explicit]

Constructor.

Parameters

configuration Configuration object from which measure-related configuration is read.

Generated by Doxygen
7.7 OFIQ_LIB::modules::measures::DynamicRange Class Reference 81

7.6.3 Member Function Documentation

7.6.3.1 Execute()

void OFIQ_LIB::modules::measures::CropOfTheFaceImage::Execute (
OFIQ_LIB::Session & session ) [override], [virtual]

Implementation of the crop of the face image measure.

The crop of the face images measures whether the face is centered on the input image by comparing the resolution
of the image with the landmarks detected during the pre-processing.

Parameters

session Session object.

Implements OFIQ_LIB::modules::measures::Measure.

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

• CropOfTheFaceImage.h

7.7 OFIQ_LIB::modules::measures::DynamicRange Class Reference

Implementation of the dynamic range measure.

#include <DynamicRange.h>

Inheritance diagram for OFIQ_LIB::modules::measures::DynamicRange:

OFIQ_LIB::modules::measures::Measure

OFIQ_LIB::modules::measures::DynamicRange

Public Member Functions

• DynamicRange (const Configuration &configuration)

Constructor.
• void Execute (OFIQ_LIB::Session &session) override
Assesses dynamic range.

Generated by Doxygen
82 Class Documentation

Public Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• Measure (const Configuration &configuration, OFIQ::QualityMeasure measure)
Constructor.
• virtual ∼Measure ()=default
Destructor.
• virtual std::string GetName () const
Returns the name of the measure.
• virtual OFIQ::QualityMeasure GetQualityMeasure () const
Returns an enum encoding the measure.
• void SetQualityMeasure (OFIQ_LIB::Session &session, OFIQ::QualityMeasure measure, double rawValue,
OFIQ::QualityMeasureReturnCode code)
Inserts the result of a quality assessment in the session object.

Additional Inherited Members

Protected Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• void AddSigmoid (OFIQ::QualityMeasure measure, const SigmoidParameters &defaultValues)
Reads sigmoid-function based quality mapping from the configuration.
• void AddSigmoid (const std::string &key, SigmoidParameters defaultValues)
Reads sigmoid-function based quality mapping from the configuration.
• double ExecuteScalarConversion (OFIQ::QualityMeasure measure, double rawValue)
Maps a native quality score to a quality component value.
• double ExecuteScalarConversion (const std::string &key, double rawValue)
Maps a native quality score to a quality component value.

Static Protected Member Functions inherited from

OFIQ_LIB::modules::measures::Measure
• static double Sigmoid (double x, double x0, double w)
Sigmoid function.

Protected Attributes inherited from OFIQ_LIB::modules::measures::Measure

• const Configuration & configuration
Reference to the configuration with which the measure constructor has been invoked.

7.7.1 Detailed Description

Implementation of the dynamic range measure.

The dynamic range is computed from the luminance histogram. of the facial image.

7.7.2 Constructor & Destructor Documentation

7.7.2.1 DynamicRange()

OFIQ_LIB::modules::measures::DynamicRange::DynamicRange (
const Configuration & configuration ) [explicit]

Constructor.

Generated by Doxygen
7.8 OFIQ_LIB::modules::measures::Executor Class Reference 83

Parameters

configuration Configuration object from which the measure-related configuration is read.

7.7.3 Member Function Documentation

7.7.3.1 Execute()

void OFIQ_LIB::modules::measures::DynamicRange::Execute (
OFIQ_LIB::Session & session ) [override], [virtual]

Assesses dynamic range.

Assessment of the dynamic range is computed from the luminance histogram.

Parameters

session Session object.

Implements OFIQ_LIB::modules::measures::Measure.

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

• DynamicRange.h

7.8 OFIQ_LIB::modules::measures::Executor Class Reference

This class takes care of the computation of the measures activated.

#include <Executor.h>

Public Member Functions

• Executor (std::vector< std::unique_ptr< Measure > > measures)

Construct a new Executor object.
• void ExecuteAll (Session &i_currentSession) const
Run the computation of the activated measures on the data of the provided session.
• const std::vector< std::unique_ptr< Measure > > & GetMeasures () const
Return the list of the activated measures.

Private Attributes

• std::vector< std::unique_ptr< Measure > > m_measures

Container for access to the measures to be computed.

Generated by Doxygen
84 Class Documentation

7.8.1 Detailed Description

This class takes care of the computation of the measures activated.

7.8.2 Constructor & Destructor Documentation

7.8.2.1 Executor()

OFIQ_LIB::modules::measures::Executor::Executor (
std::vector< std::unique_ptr< Measure > > measures ) [inline], [explicit]

Construct a new Executor object.

Parameters
measures Provide access to the activated measures.

7.8.3 Member Function Documentation

7.8.3.1 ExecuteAll()

void OFIQ_LIB::modules::measures::Executor::ExecuteAll (
Session & i_currentSession ) const

Run the computation of the activated measures on the data of the provided session.

Parameters

i_currentSession Container providing the data required for the computation of the measures.

7.8.3.2 GetMeasures()

const std::vector< std::unique_ptr< Measure > > & OFIQ_LIB::modules::measures::Executor::←-

GetMeasures ( ) const [inline]

Return the list of the activated measures.

7.8.4 Member Data Documentation

7.8.4.1 m_measures

std::vector<std::unique_ptr<Measure> > OFIQ_LIB::modules::measures::Executor::m_measures

[private]

Container for access to the measures to be computed.

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

• Executor.h

Generated by Doxygen
7.9 OFIQ_LIB::modules::measures::ExpressionNeutrality Class Reference 85

7.9 OFIQ_LIB::modules::measures::ExpressionNeutrality Class

Reference

Provides a class implementing the expression neutrality measure.

#include <ExpressionNeutrality.h>

Inheritance diagram for OFIQ_LIB::modules::measures::ExpressionNeutrality:

OFIQ_LIB::modules::measures::Measure

OFIQ_LIB::modules::measures::ExpressionNeutrality

Public Member Functions

• ExpressionNeutrality (const Configuration &configuration)

Construct a new Expression Neutrality object.
• void Execute (OFIQ_LIB::Session &session) override
Run the computation based on the data passed by the session object.

Public Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• Measure (const Configuration &configuration, OFIQ::QualityMeasure measure)

Constructor.
• virtual ∼Measure ()=default
Destructor.
• virtual std::string GetName () const
Returns the name of the measure.
• virtual OFIQ::QualityMeasure GetQualityMeasure () const
Returns an enum encoding the measure.
• void SetQualityMeasure (OFIQ_LIB::Session &session, OFIQ::QualityMeasure measure, double rawValue,
OFIQ::QualityMeasureReturnCode code)
Inserts the result of a quality assessment in the session object.

Private Attributes

• ONNXRuntimeSegmentation m_onnxRuntimeEnvCNN1
Instance of the enet_b0_8_best_vgaf_embed2 model. Set by ExpressionNeutrality.cnn1_model_path in the configu-
ration file.
• ONNXRuntimeSegmentation m_onnxRuntimeEnvCNN2
Instance of the enet_b2_8 model. Set by ExpressionNeutrality.cnn2_model_path in the configuration file.
• std::shared_ptr< cv::ml::Boost > m_classifier
Instance of the AdaBoost classifier Set by ExpressionNeutrality.adaboost_model_path in the configuration file.

Generated by Doxygen
86 Class Documentation

Additional Inherited Members

Protected Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• void AddSigmoid (OFIQ::QualityMeasure measure, const SigmoidParameters &defaultValues)

Reads sigmoid-function based quality mapping from the configuration.
• void AddSigmoid (const std::string &key, SigmoidParameters defaultValues)
Reads sigmoid-function based quality mapping from the configuration.
• double ExecuteScalarConversion (OFIQ::QualityMeasure measure, double rawValue)
Maps a native quality score to a quality component value.
• double ExecuteScalarConversion (const std::string &key, double rawValue)
Maps a native quality score to a quality component value.

Static Protected Member Functions inherited from

OFIQ_LIB::modules::measures::Measure

• static double Sigmoid (double x, double x0, double w)

Sigmoid function.

Protected Attributes inherited from OFIQ_LIB::modules::measures::Measure

• const Configuration & configuration

Reference to the configuration with which the measure constructor has been invoked.

7.9.1 Detailed Description

Provides a class implementing the expression neutrality measure.

The algorithm uses the CNN models enet_b0_8_best_vgaf and enet_b2_8 from https://github.com/←-
HSE-asavchenko/face-emotion-recognition as feature extractors and an AdaBoost classifier imple-
mented in OpenCV. Inspired by Grimmer et al. [9], both CNN models have been modified to also output the
embeddings of the second last layer, and have been converted to ONNX.

7.9.2 Constructor & Destructor Documentation

7.9.2.1 ExpressionNeutrality()

OFIQ_LIB::modules::measures::ExpressionNeutrality::ExpressionNeutrality (
const Configuration & configuration ) [explicit]

Construct a new Expression Neutrality object.

Parameters

configuration Configuration object from which measure-related configuration is read.

Generated by Doxygen
7.9 OFIQ_LIB::modules::measures::ExpressionNeutrality Class Reference 87

7.9.3 Member Function Documentation

7.9.3.1 Execute()

void OFIQ_LIB::modules::measures::ExpressionNeutrality::Execute (
OFIQ_LIB::Session & session ) [override], [virtual]

Run the computation based on the data passed by the session object.

Parameters

session Session object

Implements OFIQ_LIB::modules::measures::Measure.

7.9.4 Member Data Documentation

7.9.4.1 m_classifier

std::shared_ptr<cv::ml::Boost> OFIQ_LIB::modules::measures::ExpressionNeutrality::m_classifier
[private]

Instance of the AdaBoost classifier Set by ExpressionNeutrality.adaboost_model_path in the configuration file.

7.9.4.2 m_onnxRuntimeEnvCNN1

ONNXRuntimeSegmentation OFIQ_LIB::modules::measures::ExpressionNeutrality::m_onnxRuntimeEnv←-
CNN1 [private]

Instance of the enet_b0_8_best_vgaf_embed2 model. Set by ExpressionNeutrality.cnn1_model_path in the config-

uration file.

7.9.4.3 m_onnxRuntimeEnvCNN2

ONNXRuntimeSegmentation OFIQ_LIB::modules::measures::ExpressionNeutrality::m_onnxRuntimeEnv←-
CNN2 [private]

Instance of the enet_b2_8 model. Set by ExpressionNeutrality.cnn2_model_path in the configuration file.

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

• ExpressionNeutrality.h

Generated by Doxygen
88 Class Documentation

7.10 OFIQ_LIB::modules::measures::EyesOpen Class Reference

Implementation of the eyes open measure.

#include <EyesOpen.h>

Inheritance diagram for OFIQ_LIB::modules::measures::EyesOpen:

OFIQ_LIB::modules::measures::Measure

OFIQ_LIB::modules::measures::EyesOpen

Public Member Functions

• EyesOpen (const Configuration &configuration)

Constructor.
• void Execute (OFIQ_LIB::Session &session) override
Assesses eyes openness.

Public Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• Measure (const Configuration &configuration, OFIQ::QualityMeasure measure)

Constructor.
• virtual ∼Measure ()=default
Destructor.
• virtual std::string GetName () const
Returns the name of the measure.
• virtual OFIQ::QualityMeasure GetQualityMeasure () const
Returns an enum encoding the measure.
• void SetQualityMeasure (OFIQ_LIB::Session &session, OFIQ::QualityMeasure measure, double rawValue,
OFIQ::QualityMeasureReturnCode code)
Inserts the result of a quality assessment in the session object.

Additional Inherited Members

Protected Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• void AddSigmoid (OFIQ::QualityMeasure measure, const SigmoidParameters &defaultValues)

Reads sigmoid-function based quality mapping from the configuration.
• void AddSigmoid (const std::string &key, SigmoidParameters defaultValues)
Reads sigmoid-function based quality mapping from the configuration.
• double ExecuteScalarConversion (OFIQ::QualityMeasure measure, double rawValue)
Maps a native quality score to a quality component value.
• double ExecuteScalarConversion (const std::string &key, double rawValue)
Maps a native quality score to a quality component value.

Generated by Doxygen
7.10 OFIQ_LIB::modules::measures::EyesOpen Class Reference 89

Static Protected Member Functions inherited from

OFIQ_LIB::modules::measures::Measure

• static double Sigmoid (double x, double x0, double w)

Sigmoid function.

Protected Attributes inherited from OFIQ_LIB::modules::measures::Measure

• const Configuration & configuration

Reference to the configuration with which the measure constructor has been invoked.

7.10.1 Detailed Description

Implementation of the eyes open measure.

Eyes openness is based on computing eyes aspect ratios of both eyes from eye landmarks.

7.10.2 Constructor & Destructor Documentation

7.10.2.1 EyesOpen()

OFIQ_LIB::modules::measures::EyesOpen::EyesOpen (
const Configuration & configuration ) [explicit]

Constructor.

Parameters

configuration Configuration object from which measure-related configuration is read.

7.10.3 Member Function Documentation

7.10.3.1 Execute()

void OFIQ_LIB::modules::measures::EyesOpen::Execute (
OFIQ_LIB::Session & session ) [override], [virtual]

Assesses eyes openness.

Eyes openness is based on computing eyes aspect ratios of both eyes from eye landmarks.

Parameters

session Session object computed by the OFIQImpl::performPreprocessing() method.

Generated by Doxygen
90 Class Documentation

See also

Session::getAlignedFaceLandmarks()

Implements OFIQ_LIB::modules::measures::Measure.

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

• EyesOpen.h

7.11 OFIQ_LIB::modules::measures::EyesVisible Class Reference

Implementation of the eyes visible measure.

#include <EyesVisible.h>

Inheritance diagram for OFIQ_LIB::modules::measures::EyesVisible:

OFIQ_LIB::modules::measures::Measure

OFIQ_LIB::modules::measures::EyesVisible

Public Member Functions

• EyesVisible (const Configuration &configuration)

Constructor.
• void Execute (OFIQ_LIB::Session &session) override
Assesses eyes visibility.

Public Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• Measure (const Configuration &configuration, OFIQ::QualityMeasure measure)

Constructor.
• virtual ∼Measure ()=default
Destructor.
• virtual std::string GetName () const
Returns the name of the measure.
• virtual OFIQ::QualityMeasure GetQualityMeasure () const
Returns an enum encoding the measure.
• void SetQualityMeasure (OFIQ_LIB::Session &session, OFIQ::QualityMeasure measure, double rawValue,
OFIQ::QualityMeasureReturnCode code)
Inserts the result of a quality assessment in the session object.

Generated by Doxygen
7.11 OFIQ_LIB::modules::measures::EyesVisible Class Reference 91

Additional Inherited Members

Protected Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• void AddSigmoid (OFIQ::QualityMeasure measure, const SigmoidParameters &defaultValues)

Reads sigmoid-function based quality mapping from the configuration.
• void AddSigmoid (const std::string &key, SigmoidParameters defaultValues)
Reads sigmoid-function based quality mapping from the configuration.
• double ExecuteScalarConversion (OFIQ::QualityMeasure measure, double rawValue)
Maps a native quality score to a quality component value.
• double ExecuteScalarConversion (const std::string &key, double rawValue)
Maps a native quality score to a quality component value.

Static Protected Member Functions inherited from

OFIQ_LIB::modules::measures::Measure

• static double Sigmoid (double x, double x0, double w)

Sigmoid function.

Protected Attributes inherited from OFIQ_LIB::modules::measures::Measure

• const Configuration & configuration

Reference to the configuration with which the measure constructor has been invoked.

7.11.1 Detailed Description

Implementation of the eyes visible measure.

Eyes visibility is assessed by measuring the coverage of the eye visibility zone with the result of face occlusion
segmentation computed during pre-processing.

7.11.2 Constructor & Destructor Documentation

7.11.2.1 EyesVisible()

OFIQ_LIB::modules::measures::EyesVisible::EyesVisible (
const Configuration & configuration ) [explicit]

Constructor.

Parameters

configuration Configuration object from which measure-related configuration is read.

Generated by Doxygen
92 Class Documentation

7.11.3 Member Function Documentation

7.11.3.1 Execute()

void OFIQ_LIB::modules::measures::EyesVisible::Execute (
OFIQ_LIB::Session & session ) [override], [virtual]

Assesses eyes visibility.

Eyes visibility is assessed by measuring the coverage of the eye visibility zone with the result of face occlusion
segmentation computed during pre-processing by FaceOcclusionSegmentation. The pre-processing results are
given by the session parameter.

Parameters

session Session object computed by the OFIQImpl::performPreprocessing() method.

Implements OFIQ_LIB::modules::measures::Measure.

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

• EyesVisible.h

7.12 OFIQ_LIB::FaceDetectorInterface Class Reference

Provides the interface class to the face detector implementations.

#include <detectors.h>

Inheritance diagram for OFIQ_LIB::FaceDetectorInterface:

OFIQ_LIB::FaceDetectorInterface

OFIQ_LIB::modules::detectors::SSDFaceDetector

Public Member Functions

• virtual ∼FaceDetectorInterface ()=default

Destroy the Face Detector Interface object.
• std::vector< OFIQ::BoundingBox > detectFaces (OFIQ_LIB::Session &session)
This function detects faces in given image.

Protected Member Functions

• virtual std::vector< OFIQ::BoundingBox > UpdateFaces (OFIQ_LIB::Session &session)=0

This method is to be called in derived classes to perform the detection of one/more faces on the given image.

Generated by Doxygen
7.12 OFIQ_LIB::FaceDetectorInterface Class Reference 93

7.12.1 Detailed Description

Provides the interface class to the face detector implementations.

This class provides the base class / interface for the integration of different implementations of a face detector.

7.12.2 Constructor & Destructor Documentation

7.12.2.1 ∼FaceDetectorInterface()

virtual OFIQ_LIB::FaceDetectorInterface::∼FaceDetectorInterface ( ) [virtual], [default]

Destroy the Face Detector Interface object.

7.12.3 Member Function Documentation

7.12.3.1 detectFaces()

std::vector< OFIQ::BoundingBox > OFIQ_LIB::FaceDetectorInterface::detectFaces (

OFIQ_LIB::Session & session )

This function detects faces in given image.

Parameters

in session Session containing relevant information for the current task.

7.12.3.2 UpdateFaces()

virtual std::vector< OFIQ::BoundingBox > OFIQ_LIB::FaceDetectorInterface::UpdateFaces (

OFIQ_LIB::Session & session ) [protected], [pure virtual]

This method is to be called in derived classes to perform the detection of one/more faces on the given image.

Parameters

session Session containing relevant information for the current task.

Returns

std::vector<OFIQ::BoundingBox>

Implemented in OFIQ_LIB::modules::detectors::SSDFaceDetector.

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

• detectors.h

Generated by Doxygen
94 Class Documentation

7.13 OFIQ::FaceImageQualityAssessment Struct Reference

Data structure storing the results of the different measurement computations.

#include <ofiq_structs.h>

Public Member Functions

• FaceImageQualityAssessment ()=default
Default contructor.
• FaceImageQualityAssessment (const QualityAssessments &qAssessments, const BoundingBox &boundingBox)
Parameterized constructor.

Public Attributes

• QualityAssessments qAssessments
Container for storing the resuls of the different measure computations.
• BoundingBox boundingBox
Face region described by bounding box.

7.13.1 Detailed Description

Data structure storing the results of the different measurement computations.

7.13.2 Constructor & Destructor Documentation

7.13.2.1 FaceImageQualityAssessment() [1/2]

OFIQ::FaceImageQualityAssessment::FaceImageQualityAssessment ( ) [default]

Default contructor.

7.13.2.2 FaceImageQualityAssessment() [2/2]

OFIQ::FaceImageQualityAssessment::FaceImageQualityAssessment (
const QualityAssessments & qAssessments,
const BoundingBox & boundingBox ) [inline]

Parameterized constructor.

Parameters
in qAssessments
in boundingBox

Generated by Doxygen
7.14 OFIQ_LIB::FaceLandmarkExtractorInterface Class Reference 95

7.13.3 Member Data Documentation

7.13.3.1 boundingBox

BoundingBox OFIQ::FaceImageQualityAssessment::boundingBox

Face region described by bounding box.

7.13.3.2 qAssessments

QualityAssessments OFIQ::FaceImageQualityAssessment::qAssessments

Container for storing the resuls of the different measure computations.

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

• ofiq_structs.h

7.14 OFIQ_LIB::FaceLandmarkExtractorInterface Class Reference

Implements the base class for the face landmark extractors.

#include <landmarks.h>

Inheritance diagram for OFIQ_LIB::FaceLandmarkExtractorInterface:

OFIQ_LIB::FaceLandmarkExtractorInterface

OFIQ_LIB::modules::landmarks::ADNetFaceLandmarkExtractor

Public Member Functions

• virtual ∼FaceLandmarkExtractorInterface ()=default

Destructor.
• OFIQ::FaceLandmarks extractLandmarks (OFIQ_LIB::Session &session)
Public method to extract landmarks from the image passed in the session object.

Protected Member Functions

• virtual OFIQ::FaceLandmarks updateLandmarks (OFIQ_LIB::Session &session)=0

Internal implementation of the derived class for extracting landmarks.

7.14.1 Detailed Description

Implements the base class for the face landmark extractors.

Generated by Doxygen
96 Class Documentation

7.14.2 Constructor & Destructor Documentation

7.14.2.1 ∼FaceLandmarkExtractorInterface()

virtual OFIQ_LIB::FaceLandmarkExtractorInterface::∼FaceLandmarkExtractorInterface ( ) [virtual],

[default]

Destructor.

7.14.3 Member Function Documentation

7.14.3.1 extractLandmarks()

OFIQ::FaceLandmarks OFIQ_LIB::FaceLandmarkExtractorInterface::extractLandmarks (
OFIQ_LIB::Session & session )

Public method to extract landmarks from the image passed in the session object.

Parameters
session Data container, including the original image and preprocessed data.

Returns

OFIQ::FaceLandmarks

7.14.3.2 updateLandmarks()

virtual OFIQ::FaceLandmarks OFIQ_LIB::FaceLandmarkExtractorInterface::updateLandmarks (

OFIQ_LIB::Session & session ) [protected], [pure virtual]

Internal implementation of the derived class for extracting landmarks.

Parameters
session Data container, including the original image and preprocessed data.

Returns

OFIQ::FaceLandmarks

Implemented in OFIQ_LIB::modules::landmarks::ADNetFaceLandmarkExtractor.

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

• landmarks.h

Generated by Doxygen
7.15 OFIQ::FaceLandmarks Struct Reference 97

7.15 OFIQ::FaceLandmarks Struct Reference

Data structure for storing facial landmarks.

#include <ofiq_structs.h>

Public Member Functions

• FaceLandmarks ()=default

Public Attributes

• LandmarkType type { LandmarkType::NotSet }

• Landmarks landmarks

7.15.1 Detailed Description

Data structure for storing facial landmarks.

7.15.2 Constructor & Destructor Documentation

7.15.2.1 FaceLandmarks()

OFIQ::FaceLandmarks::FaceLandmarks ( ) [default]

Default constructor.

7.15.3 Member Data Documentation

7.15.3.1 landmarks

Landmarks OFIQ::FaceLandmarks::landmarks

container for all detected landmarks.

7.15.3.2 type

LandmarkType OFIQ::FaceLandmarks::type { LandmarkType::NotSet }

Enum describing the type of the landmarks.

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

• ofiq_structs.h

Generated by Doxygen
98 Class Documentation

7.16 OFIQ_LIB::modules::landmarks::FaceMeasures Class Reference

Provides static functions doing computations with landmarks.

#include <FaceMeasures.h>

Public Member Functions

• FaceMeasures ()=delete
Constructor is deleted to avoid instantiations of this class.

Static Public Member Functions

• static double InterEyeDistance (const OFIQ::FaceLandmarks &faceLandmarks, double yaw)

Computes the inter-eye distance based on the specified facial landmarks and yaw angle.
• static cv::Mat GetFaceMask (const OFIQ::FaceLandmarks &faceLandmarks, const int height, const int width,
const float alpha=0)
Creates a binary image of specified dimension and masks all pixels inside or on the convex hull.
• static double GetDistance (const OFIQ::LandmarkPoint &a, const OFIQ::LandmarkPoint &b)
Convenience method for computing the Euclidean distance between two landmark points.
• static double GetDistance (const LandmarkPair &pair)
Convenience method computing the Euclidean distance between two landmark points.
• static OFIQ::LandmarkPoint GetMiddle (const OFIQ::Landmarks &landmarks)
Computes the center point of the specified landmarks.
• static OFIQ::LandmarkPoint GetMiddle (const LandmarkPair &pair)
Computes the point in between two landmark points.
• static OFIQ::LandmarkPoint GetMiddle (const std::vector< LandmarkPair > &pairs)
Computes the center of the specified landmark points.
• static double GetMaxPairDistance (const OFIQ::FaceLandmarks &landmarks, landmarks::FaceParts face←-
Part)
Returns this maximum of face pairs from landmarks corresponding to the specified face part.

7.16.1 Detailed Description

Provides static functions doing computations with landmarks.

7.16.2 Constructor & Destructor Documentation

7.16.2.1 FaceMeasures()

OFIQ_LIB::modules::landmarks::FaceMeasures::FaceMeasures ( ) [delete]

Constructor is deleted to avoid instantiations of this class.

7.16.3 Member Function Documentation

7.16.3.1 GetDistance() [1/2]

static double OFIQ_LIB::modules::landmarks::FaceMeasures::GetDistance (

const LandmarkPair & pair ) [inline], [static]

Convenience method computing the Euclidean distance between two landmark points.

Generated by Doxygen
7.16 OFIQ_LIB::modules::landmarks::FaceMeasures Class Reference 99

Parameters
pair The two landmark points stored in the member pair.Lower and pair.Upper.

Returns

Euclidean distance.

7.16.3.2 GetDistance() [2/2]

static double OFIQ_LIB::modules::landmarks::FaceMeasures::GetDistance (

const OFIQ::LandmarkPoint & a,
const OFIQ::LandmarkPoint & b ) [static]

Convenience method for computing the Euclidean distance between two landmark points.

Parameters
a First landmark point
b Second landmark point

Returns

Euclidean distance between a and b.

7.16.3.3 GetFaceMask()

static cv::Mat OFIQ_LIB::modules::landmarks::FaceMeasures::GetFaceMask (

const OFIQ::FaceLandmarks & faceLandmarks,
const int height,
const int width,
const float alpha = 0 ) [static]

Creates a binary image of specified dimension and masks all pixels inside or on the convex hull.

All pixels on or inside the convex hull of the landmarks are set to 1; all other pixels are set to 0.

Parameters

faceLandmarks Facial landmarks object

height Height of the mask image
width Width of the mask image
alpha Should be 0; different values have only be used for NIST submissions.

Returns

Mask image

Generated by Doxygen
100 Class Documentation

7.16.3.4 GetMaxPairDistance()

static double OFIQ_LIB::modules::landmarks::FaceMeasures::GetMaxPairDistance (

const OFIQ::FaceLandmarks & landmarks,
landmarks::FaceParts facePart ) [static]

Returns this maximum of face pairs from landmarks corresponding to the specified face part.

Face parts (such as mouth) consist of landmarks that have a mate. For example, the lower lip point may correspond
to the upper lip point. For such face parts, the maximal separation (e.g., useful for detecting the mouth closeness
or eyes openness) can be computed.

Parameters
landmarks Facial landmarks
facePart Face part

Returns

Maxim of face pairs

7.16.3.5 GetMiddle() [1/3]

static OFIQ::LandmarkPoint OFIQ_LIB::modules::landmarks::FaceMeasures::GetMiddle (

const LandmarkPair & pair ) [inline], [static]

Computes the point in between two landmark points.

Parameters

pair Pair of landmark points.

Returns

Point between the two landmark points.

7.16.3.6 GetMiddle() [2/3]

static OFIQ::LandmarkPoint OFIQ_LIB::modules::landmarks::FaceMeasures::GetMiddle (

const OFIQ::Landmarks & landmarks ) [static]

Computes the center point of the specified landmarks.

Parameters
landmarks Facial landmarks

Generated by Doxygen
7.16 OFIQ_LIB::modules::landmarks::FaceMeasures Class Reference 101

Returns

Center point of the landmarks.

7.16.3.7 GetMiddle() [3/3]

static OFIQ::LandmarkPoint OFIQ_LIB::modules::landmarks::FaceMeasures::GetMiddle (

const std::vector< LandmarkPair > & pairs ) [inline], [static]

Computes the center of the specified landmark points.

This is a convenience method to compute the center if the landmarks are available as a vector of landmark pairs.

Parameters

pairs List of landmark pairs.

Returns

Center of the landmark points.

7.16.3.8 InterEyeDistance()

static double OFIQ_LIB::modules::landmarks::FaceMeasures::InterEyeDistance (

const OFIQ::FaceLandmarks & faceLandmarks,
double yaw ) [static]

Computes the inter-eye distance based on the specified facial landmarks and yaw angle.

If (x0 , y0 ) and (x1 , y1 ) are the left and right eye centres, then the following inter-eye distance is computed.

1
IED = ∥(x0 , y0 ) − (x1 , y1 )∥2 ·
cos(α)
where
α = π · yaw/180
is the secant of the yaw angle.

Parameters

faceLandmarks Facial landmarks

yaw Yaw angle in degree

Returns

The inter-eye distance

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

• FaceMeasures.h

Generated by Doxygen
102 Class Documentation

7.17 OFIQ_LIB::modules::measures::FaceOcclusionPrevention Class

Reference

Implementation of the face occlusion prevention measure.

#include <FaceOcclusionPrevention.h>

Inheritance diagram for OFIQ_LIB::modules::measures::FaceOcclusionPrevention:

OFIQ_LIB::modules::measures::Measure

OFIQ_LIB::modules::measures::FaceOcclusionPrevention

Public Member Functions

• FaceOcclusionPrevention (const Configuration &configuration)

Constructor.
• void Execute (OFIQ_LIB::Session &session) override
Assesses absence of face occlusion.

Public Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• Measure (const Configuration &configuration, OFIQ::QualityMeasure measure)

Constructor.
• virtual ∼Measure ()=default
Destructor.
• virtual std::string GetName () const
Returns the name of the measure.
• virtual OFIQ::QualityMeasure GetQualityMeasure () const
Returns an enum encoding the measure.
• void SetQualityMeasure (OFIQ_LIB::Session &session, OFIQ::QualityMeasure measure, double rawValue,
OFIQ::QualityMeasureReturnCode code)
Inserts the result of a quality assessment in the session object.

Additional Inherited Members

Protected Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• void AddSigmoid (OFIQ::QualityMeasure measure, const SigmoidParameters &defaultValues)

Reads sigmoid-function based quality mapping from the configuration.
• void AddSigmoid (const std::string &key, SigmoidParameters defaultValues)
Reads sigmoid-function based quality mapping from the configuration.
• double ExecuteScalarConversion (OFIQ::QualityMeasure measure, double rawValue)
Maps a native quality score to a quality component value.
• double ExecuteScalarConversion (const std::string &key, double rawValue)
Maps a native quality score to a quality component value.

Generated by Doxygen
7.17 OFIQ_LIB::modules::measures::FaceOcclusionPrevention Class Reference 103

Static Protected Member Functions inherited from

OFIQ_LIB::modules::measures::Measure

• static double Sigmoid (double x, double x0, double w)

Sigmoid function.

Protected Attributes inherited from OFIQ_LIB::modules::measures::Measure

• const Configuration & configuration

Reference to the configuration with which the measure constructor has been invoked.

7.17.1 Detailed Description

Implementation of the face occlusion prevention measure.

Absence of face occlusion is assessed by measuring the coverage of the marked region with the result of face
occlusion segmentation computed during pre-processing.

7.17.2 Constructor & Destructor Documentation

7.17.2.1 FaceOcclusionPrevention()

OFIQ_LIB::modules::measures::FaceOcclusionPrevention::FaceOcclusionPrevention (
const Configuration & configuration ) [explicit]

Constructor.

Parameters

configuration Configuration object from which measure-related configuration is read.

7.17.3 Member Function Documentation

7.17.3.1 Execute()

void OFIQ_LIB::modules::measures::FaceOcclusionPrevention::Execute (
OFIQ_LIB::Session & session ) [override], [virtual]

Assesses absence of face occlusion.

Absence of face occlusion is assessed by measuring the coverage of the marked region with the result of face
occlusion segmentation computed during pre-processing. Pre-processing results are passed to the method with the
session parameter.

Parameters

session Session object computed by the OFIQImpl::performPreprocessing() method.

Generated by Doxygen
104 Class Documentation

See also

FaceOcclusionSegmentation

Implements OFIQ_LIB::modules::measures::Measure.

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

• FaceOcclusionPrevention.h

7.18 OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation
Class Reference

Class managing the separation of facial parts not occluded by non-facial parts from other parts.

#include <FaceOcclusionSegmentation.h>

Inheritance diagram for OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation:

OFIQ_LIB::SegmentationExtractorInterface

OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation

Public Member Functions

• FaceOcclusionSegmentation (const Configuration &config)

Constructor.
• ∼FaceOcclusionSegmentation () override=default
Destructor.

Public Member Functions inherited from OFIQ_LIB::SegmentationExtractorInterface

• virtual ∼SegmentationExtractorInterface ()=default

Standard destructor.
• OFIQ::Image & GetMask (OFIQ_LIB::Session &session, modules::segmentations::SegmentClassLabels
faceSegment)
Get a mask of the face region requested.

Protected Member Functions

• OFIQ::Image UpdateMask (OFIQ_LIB::Session &session, modules::segmentations::SegmentClassLabels

faceSegment) override
Implements face occlusion segmentation.

Generated by Doxygen
7.18 OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation Class Reference 105

Protected Member Functions inherited from OFIQ_LIB::SegmentationExtractorInterface

• std::string GetLastSessionId () const

Accesses the last session id for this interface.

Private Member Functions

• cv::Mat GetFaceOcclusionSegmentation (const cv::Mat &alignedImage)

Does the actual CNN-based occlusion-aware segmentation.

Private Attributes

• ONNXRuntimeSegmentation m_onnxRuntimeEnv
Manages CNN computations.
• std::shared_ptr< cv::Mat > m_segmentationImage
Stores the last result computed with UpdateMask().
• const std::string m_modelConfigItem = "params.measures.FaceOcclusionSegmentation.model_path"
JSON/JAXN key to access path to FaceExtraction's model file from Configuration object.
• const int m_cropLeft = 96
Cropping parameter.
• const int m_cropRight = 96
Cropping parameter.
• const int m_cropTop = 96
Cropping parameter.
• const int m_cropBottom = 96
Cropping parameter.
• const int m_scaledWidth = 224
After cropping the aligned image, the result will be scaled to a dimension of that width for being input to the CNN-based
segmentation.
• const int m_scaledHeight = 224
After cropping the aligned image, the result will be scaled to a dimension of that height for being input to the CNN-
based segmentation.

7.18.1 Detailed Description

Class managing the separation of facial parts not occluded by non-facial parts from other parts.

The implementation is based on a CNN from FaceExtraction.

7.18.2 Constructor & Destructor Documentation

7.18.2.1 FaceOcclusionSegmentation()

OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation::FaceOcclusionSegmentation (
const Configuration & config ) [explicit]

Constructor.

Generated by Doxygen
106 Class Documentation

Parameters

config Configuration object from which some segmentation-related parameters may be read.

See also

Other required configurations

7.18.2.2 ∼FaceOcclusionSegmentation()

OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation::∼FaceOcclusionSegmentation ( )
[override], [default]

Destructor.

7.18.3 Member Function Documentation

7.18.3.1 GetFaceOcclusionSegmentation()

cv::Mat OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation::GetFaceOcclusionSegmentation
(
const cv::Mat & alignedImage ) [private]

Does the actual CNN-based occlusion-aware segmentation.

Parameters

alignedImage Aligned image of dimension 616 x 616 as returned by Session::getAlignedFace().

Returns

Image where a pixel belonging to non-occluded facial parts is encoded as the byte value 1 and pixels belonging
to other parts are encoded by the byte value 0.

7.18.3.2 UpdateMask()

OFIQ::Image OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation::UpdateMask (
OFIQ_LIB::Session & session,
modules::segmentations::SegmentClassLabels faceSegment ) [override], [protected],
[virtual]

Implements face occlusion segmentation.

The function is invoked by SegmentationExtractorInterface::GetMask(). Invokes GetFaceOcclusionSegmentation()

and stores its output in the private segmentationImage member.

Generated by Doxygen
7.18 OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation Class Reference 107

Parameters

session Session object containing the original facial image and pre-processing results computed by the
OFIQImpl::performPreprocessing() method.
faceSegment Should be the value SegmentClassLabels::face.

Returns

Face occlusion segmentation mask.

Implements OFIQ_LIB::SegmentationExtractorInterface.

7.18.4 Member Data Documentation

7.18.4.1 m_cropBottom

const int OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation::m_cropBottom = 96 [private]

Cropping parameter.

7.18.4.2 m_cropLeft

const int OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation::m_cropLeft = 96 [private]

Cropping parameter.

7.18.4.3 m_cropRight

const int OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation::m_cropRight = 96 [private]

Cropping parameter.

7.18.4.4 m_cropTop

const int OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation::m_cropTop = 96 [private]

Cropping parameter.

7.18.4.5 m_modelConfigItem

const std::string OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation::m_modelConfig←-

Item = "params.measures.FaceOcclusionSegmentation.model_path" [private]

JSON/JAXN key to access path to FaceExtraction's model file from Configuration object.

Generated by Doxygen
108 Class Documentation

7.18.4.6 m_onnxRuntimeEnv

ONNXRuntimeSegmentation OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation::m_onnx←-
RuntimeEnv [private]

Manages CNN computations.

7.18.4.7 m_scaledHeight

const int OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation::m_scaledHeight = 224

[private]

After cropping the aligned image, the result will be scaled to a dimension of that height for being input to the CNN-
based segmentation.

7.18.4.8 m_scaledWidth

const int OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation::m_scaledWidth = 224

[private]

After cropping the aligned image, the result will be scaled to a dimension of that width for being input to the CNN-
based segmentation.

7.18.4.9 m_segmentationImage

std::shared_ptr<cv::Mat> OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation::m_←-
segmentationImage [private]

Stores the last result computed with UpdateMask().

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

• FaceOcclusionSegmentation.h

7.19 OFIQ_LIB::modules::segmentations::FaceParsing Class Reference

Class managing the separation of facial parts not occluded by non-facial parts from other parts.

#include <FaceParsing.h>

Inheritance diagram for OFIQ_LIB::modules::segmentations::FaceParsing:

OFIQ_LIB::SegmentationExtractorInterface

OFIQ_LIB::modules::segmentations::FaceParsing

Generated by Doxygen
7.19 OFIQ_LIB::modules::segmentations::FaceParsing Class Reference 109

Public Member Functions

• FaceParsing (const Configuration &config)
Constructor.
• ∼FaceParsing () override=default
Destructor.

Public Member Functions inherited from OFIQ_LIB::SegmentationExtractorInterface

• virtual ∼SegmentationExtractorInterface ()=default
Standard destructor.
• OFIQ::Image & GetMask (OFIQ_LIB::Session &session, modules::segmentations::SegmentClassLabels
faceSegment)
Get a mask of the face region requested.

Protected Member Functions

• OFIQ::Image UpdateMask (OFIQ_LIB::Session &session, modules::segmentations::SegmentClassLabels
faceSegment) override
Implements face parsing.

Protected Member Functions inherited from OFIQ_LIB::SegmentationExtractorInterface

• std::string GetLastSessionId () const
Accesses the last session id for this interface.

Private Member Functions

• void SetImage (OFIQ_LIB::Session &session)

Static Private Member Functions

• static cv::Mat CreateBlob (const cv::Mat &image, int i_imageSize_one_dim)
Creates the blob being input to the face parsing CNN.
• static std::shared_ptr< cv::Mat > CalculateClassIds (const cv::Mat &resultImage, int i_imageSize_one_dim)
Applies segmentation to the blob created from the input image and returns the result.

Private Attributes
• ONNXRuntimeSegmentation m_onnxRuntimeEnv
Manages CNN computations.
• std::shared_ptr< cv::Mat > m_segmentationImage
Stores the last result computed with UpdateMask().
• const std::string m_modelConfigItem = "params.measures.FaceParsing.model_path"
JSON/JAXN key to access path to BiSeNet model in ONNX format from Configuration object.
• const int m_imageSize = 400
Face parsing target dimension.
• const int m_cropLeft = 30
Cropping parameter.
• const int m_cropRight = 30
Cropping parameter.
• const int m_cropTop = 0
Cropping parameter.
• const int m_cropBottom = 60
Cropping parameter.

Generated by Doxygen
110 Class Documentation

7.19.1 Detailed Description

Class managing the separation of facial parts not occluded by non-facial parts from other parts.

Implements a BiSeNet-based face parsing. The aligned face image is cropped and then scaled to the dimension
400 x 400. All pixels of the resulting image are assigned to one of the following class.

value class
0 background
1 face skin
2 left eye brow
3 right eye brow
4 left eye
5 right eye
6 eyeglasses
7 left ear
8 right ear
9 earring
10 nose
11 mouth
12 upper lip
13 lower lip
14 neck
15 necklace
16 clothing
17 hair
18 head covering

The result of face parsing is an image (matrix) of dimension 400 x 400 where each pixel is assigned with one of the
values listed in the table from above.

7.19.2 Constructor & Destructor Documentation

7.19.2.1 FaceParsing()

OFIQ_LIB::modules::segmentations::FaceParsing::FaceParsing (
const Configuration & config ) [explicit]

Constructor.

Parameters

config Configuration object from which related parameters may be read.

See also

For configuration of face parsing, see Other required configurations

Generated by Doxygen
7.19 OFIQ_LIB::modules::segmentations::FaceParsing Class Reference 111

7.19.2.2 ∼FaceParsing()

OFIQ_LIB::modules::segmentations::FaceParsing::∼FaceParsing ( ) [override], [default]

Destructor.

7.19.3 Member Function Documentation

7.19.3.1 CalculateClassIds()

static std::shared_ptr< cv::Mat > OFIQ_LIB::modules::segmentations::FaceParsing::Calculate←-

ClassIds (
const cv::Mat & resultImage,
int i_imageSize_one_dim ) [static], [private]

Applies segmentation to the blob created from the input image and returns the result.

Is invoked by SetImage().

Parameters

resultImage Blob being created by one of the CreateBlob functions.

i_imageSize_one_dim Specifies the size of the blob being input to the face parsing CNN; should be 400,
such that a blob of dimension 400 x 400 is created.

Returns

Result of face parsing.

7.19.3.2 CreateBlob()

static cv::Mat OFIQ_LIB::modules::segmentations::FaceParsing::CreateBlob (

const cv::Mat & image,
int i_imageSize_one_dim ) [static], [private]

Creates the blob being input to the face parsing CNN.

Parameters
image Input image
i_imageSize_one_dim Specifies the size of the blob being input to the face parsing CNN; should be 400,
such that a blob of dimension 400 x 400 is created.

Returns

Blob of requested dimension.

Generated by Doxygen
112 Class Documentation

7.19.3.3 SetImage()

void OFIQ_LIB::modules::segmentations::FaceParsing::SetImage (
OFIQ_LIB::Session & session ) [private]

7.19.3.4 UpdateMask()

OFIQ::Image OFIQ_LIB::modules::segmentations::FaceParsing::UpdateMask (
OFIQ_LIB::Session & session,
modules::segmentations::SegmentClassLabels faceSegment ) [override], [protected],
[virtual]

Implements face parsing.

The function is invoked by SegmentationExtractorInterface::GetMask(). It crops the aligned face image returned by
Session::getAlignedFace() as configured by private member variables. The result is scaled to the dimension of 400
x 400 and passed to the BiSeNet CNN. The output is returned as face parsing.

Parameters

session Session object containing the original facial image and pre-processing results computed by the
OFIQImpl::performPreprocessing() method.
faceSegment Enum value encoding the requested face segment. If the value is SegmentClassLabels::face
then an image of dimension 400 x 400 is returned assigning each pixel a value between 0 and
18 as in the table of FaceParsing; otherwise a binary mask of dimension 400 x 400 is returned
with the requested face segment and morphologically extended (kernel size 3) is returned.

Returns

Face parsing image of dimension 400 x 400 where each pixel is assigned with one of the values described in
the table of the OFIQ_LIB::modules::segmentations::FaceParsing class documentation.

Implements OFIQ_LIB::SegmentationExtractorInterface.

7.19.4 Member Data Documentation

7.19.4.1 m_cropBottom

const int OFIQ_LIB::modules::segmentations::FaceParsing::m_cropBottom = 60 [private]

Cropping parameter.

7.19.4.2 m_cropLeft

const int OFIQ_LIB::modules::segmentations::FaceParsing::m_cropLeft = 30 [private]

Cropping parameter.

Generated by Doxygen
7.19 OFIQ_LIB::modules::segmentations::FaceParsing Class Reference 113

7.19.4.3 m_cropRight

const int OFIQ_LIB::modules::segmentations::FaceParsing::m_cropRight = 30 [private]

Cropping parameter.

7.19.4.4 m_cropTop

const int OFIQ_LIB::modules::segmentations::FaceParsing::m_cropTop = 0 [private]

Cropping parameter.

7.19.4.5 m_imageSize

const int OFIQ_LIB::modules::segmentations::FaceParsing::m_imageSize = 400 [private]

Face parsing target dimension.

7.19.4.6 m_modelConfigItem

const std::string OFIQ_LIB::modules::segmentations::FaceParsing::m_modelConfigItem = "params.←-

measures.FaceParsing.model_path" [private]

JSON/JAXN key to access path to BiSeNet model in ONNX format from Configuration object.

7.19.4.7 m_onnxRuntimeEnv

ONNXRuntimeSegmentation OFIQ_LIB::modules::segmentations::FaceParsing::m_onnxRuntimeEnv [private]

Manages CNN computations.

7.19.4.8 m_segmentationImage

std::shared_ptr<cv::Mat> OFIQ_LIB::modules::segmentations::FaceParsing::m_segmentationImage
[private]

Stores the last result computed with UpdateMask().

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

• FaceParsing.h

Generated by Doxygen
114 Class Documentation

7.20 OFIQ_LIB::modules::measures::HeadPose Class Reference

Implementation of head pose measures.

#include <HeadPose.h>

Inheritance diagram for OFIQ_LIB::modules::measures::HeadPose:

OFIQ_LIB::modules::measures::Measure

OFIQ_LIB::modules::measures::HeadPose

Public Member Functions

• HeadPose (const Configuration &configuration)

Constructor for HeadPose.
• void Execute (OFIQ_LIB::Session &session) override
Assesses head pose measure.

Public Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• Measure (const Configuration &configuration, OFIQ::QualityMeasure measure)

Constructor.
• virtual ∼Measure ()=default
Destructor.
• virtual std::string GetName () const
Returns the name of the measure.
• virtual OFIQ::QualityMeasure GetQualityMeasure () const
Returns an enum encoding the measure.
• void SetQualityMeasure (OFIQ_LIB::Session &session, OFIQ::QualityMeasure measure, double rawValue,
OFIQ::QualityMeasureReturnCode code)
Inserts the result of a quality assessment in the session object.

Additional Inherited Members

Protected Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• void AddSigmoid (OFIQ::QualityMeasure measure, const SigmoidParameters &defaultValues)

Reads sigmoid-function based quality mapping from the configuration.
• void AddSigmoid (const std::string &key, SigmoidParameters defaultValues)
Reads sigmoid-function based quality mapping from the configuration.
• double ExecuteScalarConversion (OFIQ::QualityMeasure measure, double rawValue)
Maps a native quality score to a quality component value.
• double ExecuteScalarConversion (const std::string &key, double rawValue)
Maps a native quality score to a quality component value.

Generated by Doxygen
7.20 OFIQ_LIB::modules::measures::HeadPose Class Reference 115

Static Protected Member Functions inherited from

OFIQ_LIB::modules::measures::Measure

• static double Sigmoid (double x, double x0, double w)

Sigmoid function.

Protected Attributes inherited from OFIQ_LIB::modules::measures::Measure

• const Configuration & configuration

Reference to the configuration with which the measure constructor has been invoked.

7.20.1 Detailed Description

Implementation of head pose measures.

Head pose measures are returned for roll, pitch and yaw face angle.

7.20.2 Constructor & Destructor Documentation

7.20.2.1 HeadPose()

OFIQ_LIB::modules::measures::HeadPose::HeadPose (
const Configuration & configuration ) [explicit]

Constructor for HeadPose.

Parameters

configuration Configuration object from which measure-related configuration is read.

7.20.3 Member Function Documentation

7.20.3.1 Execute()

void OFIQ_LIB::modules::measures::HeadPose::Execute (
OFIQ_LIB::Session & session ) [override], [virtual]

Assesses head pose measure.

Quality components are computed with the help of the cosine of the native quality scores (angles).

Parameters

session Session object computed by the OFIQImpl::performPreprocessing() method.

Implements OFIQ_LIB::modules::measures::Measure.

Generated by Doxygen
116 Class Documentation

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

• HeadPose.h

7.21 OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2 Class

Reference

Implementation of a head pose estimator.

#include <HeadPose3DDFAV2.h>

Inheritance diagram for OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2:

OFIQ_LIB::PoseEstimatorInterface

OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2

Public Member Functions

• HeadPose3DDFAV2 (const Configuration &config)

Constructor for HeadPose3DDFAV2.
• ∼HeadPose3DDFAV2 () override=default
Destructor.

Public Member Functions inherited from OFIQ_LIB::PoseEstimatorInterface

• virtual ∼PoseEstimatorInterface ()=default

Standard destructor.
• EulerAngle & estimatePose (OFIQ_LIB::Session &session)
This function estimates the three head orientation angles.

Protected Member Functions

• void updatePose (OFIQ_LIB::Session &session, EulerAngle &pose) override

Computation of the head pose.

Private Member Functions

• cv::Mat CropImage (const cv::Mat &image, const OFIQ::BoundingBox &biggestFace)

Crop face from image. Internally the passed bounding box will be transformed to a square region.

Generated by Doxygen
7.21 OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2 Class Reference 117

Private Attributes

• Ort::Env m_ortenv
ONNXRuntime environment handle.
• std::unique_ptr< Ort::Session > m_ortSession
ONNXRuntime session handle.
• int64_t m_expectedImageWidth = 0
Width of the CNN used for computation, read from the loaded model.
• int64_t m_expectedImageHeight = 0
Height of the CNN used for computation, read from the loaded model.
• int64_t m_expectedImageNumberOfChannels = 0
Expected number of channels of the input image, read from the loaded model.
• int64_t m_numberOfInputElements = 0
Number of input elements of the CNN used for computation, read from the loaded model.
• std::array< int64_t, 4 > m_inputShape
inputShape of the CNN used for computation, read from the loaded model.

Static Private Attributes

• static const std::string m_paramPoseEstimatorModel

Name of the used CNN net, passed from the configuration.

Additional Inherited Members

Public Types inherited from OFIQ_LIB::PoseEstimatorInterface

• using EulerAngle = std::array<double, 3>

7.21.1 Detailed Description

Implementation of a head pose estimator.

The estimator is is based on a CNN from https://github.com/cleardusk/3DDFA_V2.

7.21.2 Constructor & Destructor Documentation

7.21.2.1 HeadPose3DDFAV2()

OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2::HeadPose3DDFAV2 (
const Configuration & config ) [explicit]

Constructor for HeadPose3DDFAV2.

Parameters

config Configuration from where the the path to the CNN model in ONNX format to read.

Generated by Doxygen
118 Class Documentation

7.21.2.2 ∼HeadPose3DDFAV2()

OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2::∼HeadPose3DDFAV2 ( ) [override], [default]

Destructor.

7.21.3 Member Function Documentation

7.21.3.1 CropImage()

cv::Mat OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2::CropImage (
const cv::Mat & image,
const OFIQ::BoundingBox & biggestFace ) [private]

Crop face from image. Internally the passed bounding box will be transformed to a square region.

Parameters
image Input image.
biggestFace Input region to be cropped.

Returns

cv::Mat Cropped face region.

7.21.3.2 updatePose()

void OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2::updatePose (
OFIQ_LIB::Session & session,
EulerAngle & pose ) [override], [protected], [virtual]

Computation of the head pose.

Parameters

session Session object containing the original facial image and pre-processing results computed.
pose Estimated head pose.

Implements OFIQ_LIB::PoseEstimatorInterface.

7.21.4 Member Data Documentation

7.21.4.1 m_expectedImageHeight

int64_t OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2::m_expectedImageHeight = 0 [private]

Height of the CNN used for computation, read from the loaded model.

Generated by Doxygen
7.21 OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2 Class Reference 119

7.21.4.2 m_expectedImageNumberOfChannels

int64_t OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2::m_expectedImageNumberOfChannels =
0 [private]

Expected number of channels of the input image, read from the loaded model.

7.21.4.3 m_expectedImageWidth

int64_t OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2::m_expectedImageWidth = 0 [private]

Width of the CNN used for computation, read from the loaded model.

7.21.4.4 m_inputShape

std::array<int64_t, 4> OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2::m_inputShape [private]

inputShape of the CNN used for computation, read from the loaded model.

7.21.4.5 m_numberOfInputElements

int64_t OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2::m_numberOfInputElements = 0 [private]

Number of input elements of the CNN used for computation, read from the loaded model.

7.21.4.6 m_ortenv

Ort::Env OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2::m_ortenv [private]

ONNXRuntime environment handle.

7.21.4.7 m_ortSession

std::unique_ptr<Ort::Session> OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2::m_ortSession
[private]

ONNXRuntime session handle.

7.21.4.8 m_paramPoseEstimatorModel

const std::string OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2::m_paramPoseEstimator←-

Model [static], [private]

Name of the used CNN net, passed from the configuration.

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

• HeadPose3DDFAV2.h

Generated by Doxygen
120 Class Documentation

7.22 OFIQ_LIB::modules::measures::HeadSize Class Reference

Implementation of the head size measure.

#include <HeadSize.h>

Inheritance diagram for OFIQ_LIB::modules::measures::HeadSize:

OFIQ_LIB::modules::measures::Measure

OFIQ_LIB::modules::measures::HeadSize

Public Member Functions

• HeadSize (const Configuration &configuration)

Constructor.
• void Execute (OFIQ_LIB::Session &session) override
Run computation of head size measure,.

Public Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• Measure (const Configuration &configuration, OFIQ::QualityMeasure measure)

Constructor.
• virtual ∼Measure ()=default
Destructor.
• virtual std::string GetName () const
Returns the name of the measure.
• virtual OFIQ::QualityMeasure GetQualityMeasure () const
Returns an enum encoding the measure.
• void SetQualityMeasure (OFIQ_LIB::Session &session, OFIQ::QualityMeasure measure, double rawValue,
OFIQ::QualityMeasureReturnCode code)
Inserts the result of a quality assessment in the session object.

Additional Inherited Members

Protected Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• void AddSigmoid (OFIQ::QualityMeasure measure, const SigmoidParameters &defaultValues)

Reads sigmoid-function based quality mapping from the configuration.
• void AddSigmoid (const std::string &key, SigmoidParameters defaultValues)
Reads sigmoid-function based quality mapping from the configuration.
• double ExecuteScalarConversion (OFIQ::QualityMeasure measure, double rawValue)
Maps a native quality score to a quality component value.
• double ExecuteScalarConversion (const std::string &key, double rawValue)
Maps a native quality score to a quality component value.

Generated by Doxygen
7.22 OFIQ_LIB::modules::measures::HeadSize Class Reference 121

Static Protected Member Functions inherited from

OFIQ_LIB::modules::measures::Measure

• static double Sigmoid (double x, double x0, double w)

Sigmoid function.

Protected Attributes inherited from OFIQ_LIB::modules::measures::Measure

• const Configuration & configuration

Reference to the configuration with which the measure constructor has been invoked.

7.22.1 Detailed Description

Implementation of the head size measure.

Head size measure is based on the the distance T between the midpoint between the eyes and the chin and the
height of the image. Check ISO/IEC 29794-5 for more information.

7.22.2 Constructor & Destructor Documentation

7.22.2.1 HeadSize()

OFIQ_LIB::modules::measures::HeadSize::HeadSize (
const Configuration & configuration ) [explicit]

Constructor.

Parameters

configuration Configuration object from which measure-related configuration is read.

7.22.3 Member Function Documentation

7.22.3.1 Execute()

void OFIQ_LIB::modules::measures::HeadSize::Execute (
OFIQ_LIB::Session & session ) [override], [virtual]

Run computation of head size measure,.

Parameters

session Session object containing the original facial image and pre-processing results.

Implements OFIQ_LIB::modules::measures::Measure.
The documentation for this class was generated from the following file:

Generated by Doxygen
122 Class Documentation

• HeadSize.h

7.23 OFIQ_LIB::modules::measures::IlluminationUniformity Class

Reference

Implementation of the illumination uniformity measure.

#include <IlluminationUniformity.h>

Inheritance diagram for OFIQ_LIB::modules::measures::IlluminationUniformity:

OFIQ_LIB::modules::measures::Measure

OFIQ_LIB::modules::measures::IlluminationUniformity

Public Member Functions

• IlluminationUniformity (const Configuration &configuration)

Constructor.
• void Execute (OFIQ_LIB::Session &session) override
Assesses illumination uniformity.

Public Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• Measure (const Configuration &configuration, OFIQ::QualityMeasure measure)
Constructor.
• virtual ∼Measure ()=default
Destructor.
• virtual std::string GetName () const
Returns the name of the measure.
• virtual OFIQ::QualityMeasure GetQualityMeasure () const
Returns an enum encoding the measure.
• void SetQualityMeasure (OFIQ_LIB::Session &session, OFIQ::QualityMeasure measure, double rawValue,
OFIQ::QualityMeasureReturnCode code)
Inserts the result of a quality assessment in the session object.

Additional Inherited Members

Protected Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• void AddSigmoid (OFIQ::QualityMeasure measure, const SigmoidParameters &defaultValues)
Reads sigmoid-function based quality mapping from the configuration.
• void AddSigmoid (const std::string &key, SigmoidParameters defaultValues)
Reads sigmoid-function based quality mapping from the configuration.
• double ExecuteScalarConversion (OFIQ::QualityMeasure measure, double rawValue)
Maps a native quality score to a quality component value.
• double ExecuteScalarConversion (const std::string &key, double rawValue)
Maps a native quality score to a quality component value.

Generated by Doxygen
7.23 OFIQ_LIB::modules::measures::IlluminationUniformity Class Reference 123

Static Protected Member Functions inherited from

OFIQ_LIB::modules::measures::Measure

• static double Sigmoid (double x, double x0, double w)

Sigmoid function.

Protected Attributes inherited from OFIQ_LIB::modules::measures::Measure

• const Configuration & configuration

Reference to the configuration with which the measure constructor has been invoked.

7.23.1 Detailed Description

Implementation of the illumination uniformity measure.

Uniformity of the illumination is measured by summing up the minima of the histograms of the left and the right side
of the face.

7.23.2 Constructor & Destructor Documentation

7.23.2.1 IlluminationUniformity()

OFIQ_LIB::modules::measures::IlluminationUniformity::IlluminationUniformity (
const Configuration & configuration ) [explicit]

Constructor.

Parameters

configuration Configuration object from which measure-related configuration is read.

7.23.3 Member Function Documentation

7.23.3.1 Execute()

void OFIQ_LIB::modules::measures::IlluminationUniformity::Execute (
OFIQ_LIB::Session & session ) [override], [virtual]

Assesses illumination uniformity.

Uniformity of the illumination is measured by summing up the minima of the histograms of the left and the right side
of the face.

Parameters

session Session object computed by the OFIQImpl::performPreprocessing() method.

Generated by Doxygen
124 Class Documentation

Implements OFIQ_LIB::modules::measures::Measure.

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

• IlluminationUniformity.h

7.24 OFIQ::Image Struct Reference

Struct representing a single image.

#include <ofiq_structs.h>

Public Member Functions

• Image ()=default
Constructor.
• Image (uint16_t width, uint16_t height, uint8_t depth, const std::shared_ptr< uint8_t > &data)
Constructor.
• size_t size () const
This function returns the size of the image data.

Public Attributes

• uint16_t width { 0 }
• uint16_t height { 0 }
• uint8_t depth { 24 }
• std::shared_ptr< uint8_t > data

7.24.1 Detailed Description

Struct representing a single image.

7.24.2 Constructor & Destructor Documentation

7.24.2.1 Image() [1/2]

OFIQ::Image::Image ( ) [default]

Constructor.

7.24.2.2 Image() [2/2]

OFIQ::Image::Image (
uint16_t width,
uint16_t height,
uint8_t depth,
const std::shared_ptr< uint8_t > & data ) [inline]

Constructor.

Generated by Doxygen
7.24 OFIQ::Image Struct Reference 125

Parameters

width of the image.

height of the image.
depth of the image
data of the image.

7.24.3 Member Function Documentation

7.24.3.1 size()

size_t OFIQ::Image::size ( ) const [inline]

This function returns the size of the image data.

7.24.4 Member Data Documentation

7.24.4.1 data

std::shared_ptr<uint8_t> OFIQ::Image::data

Managed pointer to raster scanned data. Either RGB color or intensity. If image_depth == 24 this points to 3WH
bytes RGBRGBRGB... If image_depth == 8 this points to WH bytes IIIIIII

7.24.4.2 depth

uint8_t OFIQ::Image::depth { 24 }

Number of bits per pixel. Legal values are 8 and 24.

7.24.4.3 height

uint16_t OFIQ::Image::height { 0 }

Number of pixels vertically

7.24.4.4 width

uint16_t OFIQ::Image::width { 0 }

Number of pixels horizontally

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

• ofiq_structs.h

Generated by Doxygen
126 Class Documentation

7.25 OFIQ_LIB::modules::measures::InterEyeDistance Class Reference

Implementation of the inter-eye distance measure.

#include <InterEyeDistance.h>

Inheritance diagram for OFIQ_LIB::modules::measures::InterEyeDistance:

OFIQ_LIB::modules::measures::Measure

OFIQ_LIB::modules::measures::InterEyeDistance

Public Member Functions

• InterEyeDistance (const Configuration &configuration)

Constructor.
• void Execute (OFIQ_LIB::Session &session) override
Assesses inter-eye distance.

Public Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• Measure (const Configuration &configuration, OFIQ::QualityMeasure measure)

Constructor.
• virtual ∼Measure ()=default
Destructor.
• virtual std::string GetName () const
Returns the name of the measure.
• virtual OFIQ::QualityMeasure GetQualityMeasure () const
Returns an enum encoding the measure.
• void SetQualityMeasure (OFIQ_LIB::Session &session, OFIQ::QualityMeasure measure, double rawValue,
OFIQ::QualityMeasureReturnCode code)
Inserts the result of a quality assessment in the session object.

Additional Inherited Members

Protected Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• void AddSigmoid (OFIQ::QualityMeasure measure, const SigmoidParameters &defaultValues)

Reads sigmoid-function based quality mapping from the configuration.
• void AddSigmoid (const std::string &key, SigmoidParameters defaultValues)
Reads sigmoid-function based quality mapping from the configuration.
• double ExecuteScalarConversion (OFIQ::QualityMeasure measure, double rawValue)
Maps a native quality score to a quality component value.
• double ExecuteScalarConversion (const std::string &key, double rawValue)
Maps a native quality score to a quality component value.

Generated by Doxygen
7.25 OFIQ_LIB::modules::measures::InterEyeDistance Class Reference 127

Static Protected Member Functions inherited from

OFIQ_LIB::modules::measures::Measure

• static double Sigmoid (double x, double x0, double w)

Sigmoid function.

Protected Attributes inherited from OFIQ_LIB::modules::measures::Measure

• const Configuration & configuration

Reference to the configuration with which the measure constructor has been invoked.

7.25.1 Detailed Description

Implementation of the inter-eye distance measure.

Inter-eye distance assessment is based on computing the Euclidean length of both eyes' centres and multiplication
with the secant of the yaw angle computed during pre-processing.

7.25.2 Constructor & Destructor Documentation

7.25.2.1 InterEyeDistance()

OFIQ_LIB::modules::measures::InterEyeDistance::InterEyeDistance (
const Configuration & configuration ) [explicit]

Constructor.

Parameters

configuration Configuration object from which measure-related configuration is read.

7.25.3 Member Function Documentation

7.25.3.1 Execute()

void OFIQ_LIB::modules::measures::InterEyeDistance::Execute (
OFIQ_LIB::Session & session ) [override], [virtual]

Assesses inter-eye distance.

Inter-eye distance assessment is based on computing the Euclidean length of both eyes' centres and multiplication
with the secant of the yaw angle computed during pre-processing.

Parameters

session Session object computed by the OFIQImpl::performPreprocessing() method.

Generated by Doxygen
128 Class Documentation

Implements OFIQ_LIB::modules::measures::Measure.

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

• InterEyeDistance.h

7.26 OFIQ::Interface Class Reference

The interface to FACE QA implementation.

#include <ofiq_lib.h>

Inheritance diagram for OFIQ::Interface:

OFIQ::Interface

OFIQ_LIB::OFIQImpl

Public Member Functions

• virtual ∼Interface ()=default

Default Destructor.
• virtual OFIQ::ReturnStatus initialize (const std::string &configDir, const std::string &configFileName)=0
This function initializes the implementation under test. The implementation under test should set all parameters.
• virtual OFIQ::ReturnStatus scalarQuality (const OFIQ::Image &face, double &quality)=0
This function takes an image and outputs a quality scalar.
• virtual OFIQ::ReturnStatus vectorQuality (const OFIQ::Image &image, OFIQ::FaceImageQualityAssessment
&assessments)=0
This function takes an image and outputs quality information.
• OFIQ_EXPORT void getVersion (int &major, int &minor, int &patch) const

Static Public Member Functions

• static OFIQ_EXPORT std::shared_ptr< Interface > getImplementation ()

Factory method to return a shared pointer to the Interface object.

7.26.1 Detailed Description

The interface to FACE QA implementation.

Implement this interface by sub-classing this class and implementing each method therein.

Generated by Doxygen
7.26 OFIQ::Interface Class Reference 129

7.26.2 Constructor & Destructor Documentation

7.26.2.1 ∼Interface()

virtual OFIQ::Interface::∼Interface ( ) [virtual], [default]

Default Destructor.

7.26.3 Member Function Documentation

7.26.3.1 getImplementation()

static OFIQ_EXPORT std::shared_ptr< Interface > OFIQ::Interface::getImplementation ( ) [static]

Factory method to return a shared pointer to the Interface object.

This function is implemented by the submitted library and must return a shared pointer to the Interface object.

This function MUST be implemented.

Note

A possible implementation might be: return (std::make_shared<Implementation>());

Returns

std::shared_ptr<Interface> pointer to the implementation of the interface.

7.26.3.2 getVersion()

OFIQ_EXPORT void OFIQ::Interface::getVersion (

int & major,
int & minor,
int & patch ) const

7.26.3.3 initialize()

virtual OFIQ::ReturnStatus OFIQ::Interface::initialize (

const std::string & configDir,
const std::string & configFileName ) [pure virtual]

This function initializes the implementation under test. The implementation under test should set all parameters.

Parameters

in configDir string representation of the directory containing the configuration file specified by
configFileName
in configFileName An string value encoding the JAXN configuration file name

Generated by Doxygen
130 Class Documentation

Returns

OFIQ::ReturnStatus indicating if the initialization was successful.

Implemented in OFIQ_LIB::OFIQImpl.

7.26.3.4 scalarQuality()

virtual OFIQ::ReturnStatus OFIQ::Interface::scalarQuality (

const OFIQ::Image & face,
double & quality ) [pure virtual]

This function takes an image and outputs a quality scalar.

Parameters

in face Single face image

out quality A scalar value assessment of image quality. The legal values are [0,100] So, a low value
indicates high expected FNMR. A value of -1.0 indicates a failed attempt to calculate a
quality score or the value is unassigned.

Returns

OFIQ::ReturnStatus

Implemented in OFIQ_LIB::OFIQImpl.

7.26.3.5 vectorQuality()

virtual OFIQ::ReturnStatus OFIQ::Interface::vectorQuality (

const OFIQ::Image & image,
OFIQ::FaceImageQualityAssessment & assessments ) [pure virtual]

This function takes an image and outputs quality information.

The quality assessment should be performed on the largest detected face.

Parameters

in image Single face image

out assessments An ImageQualityAssessments structure. The implementation should populate 1) the
bounding box and 2) those items in the QualityAssessments object that the developer
chooses to implement 3) face landmarks

Returns

OFIQ::ReturnStatus

Implemented in OFIQ_LIB::OFIQImpl.

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

Generated by Doxygen
7.27 OFIQ_LIB::modules::landmarks::LandmarkPair Struct Reference 131

• ofiq_lib.h

7.27 OFIQ_LIB::modules::landmarks::LandmarkPair Struct Reference

Data container for storing pairs of landmarks.

#include <PartExtractor.h>

Public Member Functions

• LandmarkPair (OFIQ::LandmarkPoint upper, OFIQ::LandmarkPoint lower)

Parameterized constructor.

Public Attributes

• OFIQ::LandmarkPoint Upper
First Landmark.
• OFIQ::LandmarkPoint Lower
second landmark

7.27.1 Detailed Description

Data container for storing pairs of landmarks.

in some computation special landmarks are bound together via the LandmarkPair struct.

7.27.2 Constructor & Destructor Documentation

7.27.2.1 LandmarkPair()

OFIQ_LIB::modules::landmarks::LandmarkPair::LandmarkPair (
OFIQ::LandmarkPoint upper,
OFIQ::LandmarkPoint lower ) [inline]

Parameterized constructor.

Parameters

in upper LandmarkPoint of first landmark.

in lower LandmarkPoint of second landmark.

Generated by Doxygen
132 Class Documentation

7.27.3 Member Data Documentation

7.27.3.1 Lower

OFIQ::LandmarkPoint OFIQ_LIB::modules::landmarks::LandmarkPair::Lower

second landmark

7.27.3.2 Upper

OFIQ::LandmarkPoint OFIQ_LIB::modules::landmarks::LandmarkPair::Upper

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

• PartExtractor.h

7.28 OFIQ::LandmarkPoint Struct Reference

Data structure to describe the x and y coordinate of a landmark.

#include <ofiq_structs.h>

Public Member Functions

• LandmarkPoint ()=default
Default constructor.
• LandmarkPoint (int16_t i_x, int16_t i_y)
Parameterized constructor.

Public Attributes
• int16_t x { -1 }
x - coordinate
• int16_t y {-1 }
y - coordinate

7.28.1 Detailed Description

Data structure to describe the x and y coordinate of a landmark.

7.28.2 Constructor & Destructor Documentation

7.28.2.1 LandmarkPoint() [1/2]

OFIQ::LandmarkPoint::LandmarkPoint ( ) [default]

Default constructor.

7.28.2.2 LandmarkPoint() [2/2]

OFIQ::LandmarkPoint::LandmarkPoint (
int16_t i_x,
int16_t i_y ) [inline]

Parameterized constructor.

Generated by Doxygen
7.29 OFIQ_LIB::modules::measures::Luminance Class Reference 133

Parameters

i←- x - coordinate of the landmark.

_←-
x
i←- y - coordinate of the landmark.
_←-
y

7.28.3 Member Data Documentation

7.28.3.1 x

int16_t OFIQ::LandmarkPoint::x { -1 }

x - coordinate

7.28.3.2 y

int16_t OFIQ::LandmarkPoint::y {-1 }

y - coordinate

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

• ofiq_structs.h

7.29 OFIQ_LIB::modules::measures::Luminance Class Reference

Implementation of two luminance measures.

#include <Luminance.h>

Inheritance diagram for OFIQ_LIB::modules::measures::Luminance:

OFIQ_LIB::modules::measures::Measure

OFIQ_LIB::modules::measures::Luminance

Public Member Functions

• Luminance (const Configuration &configuration)

Constructor.
• void Execute (OFIQ_LIB::Session &session) override
Assesses luminance mean and luminance variance measures.

Generated by Doxygen
134 Class Documentation

Public Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• Measure (const Configuration &configuration, OFIQ::QualityMeasure measure)
Constructor.
• virtual ∼Measure ()=default
Destructor.
• virtual std::string GetName () const
Returns the name of the measure.
• virtual OFIQ::QualityMeasure GetQualityMeasure () const
Returns an enum encoding the measure.
• void SetQualityMeasure (OFIQ_LIB::Session &session, OFIQ::QualityMeasure measure, double rawValue,
OFIQ::QualityMeasureReturnCode code)
Inserts the result of a quality assessment in the session object.

Additional Inherited Members

Protected Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• void AddSigmoid (OFIQ::QualityMeasure measure, const SigmoidParameters &defaultValues)
Reads sigmoid-function based quality mapping from the configuration.
• void AddSigmoid (const std::string &key, SigmoidParameters defaultValues)
Reads sigmoid-function based quality mapping from the configuration.
• double ExecuteScalarConversion (OFIQ::QualityMeasure measure, double rawValue)
Maps a native quality score to a quality component value.
• double ExecuteScalarConversion (const std::string &key, double rawValue)
Maps a native quality score to a quality component value.

Static Protected Member Functions inherited from

OFIQ_LIB::modules::measures::Measure
• static double Sigmoid (double x, double x0, double w)
Sigmoid function.

Protected Attributes inherited from OFIQ_LIB::modules::measures::Measure

• const Configuration & configuration
Reference to the configuration with which the measure constructor has been invoked.

7.29.1 Detailed Description

Implementation of two luminance measures.

On execution, two measures will be assessed: Luminance mean and luminance variance.

7.29.2 Constructor & Destructor Documentation

7.29.2.1 Luminance()

OFIQ_LIB::modules::measures::Luminance::Luminance (
const Configuration & configuration ) [explicit]

Constructor.

Generated by Doxygen
7.30 OFIQ_LIB::modules::measures::Measure Class Reference 135

Parameters

configuration Configuration object from which measure-related configuration is read.

7.29.3 Member Function Documentation

7.29.3.1 Execute()

void OFIQ_LIB::modules::measures::Luminance::Execute (
OFIQ_LIB::Session & session ) [override], [virtual]

Assesses luminance mean and luminance variance measures.

On execution, two measures will be assessed: Luminance mean and luminance variance.

Parameters

session Session object computed by the OFIQImpl::performPreprocessing() method.

Implements OFIQ_LIB::modules::measures::Measure.

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

• Luminance.h

7.30 OFIQ_LIB::modules::measures::Measure Class Reference

Base class for measures implemented in OFIQ.

#include <Measure.h>

Inheritance diagram for OFIQ_LIB::modules::measures::Measure:

Generated by Doxygen
136 Class Documentation

OFIQ_LIB::modules::measures::Measure

OFIQ_LIB::modules::measures::BackgroundUniformity

OFIQ_LIB::modules::measures::CompressionArtifacts

OFIQ_LIB::modules::measures::CropOfTheFaceImage

OFIQ_LIB::modules::measures::DynamicRange

OFIQ_LIB::modules::measures::ExpressionNeutrality

OFIQ_LIB::modules::measures::EyesOpen

OFIQ_LIB::modules::measures::EyesVisible

OFIQ_LIB::modules::measures::FaceOcclusionPrevention

OFIQ_LIB::modules::measures::HeadPose

OFIQ_LIB::modules::measures::HeadSize

OFIQ_LIB::modules::measures::IlluminationUniformity

OFIQ_LIB::modules::measures::InterEyeDistance

OFIQ_LIB::modules::measures::Luminance

OFIQ_LIB::modules::measures::MouthClosed

OFIQ_LIB::modules::measures::MouthOcclusionPrevention

OFIQ_LIB::modules::measures::NaturalColour

OFIQ_LIB::modules::measures::NoHeadCoverings

OFIQ_LIB::modules::measures::OverExposurePrevention

OFIQ_LIB::modules::measures::Sharpness

OFIQ_LIB::modules::measures::SingleFacePresent

OFIQ_LIB::modules::measures::UnderExposurePrevention

OFIQ_LIB::modules::measures::UnifiedQualityScore

Public Member Functions

• Measure (const Configuration &configuration, OFIQ::QualityMeasure measure)
Constructor.
• virtual void Execute (OFIQ_LIB::Session &session)=0
Abstract quality assessment function.
• virtual ∼Measure ()=default
Destructor.
• virtual std::string GetName () const
Returns the name of the measure.
• virtual OFIQ::QualityMeasure GetQualityMeasure () const
Returns an enum encoding the measure.
• void SetQualityMeasure (OFIQ_LIB::Session &session, OFIQ::QualityMeasure measure, double rawValue,
OFIQ::QualityMeasureReturnCode code)
Inserts the result of a quality assessment in the session object.

Protected Member Functions

• void AddSigmoid (OFIQ::QualityMeasure measure, const SigmoidParameters &defaultValues)
Reads sigmoid-function based quality mapping from the configuration.
• void AddSigmoid (const std::string &key, SigmoidParameters defaultValues)
Reads sigmoid-function based quality mapping from the configuration.
• double ExecuteScalarConversion (OFIQ::QualityMeasure measure, double rawValue)
Maps a native quality score to a quality component value.
• double ExecuteScalarConversion (const std::string &key, double rawValue)
Maps a native quality score to a quality component value.

Generated by Doxygen
7.30 OFIQ_LIB::modules::measures::Measure Class Reference 137

Static Protected Member Functions

• static double Sigmoid (double x, double x0, double w)

Sigmoid function.

Protected Attributes

• const Configuration & configuration

Reference to the configuration with which the measure constructor has been invoked.

Static Private Member Functions

• static double ScalarConversion (double rawValue, const SigmoidParameters &par)

Applies a sigmoid-based quality mapping to a native quality score and outputs the result.
• static std::string GetMeasureName (OFIQ::QualityMeasure measure)
Returns the name of the specified measure.
• static std::string ExpandKey (std::string_view rawKey)
Expands the raw key of a measure to the key accessing its Sigmoid-based quality mapping.

Private Attributes

• std::map< std::string, SigmoidParameters, std::less<> > m_sigmoidMap

Used to map the measure name to the sigmoid-based quality mapping function.
• OFIQ::QualityMeasure m_measure = OFIQ::QualityMeasure::NotSet
Value encoding the measure type.

7.30.1 Detailed Description

Base class for measures implemented in OFIQ.

7.30.2 Constructor & Destructor Documentation

7.30.2.1 Measure()

OFIQ_LIB::modules::measures::Measure::Measure (
const Configuration & configuration,
OFIQ::QualityMeasure measure ) [inline]

Constructor.

Parameters

configuration Configuration object from which measure-related configuration is read.

session Session object containing the original facial image and pre-processing results computed by the
OFIQImpl::performPreprocessing() method
measure Enum of the measure.

Generated by Doxygen
138 Class Documentation

7.30.2.2 ∼Measure()

virtual OFIQ_LIB::modules::measures::Measure::∼Measure ( ) [virtual], [default]

Destructor.

7.30.3 Member Function Documentation

7.30.3.1 AddSigmoid() [1/2]

void OFIQ_LIB::modules::measures::Measure::AddSigmoid (
const std::string & key,
SigmoidParameters defaultValues ) [protected]

Reads sigmoid-function based quality mapping from the configuration.

The parameters are read from the configuration reference member OFIQ_LIB::modules::measures::Measure::configuration.
If a parameter is not configured, its default value is chosen from the defaultValues argument.

Parameters

key Key/name of the measure of which mapping is configured.

defaultValues Parameters from which default values of non-configured parameters are chosen.

7.30.3.2 AddSigmoid() [2/2]

void OFIQ_LIB::modules::measures::Measure::AddSigmoid (
OFIQ::QualityMeasure measure,
const SigmoidParameters & defaultValues ) [protected]

Reads sigmoid-function based quality mapping from the configuration.

The parameters are read from the configuration reference member OFIQ_LIB::modules::measures::Measure::configuration.
If a parameter is not configured, its default value is chosen from the defaultValues argument.

Parameters

measure Enum value encoding the measure for which the mapping is configured.
defaultValues Parameters from which default values of non-configured parameters are chosen.

7.30.3.3 Execute()

virtual void OFIQ_LIB::modules::measures::Measure::Execute (

OFIQ_LIB::Session & session ) [pure virtual]

Abstract quality assessment function.

After quality assessment of the implemented measure, the method should invoke SetQualityMeasure() to insert the
result of quality assessment in session.

Generated by Doxygen
7.30 OFIQ_LIB::modules::measures::Measure Class Reference 139

Parameters

session Session object containing the original facial image and pre-processing results computed by the
OFIQImpl::performPreprocessing() method.

Implemented in OFIQ_LIB::modules::measures::BackgroundUniformity, OFIQ_LIB::modules::measures::CompressionArtifacts,

OFIQ_LIB::modules::measures::CropOfTheFaceImage, OFIQ_LIB::modules::measures::DynamicRange, OFIQ_LIB::modules::measu
OFIQ_LIB::modules::measures::EyesOpen, OFIQ_LIB::modules::measures::EyesVisible, OFIQ_LIB::modules::measures::FaceOcclu
OFIQ_LIB::modules::measures::HeadPose, OFIQ_LIB::modules::measures::HeadSize, OFIQ_LIB::modules::measures::IlluminationU
OFIQ_LIB::modules::measures::InterEyeDistance, OFIQ_LIB::modules::measures::Luminance, OFIQ_LIB::modules::measures::Mout
OFIQ_LIB::modules::measures::MouthOcclusionPrevention, OFIQ_LIB::modules::measures::NaturalColour,
OFIQ_LIB::modules::measures::NoHeadCoverings, OFIQ_LIB::modules::measures::OverExposurePrevention,
OFIQ_LIB::modules::measures::Sharpness, OFIQ_LIB::modules::measures::SingleFacePresent, OFIQ_LIB::modules::measures::Un
and OFIQ_LIB::modules::measures::UnifiedQualityScore.

7.30.3.4 ExecuteScalarConversion() [1/2]

double OFIQ_LIB::modules::measures::Measure::ExecuteScalarConversion (
const std::string & key,
double rawValue ) [protected]

Maps a native quality score to a quality component value.

Parameters

key Key/name of the measure used to read parameters from a private map member.
rawValue Native quality score.

Returns

Quality component value.

7.30.3.5 ExecuteScalarConversion() [2/2]

double OFIQ_LIB::modules::measures::Measure::ExecuteScalarConversion (
OFIQ::QualityMeasure measure,
double rawValue ) [protected]

Maps a native quality score to a quality component value.

Parameters

measure Enum value of the measure used to read parameters from a private map member.
rawValue Native quality score.

Returns

Quality component value.

Generated by Doxygen
140 Class Documentation

7.30.3.6 ExpandKey()

static std::string OFIQ_LIB::modules::measures::Measure::ExpandKey (

std::string_view rawKey ) [static], [private]

Expands the raw key of a measure to the key accessing its Sigmoid-based quality mapping.

Parameters

rawKey representation of the measure (e.g., "BackgroundUniformity").

Returns

std::string representation of the key accessing the quality mapping function configuration (e.g., "params.←-
measures.BackgroundUniformity.Sigmoid").

7.30.3.7 GetMeasureName()

static std::string OFIQ_LIB::modules::measures::Measure::GetMeasureName (

OFIQ::QualityMeasure measure ) [static], [private]

Returns the name of the specified measure.

Parameters

measure Enum value of a measure.

Returns

std::string representation of the requested measure.

7.30.3.8 GetName()

virtual std::string OFIQ_LIB::modules::measures::Measure::GetName ( ) const [virtual]

Returns the name of the measure.

Unless overwritten, the member m_measure is passed to the private GetMeasureName() method and the result is
returned.

Returns

std::string representation of the measures.

7.30.3.9 GetQualityMeasure()

virtual OFIQ::QualityMeasure OFIQ_LIB::modules::measures::Measure::GetQualityMeasure ( ) const

[virtual]

Returns an enum encoding the measure.

Returns

Enum encoding the measure.

Generated by Doxygen
7.30 OFIQ_LIB::modules::measures::Measure Class Reference 141

7.30.3.10 ScalarConversion()

static double OFIQ_LIB::modules::measures::Measure::ScalarConversion (

double rawValue,
const SigmoidParameters & par ) [inline], [static], [private]

Applies a sigmoid-based quality mapping to a native quality score and outputs the result.

Before output, the result is checked if it is below 0 or above

1. If it is below 0, then 0 is returned. If it is above 100, then 100 is returned.

Parameters
rawValue Native quality score.
par Parameters of the sigmoid-based quality mapping.

Returns

The mapped quality value.

7.30.3.11 SetQualityMeasure()

void OFIQ_LIB::modules::measures::Measure::SetQualityMeasure (
OFIQ_LIB::Session & session,
OFIQ::QualityMeasure measure,
double rawValue,
OFIQ::QualityMeasureReturnCode code )

Inserts the result of a quality assessment in the session object.

The method ExecuteScalarConversion() is invoked to map the native quality score to its quality component value.

Parameters

session Session object containing the original facial image and pre-processing results computed by the
OFIQImpl::performPreprocessing() method.
measure Enum value specifying this measure.
rawValue Native quality score
code Value indicating whether the quality assessment was computed successfully or otherwise (e.g.,
failureToAssess).

7.30.3.12 Sigmoid()

static double OFIQ_LIB::modules::measures::Measure::Sigmoid (

double x,
double x0,
double w ) [inline], [static], [protected]

Sigmoid function.

Generated by Doxygen
142 Class Documentation

Parameters
x Native quality score
x0 Non-zero center point
w Divisor

Returns

(1 + exp((x0 − x)/w))−1 .

7.30.4 Member Data Documentation

7.30.4.1 configuration

const Configuration& OFIQ_LIB::modules::measures::Measure::configuration [protected]

Reference to the configuration with which the measure constructor has been invoked.

7.30.4.2 m_measure

OFIQ::QualityMeasure OFIQ_LIB::modules::measures::Measure::m_measure = OFIQ::QualityMeasure::NotSet

[private]

Value encoding the measure type.

The value is set to QualityMeasure::NotSet by default which effectively corresponds to a non-specified measure.

7.30.4.3 m_sigmoidMap

std::map<std::string, SigmoidParameters, std::less<> > OFIQ_LIB::modules::measures::Measure←-

::m_sigmoidMap [private]

Used to map the measure name to the sigmoid-based quality mapping function.

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

• Measure.h

7.31 OFIQ_LIB::modules::measures::MeasureFactory Class Reference

Measure factor class.

#include <MeasureFactory.h>

Public Member Functions

• MeasureFactory ()=delete

Generated by Doxygen
7.32 OFIQ_LIB::modules::measures::MouthClosed Class Reference 143

Static Public Member Functions

• static std::unique_ptr< Measure > CreateMeasure (const OFIQ::QualityMeasure measure, const

Configuration &configuration)
Requests the creation of a measure implementation.

7.31.1 Detailed Description

Measure factor class.

7.31.2 Constructor & Destructor Documentation

7.31.2.1 MeasureFactory()

OFIQ_LIB::modules::measures::MeasureFactory::MeasureFactory ( ) [delete]

7.31.3 Member Function Documentation

7.31.3.1 CreateMeasure()

static std::unique_ptr< Measure > OFIQ_LIB::modules::measures::MeasureFactory::CreateMeasure (

const OFIQ::QualityMeasure measure,
const Configuration & configuration ) [static]

Requests the creation of a measure implementation.

Parameters
measure Enum value encoding the requested measure.
configuration Configuration from which measure parameters are read.

Attention

The function returns nullptr if the request of a measure is not implemented by the function.
If any constructor of a requested measures throws something, the throw is forwarded to this function.

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

• MeasureFactory.h

7.32 OFIQ_LIB::modules::measures::MouthClosed Class Reference

Implementation of the mouth closed measure.

#include <MouthClosed.h>

Generated by Doxygen
144 Class Documentation

Inheritance diagram for OFIQ_LIB::modules::measures::MouthClosed:

OFIQ_LIB::modules::measures::Measure

OFIQ_LIB::modules::measures::MouthClosed

Public Member Functions

• MouthClosed (const Configuration &configuration)

Constructor.
• void Execute (OFIQ_LIB::Session &session) override
Assesses mouth closeness.

Public Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• Measure (const Configuration &configuration, OFIQ::QualityMeasure measure)

Constructor.
• virtual ∼Measure ()=default
Destructor.
• virtual std::string GetName () const
Returns the name of the measure.
• virtual OFIQ::QualityMeasure GetQualityMeasure () const
Returns an enum encoding the measure.
• void SetQualityMeasure (OFIQ_LIB::Session &session, OFIQ::QualityMeasure measure, double rawValue,
OFIQ::QualityMeasureReturnCode code)
Inserts the result of a quality assessment in the session object.

Additional Inherited Members

Protected Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• void AddSigmoid (OFIQ::QualityMeasure measure, const SigmoidParameters &defaultValues)

Reads sigmoid-function based quality mapping from the configuration.
• void AddSigmoid (const std::string &key, SigmoidParameters defaultValues)
Reads sigmoid-function based quality mapping from the configuration.
• double ExecuteScalarConversion (OFIQ::QualityMeasure measure, double rawValue)
Maps a native quality score to a quality component value.
• double ExecuteScalarConversion (const std::string &key, double rawValue)
Maps a native quality score to a quality component value.

Static Protected Member Functions inherited from

OFIQ_LIB::modules::measures::Measure

• static double Sigmoid (double x, double x0, double w)

Sigmoid function.

Generated by Doxygen
7.32 OFIQ_LIB::modules::measures::MouthClosed Class Reference 145

Protected Attributes inherited from OFIQ_LIB::modules::measures::Measure

• const Configuration & configuration

Reference to the configuration with which the measure constructor has been invoked.

7.32.1 Detailed Description

Implementation of the mouth closed measure.

Mouth closed assessment based on computing a ratio from mouth landmarks.

7.32.2 Constructor & Destructor Documentation

7.32.2.1 MouthClosed()

OFIQ_LIB::modules::measures::MouthClosed::MouthClosed (
const Configuration & configuration ) [explicit]

Constructor.

Parameters

configuration Configuration object from which measure-related configuration is read.

7.32.3 Member Function Documentation

7.32.3.1 Execute()

void OFIQ_LIB::modules::measures::MouthClosed::Execute (
OFIQ_LIB::Session & session ) [override], [virtual]

Assesses mouth closeness.

Mouth closed assessment based on computing a ratio from mouth landmarks.

Parameters

session Session object computed by the OFIQImpl::performPreprocessing() method.

See also

Session::getAlignedFaceLandmarks()

Implements OFIQ_LIB::modules::measures::Measure.

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

• MouthClosed.h

Generated by Doxygen
146 Class Documentation

7.33 OFIQ_LIB::modules::measures::MouthOcclusionPrevention Class

Reference

Implementation of the mouth occlusion prevention measure.

#include <MouthOcclusionPrevention.h>

Inheritance diagram for OFIQ_LIB::modules::measures::MouthOcclusionPrevention:

OFIQ_LIB::modules::measures::Measure

OFIQ_LIB::modules::measures::MouthOcclusionPrevention

Public Member Functions

• MouthOcclusionPrevention (const Configuration &configuration)

Constructor.
• void Execute (OFIQ_LIB::Session &session) override
Assesses absence of mouth occlusion.

Public Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• Measure (const Configuration &configuration, OFIQ::QualityMeasure measure)

Constructor.
• virtual ∼Measure ()=default
Destructor.
• virtual std::string GetName () const
Returns the name of the measure.
• virtual OFIQ::QualityMeasure GetQualityMeasure () const
Returns an enum encoding the measure.
• void SetQualityMeasure (OFIQ_LIB::Session &session, OFIQ::QualityMeasure measure, double rawValue,
OFIQ::QualityMeasureReturnCode code)
Inserts the result of a quality assessment in the session object.

Additional Inherited Members

Protected Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• void AddSigmoid (OFIQ::QualityMeasure measure, const SigmoidParameters &defaultValues)

Reads sigmoid-function based quality mapping from the configuration.
• void AddSigmoid (const std::string &key, SigmoidParameters defaultValues)
Reads sigmoid-function based quality mapping from the configuration.
• double ExecuteScalarConversion (OFIQ::QualityMeasure measure, double rawValue)
Maps a native quality score to a quality component value.
• double ExecuteScalarConversion (const std::string &key, double rawValue)
Maps a native quality score to a quality component value.

Generated by Doxygen
7.33 OFIQ_LIB::modules::measures::MouthOcclusionPrevention Class Reference 147

Static Protected Member Functions inherited from

OFIQ_LIB::modules::measures::Measure

• static double Sigmoid (double x, double x0, double w)

Sigmoid function.

Protected Attributes inherited from OFIQ_LIB::modules::measures::Measure

• const Configuration & configuration

Reference to the configuration with which the measure constructor has been invoked.

7.33.1 Detailed Description

Implementation of the mouth occlusion prevention measure.

Absence of mouth occlusion is assessed by measuring the coverage of the mouth region from mouth landmarks
with the result of face occlusion segmentation computed on pre-processing.

7.33.2 Constructor & Destructor Documentation

7.33.2.1 MouthOcclusionPrevention()

OFIQ_LIB::modules::measures::MouthOcclusionPrevention::MouthOcclusionPrevention (
const Configuration & configuration ) [explicit]

Constructor.

Parameters

configuration Configuration object from which measure-related configuration is read.

7.33.3 Member Function Documentation

7.33.3.1 Execute()

void OFIQ_LIB::modules::measures::MouthOcclusionPrevention::Execute (
OFIQ_LIB::Session & session ) [override], [virtual]

Assesses absence of mouth occlusion.

Absence of mouth occlusion is assessed by measuring the coverage of the mouth region from mouth landmarks
with the result of face occlusion segmentation computed on pre-processing. Pre-processing results are passed to
the method with the session parameter.

Parameters

session Session object computed by the OFIQImpl::performPreprocessing() method.

Generated by Doxygen
148 Class Documentation

See also

FaceOcclusionSegmentation
Session::getAlignedFaceLandmarks()

Implements OFIQ_LIB::modules::measures::Measure.

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

• MouthOcclusionPrevention.h

7.34 OFIQ_LIB::modules::measures::NaturalColour Class Reference

Implementation of the natural colour measure.

#include <NaturalColour.h>

Inheritance diagram for OFIQ_LIB::modules::measures::NaturalColour:

OFIQ_LIB::modules::measures::Measure

OFIQ_LIB::modules::measures::NaturalColour

Public Member Functions

• NaturalColour (const Configuration &configuration)

Constructor.
• void Execute (OFIQ_LIB::Session &session) override
Assesses natural colourness.

Public Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• Measure (const Configuration &configuration, OFIQ::QualityMeasure measure)

Constructor.
• virtual ∼Measure ()=default
Destructor.
• virtual std::string GetName () const
Returns the name of the measure.
• virtual OFIQ::QualityMeasure GetQualityMeasure () const
Returns an enum encoding the measure.
• void SetQualityMeasure (OFIQ_LIB::Session &session, OFIQ::QualityMeasure measure, double rawValue,
OFIQ::QualityMeasureReturnCode code)
Inserts the result of a quality assessment in the session object.

Generated by Doxygen
7.34 OFIQ_LIB::modules::measures::NaturalColour Class Reference 149

Private Member Functions

• cv::Mat CreateMaskedImage (const OFIQ::FaceLandmarks &landmarks, const cv::Mat &cvImage) const

Creates a mask image from the convex full of the specified landmarks.
• cv::Mat ReduceImageToRegionOfInterest (const cv::Mat &maskedImage, const cv::Rect &leftRegionOf←-
Interest, const cv::Rect &rightRegionOfInterest) const
Extracts two rectangular regions from an image and returns its concatenation.
• double CalculateScore (double meanChannelA, double meanChannelB) const
Combines two CIELAB values a∗ and b∗ to computed the native quality score.

Additional Inherited Members

Protected Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• void AddSigmoid (OFIQ::QualityMeasure measure, const SigmoidParameters &defaultValues)

Reads sigmoid-function based quality mapping from the configuration.
• void AddSigmoid (const std::string &key, SigmoidParameters defaultValues)
Reads sigmoid-function based quality mapping from the configuration.
• double ExecuteScalarConversion (OFIQ::QualityMeasure measure, double rawValue)
Maps a native quality score to a quality component value.
• double ExecuteScalarConversion (const std::string &key, double rawValue)
Maps a native quality score to a quality component value.

Static Protected Member Functions inherited from

OFIQ_LIB::modules::measures::Measure

• static double Sigmoid (double x, double x0, double w)

Sigmoid function.

Protected Attributes inherited from OFIQ_LIB::modules::measures::Measure

• const Configuration & configuration

Reference to the configuration with which the measure constructor has been invoked.

7.34.1 Detailed Description

Implementation of the natural colour measure.

Assessment of the naturalness of the colour based on the conversion of the RGB presentation of the image to the
CIELAB colour space.

7.34.2 Constructor & Destructor Documentation

7.34.2.1 NaturalColour()

OFIQ_LIB::modules::measures::NaturalColour::NaturalColour (
const Configuration & configuration ) [explicit]

Constructor.

Generated by Doxygen
150 Class Documentation

Parameters

configuration Configuration object from which measure-related configuration is read.

7.34.3 Member Function Documentation

7.34.3.1 CalculateScore()

double OFIQ_LIB::modules::measures::NaturalColour::CalculateScore (
double meanChannelA,
double meanChannelB ) const [private]

Combines two CIELAB values a∗ and b∗ to computed the native quality score.

If a∗ and b∗ are both larger than or equals to 0, then the following formula is applied
p
D= max(max(0, 5 − a∗ ), max(0, a∗ − 25))2 + max(max(0, 5 − b∗ ), max(b∗ − 35))2

and D is returned; otherwise, the value 100 is returned.

Parameters

meanChannelA The CIELAB value a∗ input value.

meanChannelB The CIELAB value b∗ input value.

Returns

Native quality score

7.34.3.2 CreateMaskedImage()

cv::Mat OFIQ_LIB::modules::measures::NaturalColour::CreateMaskedImage (
const OFIQ::FaceLandmarks & landmarks,
const cv::Mat & cvImage ) const [private]

Creates a mask image from the convex full of the specified landmarks.

Parameters
landmarks Facial landmarks.
cvImage The mask image returned has the same dimension as cvImage.

Returns

Mask image

Generated by Doxygen
7.35 OFIQ_LIB::NeuronalNetworkContainer Struct Reference 151

7.34.3.3 Execute()

void OFIQ_LIB::modules::measures::NaturalColour::Execute (
OFIQ_LIB::Session & session ) [override], [virtual]

Assesses natural colourness.

Assessment of the naturalness of the colour based on the conversion of the RGB presentation of the image to the
CIELAB colour space.

Parameters

session Session object computed by the OFIQImpl::performPreprocessing() method.

Implements OFIQ_LIB::modules::measures::Measure.

7.34.3.4 ReduceImageToRegionOfInterest()

cv::Mat OFIQ_LIB::modules::measures::NaturalColour::ReduceImageToRegionOfInterest (
const cv::Mat & maskedImage,
const cv::Rect & leftRegionOfInterest,
const cv::Rect & rightRegionOfInterest ) const [private]

Extracts two rectangular regions from an image and returns its concatenation.

Parameters

maskedImage The input image from which the two regions are extracted.
leftRegionOfInterest First region
rightRegionOfInterest Second region

Returns

Concatenation if the requested regions; the first columns correspond to rightRegionOfInterest and
the last columns correspond to leftRegionOfInterest.

Attention

An error occurs if the height of the two requested regions differ.

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

• NaturalColour.h

7.35 OFIQ_LIB::NeuronalNetworkContainer Struct Reference

Neural network container for OFIQ's preprocessing steps.

#include <NeuronalNetworkContainer.h>

Generated by Doxygen
152 Class Documentation

Public Member Functions

• NeuronalNetworkContainer (std::shared_ptr< FaceDetectorInterface > faceDetector, std::shared_ptr<

FaceLandmarkExtractorInterface > landmarkExtractor, std::shared_ptr< SegmentationExtractorInterface
> segmentationExtractor, std::shared_ptr< PoseEstimatorInterface > poseEstimator, std::shared_ptr<
SegmentationExtractorInterface > faceOcclusionExtractor)
Constructor.

Public Attributes

• std::shared_ptr< FaceDetectorInterface > faceDetector

Pointer to a FaceDetectorInterface .
• std::shared_ptr< FaceLandmarkExtractorInterface > landmarkExtractor
Pointer to a FaceLandmarkExtractorInterface .
• std::shared_ptr< SegmentationExtractorInterface > segmentationExtractor
Pointer to a SegmentationExtractorInterface .
• std::shared_ptr< SegmentationExtractorInterface > faceOcclusionExtractor
Pointer to a SegmentationExtractorInterface .
• std::shared_ptr< PoseEstimatorInterface > poseEstimator
Pointer to a SegmentationExtractorInterface .

7.35.1 Detailed Description

Neural network container for OFIQ's preprocessing steps.

7.35.2 Constructor & Destructor Documentation

7.35.2.1 NeuronalNetworkContainer()

OFIQ_LIB::NeuronalNetworkContainer::NeuronalNetworkContainer (
std::shared_ptr< FaceDetectorInterface > faceDetector,
std::shared_ptr< FaceLandmarkExtractorInterface > landmarkExtractor,
std::shared_ptr< SegmentationExtractorInterface > segmentationExtractor,
std::shared_ptr< PoseEstimatorInterface > poseEstimator,
std::shared_ptr< SegmentationExtractorInterface > faceOcclusionExtractor ) [inline]

Constructor.

Parameters

faceDetector Implementation of a FaceDetectorInterface

landmarkExtractor Implementation of a FaceLandmarkExtractorInterface
segmentationExtractor Implementation of a SegmentationExtractorInterface . A pointer to an object
instantiated from the FaceParsing class would be valid.
poseEstimator Implementation of a PoseEstimatorInterface
faceOcclusionExtractor Implementation of a SegmentationExtractorInterface . A pointer to an object
instantiated from the FaceOcclusionSegmentation class would be valid.

Generated by Doxygen
7.35 OFIQ_LIB::NeuronalNetworkContainer Struct Reference 153

7.35.3 Member Data Documentation

7.35.3.1 faceDetector

std::shared_ptr<FaceDetectorInterface> OFIQ_LIB::NeuronalNetworkContainer::faceDetector

Pointer to a FaceDetectorInterface .

7.35.3.2 faceOcclusionExtractor

std::shared_ptr<SegmentationExtractorInterface> OFIQ_LIB::NeuronalNetworkContainer::face←-
OcclusionExtractor

Pointer to a SegmentationExtractorInterface .

A pointer to an object instantiated from the FaceOcclusionSegmentation class would be valid.

7.35.3.3 landmarkExtractor

std::shared_ptr<FaceLandmarkExtractorInterface> OFIQ_LIB::NeuronalNetworkContainer::landmark←-
Extractor

Pointer to a FaceLandmarkExtractorInterface .

7.35.3.4 poseEstimator

std::shared_ptr<PoseEstimatorInterface> OFIQ_LIB::NeuronalNetworkContainer::poseEstimator

Pointer to a SegmentationExtractorInterface .

7.35.3.5 segmentationExtractor

std::shared_ptr<SegmentationExtractorInterface> OFIQ_LIB::NeuronalNetworkContainer::segmentation←-
Extractor

Pointer to a SegmentationExtractorInterface .

A pointer to an object instantiated from the FaceParsing class would be valid.

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

• NeuronalNetworkContainer.h

Generated by Doxygen
154 Class Documentation

7.36 OFIQ_LIB::modules::measures::NoHeadCoverings Class Reference

Implementation of the no head covering measure.

#include <NoHeadCoverings.h>

Inheritance diagram for OFIQ_LIB::modules::measures::NoHeadCoverings:

OFIQ_LIB::modules::measures::Measure

OFIQ_LIB::modules::measures::NoHeadCoverings

Public Member Functions

• NoHeadCoverings (const Configuration &configuration)

Constructor.
• void Execute (OFIQ_LIB::Session &session) override
Assesses no head covering.

Public Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• Measure (const Configuration &configuration, OFIQ::QualityMeasure measure)

Constructor.
• virtual ∼Measure ()=default
Destructor.
• virtual std::string GetName () const
Returns the name of the measure.
• virtual OFIQ::QualityMeasure GetQualityMeasure () const
Returns an enum encoding the measure.
• void SetQualityMeasure (OFIQ_LIB::Session &session, OFIQ::QualityMeasure measure, double rawValue,
OFIQ::QualityMeasureReturnCode code)
Inserts the result of a quality assessment in the session object.

Private Attributes

• double m_t0
Lower threshold.
• double m_t1
Upper threshold.
• double m_w
Standard deviation used in sigmoid function.
• double m_x0
Development point used in sigmoid function.

Generated by Doxygen
7.36 OFIQ_LIB::modules::measures::NoHeadCoverings Class Reference 155

Additional Inherited Members

Protected Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• void AddSigmoid (OFIQ::QualityMeasure measure, const SigmoidParameters &defaultValues)

Reads sigmoid-function based quality mapping from the configuration.
• void AddSigmoid (const std::string &key, SigmoidParameters defaultValues)
Reads sigmoid-function based quality mapping from the configuration.
• double ExecuteScalarConversion (OFIQ::QualityMeasure measure, double rawValue)
Maps a native quality score to a quality component value.
• double ExecuteScalarConversion (const std::string &key, double rawValue)
Maps a native quality score to a quality component value.

Static Protected Member Functions inherited from

OFIQ_LIB::modules::measures::Measure

• static double Sigmoid (double x, double x0, double w)

Sigmoid function.

Protected Attributes inherited from OFIQ_LIB::modules::measures::Measure

• const Configuration & configuration

Reference to the configuration with which the measure constructor has been invoked.

7.36.1 Detailed Description

Implementation of the no head covering measure.

The face parsing pre-processing assigns all pixels on the aligned image to one class each encoded by a value
between 0 and 19 (inclusively). The values 16 and 18 encode the class clothing and head covering, respectively.
Assessment of no head covering is done on the base of counting all pixels classified as clothing and head covering
on the upper part of the aligned facial image and dividing it by the number of all pixels in the aligned image. The
ratio is the native quality score. If it exceeds a configurable threshold, a quality the quality component value 0 is
used; otherwise, if the ratio is below (or equals) the threshold, a quality of 100 is used.

See also

FaceParsing

7.36.2 Constructor & Destructor Documentation

7.36.2.1 NoHeadCoverings()

OFIQ_LIB::modules::measures::NoHeadCoverings::NoHeadCoverings (
const Configuration & configuration ) [explicit]

Constructor.

The configuration object can optionally configure the threshold using the params.measures.NoHead←-
Coverings.threshold key which is 0.02 by default.

Generated by Doxygen
156 Class Documentation

Parameters

configuration Configuration object from which measure-related configuration is read.

7.36.3 Member Function Documentation

7.36.3.1 Execute()

void OFIQ_LIB::modules::measures::NoHeadCoverings::Execute (
OFIQ_LIB::Session & session ) [override], [virtual]

Assesses no head covering.

The face parsing pre-processing assigns all pixels on the aligned image to one class each encoded by a value
between 0 and 19 (inclusively). The values 16 and 18 encode the class clothing and head covering, respectively.
Assessment of no head covering is done on the base of counting all pixels classified as clothing and head covering
on the upper part of the aligned facial image and dividing it by the number of all pixels in the aligned image. The
ratio is the native quality score. If it exceeds a configurable threshold, a quality the quality component value 0 is
used; otherwise, if the ratio is below (or equals) the threshold, a quality of 100 is used.

Parameters

session Session object computed by the OFIQImpl::performPreprocessing() method.

See also

FaceParsing

Implements OFIQ_LIB::modules::measures::Measure.

7.36.4 Member Data Documentation

7.36.4.1 m_t0

double OFIQ_LIB::modules::measures::NoHeadCoverings::m_t0 [private]

Lower threshold.

If the native quality score (number of pixels classified as head covering divided by the number of total number of
pixels in the aligned image), is below (or equals) this threshold, then a quality of 100 (best) is used;

7.36.4.2 m_t1

double OFIQ_LIB::modules::measures::NoHeadCoverings::m_t1 [private]

Upper threshold.

If the native quality score (number of pixels classified as head covering divided by the number of total number of
pixels in the aligned image), is below (or equals) this threshold, then a quality of 0 (worst) is used;

Generated by Doxygen
7.37 OFIQ_LIB::OFIQError Class Reference 157

7.36.4.3 m_w

double OFIQ_LIB::modules::measures::NoHeadCoverings::m_w [private]

Standard deviation used in sigmoid function.

If the native quality score is between (m_t0,m_t1), then the quality component value is interpoalted using a sigmoid
function with a standard deviation specified by m_w.

7.36.4.4 m_x0

double OFIQ_LIB::modules::measures::NoHeadCoverings::m_x0 [private]

Development point used in sigmoid function.

If the native quality score is between (m_t0,m_t1), then the quality component value is interpoalted using a sigmoid
function with a develeopment point specified by m_x0.

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

• NoHeadCoverings.h

7.37 OFIQ_LIB::OFIQError Class Reference

Implementation of a custom exception.

#include <OFIQError.h>

Inheritance diagram for OFIQ_LIB::OFIQError:

std::exception

OFIQ_LIB::OFIQError

Public Member Functions

• OFIQError (OFIQ::ReturnCode returnCode, std::string_view message)

Contructor.
• const char ∗ what () const noexcept override
Getter to the message, overwriting the what method of the base class.
• OFIQ::ReturnCode whatCode () const noexcept
Getter to the ReturnCode of the QFIQError.

Generated by Doxygen
158 Class Documentation

Private Attributes

• OFIQ::ReturnCode m_returnCode
Member storing the ReturnCode.
• std::string m_message
Member, storing the message passed in the constructor.
• std::string m_extendedMessage
The extended message merges the ReturnCode and the message into one string.

7.37.1 Detailed Description

Implementation of a custom exception.

This exception is derived from the standard exception.

7.37.2 Constructor & Destructor Documentation

7.37.2.1 OFIQError()

OFIQ_LIB::OFIQError::OFIQError (
OFIQ::ReturnCode returnCode,
std::string_view message )

Contructor.

Parameters

returnCode Based on the OFIQ::ReturnCode (see OFIQ::ReturnCode).

message Message that will be attached to exception.

7.37.3 Member Function Documentation

7.37.3.1 what()

const char ∗ OFIQ_LIB::OFIQError::what ( ) const [inline], [override], [noexcept]

Getter to the message, overwriting the what method of the base class.

Returns

const char∗ Pointer to the extended message.

7.37.3.2 whatCode()

OFIQ::ReturnCode OFIQ_LIB::OFIQError::whatCode ( ) const [inline], [noexcept]

Getter to the ReturnCode of the QFIQError.

Returns

OFIQ::ReturnCode

Generated by Doxygen
7.38 OFIQ_LIB::OFIQImpl Class Reference 159

7.37.4 Member Data Documentation

7.37.4.1 m_extendedMessage

std::string OFIQ_LIB::OFIQError::m_extendedMessage [private]

The extended message merges the ReturnCode and the message into one string.

7.37.4.2 m_message

std::string OFIQ_LIB::OFIQError::m_message [private]

Member, storing the message passed in the constructor.

7.37.4.3 m_returnCode

OFIQ::ReturnCode OFIQ_LIB::OFIQError::m_returnCode [private]

Member storing the ReturnCode.

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

• OFIQError.h

7.38 OFIQ_LIB::OFIQImpl Class Reference

Implementation of the OFIQ_LIB.

#include <ofiq_lib_impl.h>

Inheritance diagram for OFIQ_LIB::OFIQImpl:

OFIQ::Interface

OFIQ_LIB::OFIQImpl

Public Member Functions

• OFIQImpl ()
Constructor.
• ∼OFIQImpl () override=default
Destructor.
• OFIQ::ReturnStatus initialize (const std::string &configDir, const std::string &configValue) override
Initialize the lib by reading the configuration file.
• OFIQ::ReturnStatus scalarQuality (const OFIQ::Image &face, double &quality) override
Compute an overall quality score for the image provided.
• OFIQ::ReturnStatus vectorQuality (const OFIQ::Image &image, OFIQ::FaceImageQualityAssessment &as-
sessments) override
Run the computation of all measures set in the configuration.

Generated by Doxygen
160 Class Documentation

Public Member Functions inherited from OFIQ::Interface

• virtual ∼Interface ()=default
Default Destructor.
• OFIQ_EXPORT void getVersion (int &major, int &minor, int &patch) const

Private Member Functions

• std::unique_ptr< OFIQ_LIB::modules::measures::Executor > CreateExecutor (Session &session)

Create a Executor object.
• void CreateNetworks ()
Create a NeuronalNetworkContainer.
• void performPreprocessing (Session &session)
Perform the preprocessing.
• void alignFaceImage (Session &session)
Perform the face alignment.

Private Attributes

• std::unique_ptr< OFIQ_LIB::modules::measures::Executor > m_executorPtr

Pointer to the executor instance, see OFIQ_LIB::modules::measures::Executor.
• OFIQ::FaceImageQualityAssessment dummyAssement
required to suit Session constructor
• OFIQ::Image dummyImage
required to suit Session constructor
• OFIQ_LIB::Session m_emptySession
required to suit Session constructor
• std::unique_ptr< Configuration > config
Pointer to the cinfiguration.
• std::unique_ptr< NeuronalNetworkContainer > networks
Pointer to the different neural network instances, used during the preprocesing.

Additional Inherited Members

Static Public Member Functions inherited from OFIQ::Interface

• static OFIQ_EXPORT std::shared_ptr< Interface > getImplementation ()
Factory method to return a shared pointer to the Interface object.

7.38.1 Detailed Description

Implementation of the OFIQ_LIB.

7.38.2 Constructor & Destructor Documentation

7.38.2.1 OFIQImpl()

OFIQ_LIB::OFIQImpl::OFIQImpl ( )

Constructor.

Generated by Doxygen
7.38 OFIQ_LIB::OFIQImpl Class Reference 161

7.38.2.2 ∼OFIQImpl()

OFIQ_LIB::OFIQImpl::∼OFIQImpl ( ) [override], [default]

Destructor.

7.38.3 Member Function Documentation

7.38.3.1 alignFaceImage()

void OFIQ_LIB::OFIQImpl::alignFaceImage (
Session & session ) [private]

Perform the face alignment.

Parameters

session Session object containing the original facial image and pre-processing results computed by the
OFIQImpl::performPreprocessing() method

7.38.3.2 CreateExecutor()

std::unique_ptr< OFIQ_LIB::modules::measures::Executor > OFIQ_LIB::OFIQImpl::CreateExecutor (

Session & session ) [private]

Create a Executor object.

Parameters

session Session object containing the original facial image and pre-processing results computed by the
OFIQImpl::performPreprocessing() method

Returns

std::unique_ptr<OFIQ_LIB::modules::measures::Executor>

7.38.3.3 CreateNetworks()

void OFIQ_LIB::OFIQImpl::CreateNetworks ( ) [private]

Create a NeuronalNetworkContainer.

7.38.3.4 initialize()

OFIQ::ReturnStatus OFIQ_LIB::OFIQImpl::initialize (
const std::string & configDir,
const std::string & configValue ) [override], [virtual]

Initialize the lib by reading the configuration file.

Generated by Doxygen
162 Class Documentation

Parameters

configDir Path to the configuration file.

configValue Name of the configuration file.

Returns

OFIQ::ReturnStatus

Implements OFIQ::Interface.

7.38.3.5 performPreprocessing()

void OFIQ_LIB::OFIQImpl::performPreprocessing (
Session & session ) [private]

Perform the preprocessing.

Parameters

session Session object containing the original facial image and pre-processing results computed by the
OFIQImpl::performPreprocessing() method

7.38.3.6 scalarQuality()

OFIQ::ReturnStatus OFIQ_LIB::OFIQImpl::scalarQuality (
const OFIQ::Image & face,
double & quality ) [override], [virtual]

Compute an overall quality score for the image provided.

The overall quality score will be equal to the measure ualityMeasure::UnifiedQualityScore if it is activated. Other-
wise, the overall quality score will be the mean of all active measure scores.

Parameters

in face Input image.

out quality Computed UnifiedQualityScore.

Returns

OFIQ::ReturnStatus

Implements OFIQ::Interface.

7.38.3.7 vectorQuality()

OFIQ::ReturnStatus OFIQ_LIB::OFIQImpl::vectorQuality (
const OFIQ::Image & image,
OFIQ::FaceImageQualityAssessment & assessments ) [override], [virtual]

Generated by Doxygen
7.38 OFIQ_LIB::OFIQImpl Class Reference 163

Run the computation of all measures set in the configuration.

Parameters
in image Input image.
out assessments Container to store the resulting scores.

Returns

OFIQ::ReturnStatus

Implements OFIQ::Interface.

7.38.4 Member Data Documentation

7.38.4.1 config

std::unique_ptr<Configuration> OFIQ_LIB::OFIQImpl::config [private]

Pointer to the cinfiguration.

7.38.4.2 dummyAssement

OFIQ::FaceImageQualityAssessment OFIQ_LIB::OFIQImpl::dummyAssement [private]

required to suit Session constructor

7.38.4.3 dummyImage

OFIQ::Image OFIQ_LIB::OFIQImpl::dummyImage [private]

required to suit Session constructor

7.38.4.4 m_emptySession

OFIQ_LIB::Session OFIQ_LIB::OFIQImpl::m_emptySession [private]

required to suit Session constructor

7.38.4.5 m_executorPtr

std::unique_ptr<OFIQ_LIB::modules::measures::Executor> OFIQ_LIB::OFIQImpl::m_executorPtr
[private]

Pointer to the executor instance, see OFIQ_LIB::modules::measures::Executor.

Generated by Doxygen
164 Class Documentation

7.38.4.6 networks

std::unique_ptr<NeuronalNetworkContainer> OFIQ_LIB::OFIQImpl::networks [private]

Pointer to the different neural network instances, used during the preprocesing.

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

• ofiq_lib_impl.h

7.39 ONNXRuntimeSegmentation Class Reference

Helper class to manage the ONNXRuntime session object.

#include <ONNXRTSegmentation.h>

Public Member Functions

• ONNXRuntimeSegmentation ()=default
Constructor.
• ∼ONNXRuntimeSegmentation ()=default
Destructor.
• void initialize (const std::vector< uint8_t > &i_modelData, int64_t i_imageWidth, int64_t i_imageHeight)
Public method to generate an ONNXRuntime session object.
• size_t getNumberOfOutputNodes ()
Get the number of output nodes (results) based on the loaded model.
• std::vector< Ort::Value > run (std::vector< float > &i_netInput)
Perform the computation.

Private Member Functions

• void init_session (const std::vector< uint8_t > &i_model_data, int64_t i_imageWidth, int64_t i_imageHeight)
Private method to generate an ONNXRuntime session object.

Private Attributes

• Ort::Env m_ortenv
Handle to the ONNXRuntime environment variable.
• Ort::MemoryInfo m_memoryInfo = Ort::MemoryInfo::CreateCpu(OrtDeviceAllocator, OrtMemTypeCPU)
ONNXRuntime variable to setup the tensors used in ONNXRuntime.
• std::array< int64_t, 4 > m_inputShape
Description of the shape of the input data expected by the model.
• std::unique_ptr< Ort::Session > m_ortSession
Handle to the ONNXRuntime session.

Generated by Doxygen
7.39 ONNXRuntimeSegmentation Class Reference 165

7.39.1 Detailed Description

Helper class to manage the ONNXRuntime session object.

Helper class to manage the ONNXRuntime session object. Details can be found on the ONNXRuntime documen-
tation https://onnxruntime.ai/docs/get-started/with-cpp.html.

7.39.2 Constructor & Destructor Documentation

7.39.2.1 ONNXRuntimeSegmentation()

ONNXRuntimeSegmentation::ONNXRuntimeSegmentation ( ) [default]

Constructor.

7.39.2.2 ∼ONNXRuntimeSegmentation()

ONNXRuntimeSegmentation::∼ONNXRuntimeSegmentation ( ) [default]

Destructor.

7.39.3 Member Function Documentation

7.39.3.1 getNumberOfOutputNodes()

size_t ONNXRuntimeSegmentation::getNumberOfOutputNodes ( )

Get the number of output nodes (results) based on the loaded model.

Returns

size_t number of output nodes (results).

7.39.3.2 init_session()

void ONNXRuntimeSegmentation::init_session (
const std::vector< uint8_t > & i_model_data,
int64_t i_imageWidth,
int64_t i_imageHeight ) [private]

Private method to generate an ONNXRuntime session object.

Parameters

i_model_data Model data loaded from file.

i_imageWidth Width of the input image as expected by the model.
i_imageHeight Height of the input image as expected by the model.

Generated by Doxygen
166 Class Documentation

7.39.3.3 initialize()

void ONNXRuntimeSegmentation::initialize (
const std::vector< uint8_t > & i_modelData,
int64_t i_imageWidth,
int64_t i_imageHeight )

Public method to generate an ONNXRuntime session object.

Parameters

i_modelData Model data loaded from file.

i_imageWidth Width of the input image as expected by the model.
i_imageHeight Height of the input image as expected by the model.

7.39.3.4 run()

std::vector< Ort::Value > ONNXRuntimeSegmentation::run (

std::vector< float > & i_netInput )

Perform the computation.

Parameters
i_netInput Input to the neural net.

Returns

std::vector<Ort::Value> Result of the neural net computation.

7.39.4 Member Data Documentation

7.39.4.1 m_inputShape

std::array<int64_t, 4> ONNXRuntimeSegmentation::m_inputShape [private]

Description of the shape of the input data expected by the model.

7.39.4.2 m_memoryInfo

Ort::MemoryInfo ONNXRuntimeSegmentation::m_memoryInfo = Ort::MemoryInfo::CreateCpu(OrtDevice←-

Allocator, OrtMemTypeCPU) [private]

ONNXRuntime variable to setup the tensors used in ONNXRuntime.

7.39.4.3 m_ortenv

Ort::Env ONNXRuntimeSegmentation::m_ortenv [private]

Handle to the ONNXRuntime environment variable.

Generated by Doxygen
7.40 OFIQ_LIB::modules::measures::OverExposurePrevention Class Reference 167

7.39.4.4 m_ortSession

std::unique_ptr<Ort::Session> ONNXRuntimeSegmentation::m_ortSession [private]

Handle to the ONNXRuntime session.

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

• ONNXRTSegmentation.h

7.40 OFIQ_LIB::modules::measures::OverExposurePrevention Class

Reference

Implementation of the over-exposure prevention measure.

#include <OverExposurePrevention.h>

Inheritance diagram for OFIQ_LIB::modules::measures::OverExposurePrevention:

OFIQ_LIB::modules::measures::Measure

OFIQ_LIB::modules::measures::OverExposurePrevention

Public Member Functions

• OverExposurePrevention (const Configuration &configuration)

Constructor a new Over Exposure Prevention.
• void Execute (OFIQ_LIB::Session &session) override
Run the computation of the over-exposure prevention measure.

Public Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• Measure (const Configuration &configuration, OFIQ::QualityMeasure measure)

Constructor.
• virtual ∼Measure ()=default
Destructor.
• virtual std::string GetName () const
Returns the name of the measure.
• virtual OFIQ::QualityMeasure GetQualityMeasure () const
Returns an enum encoding the measure.
• void SetQualityMeasure (OFIQ_LIB::Session &session, OFIQ::QualityMeasure measure, double rawValue,
OFIQ::QualityMeasureReturnCode code)
Inserts the result of a quality assessment in the session object.

Generated by Doxygen
168 Class Documentation

Additional Inherited Members

Protected Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• void AddSigmoid (OFIQ::QualityMeasure measure, const SigmoidParameters &defaultValues)

Reads sigmoid-function based quality mapping from the configuration.
• void AddSigmoid (const std::string &key, SigmoidParameters defaultValues)
Reads sigmoid-function based quality mapping from the configuration.
• double ExecuteScalarConversion (OFIQ::QualityMeasure measure, double rawValue)
Maps a native quality score to a quality component value.
• double ExecuteScalarConversion (const std::string &key, double rawValue)
Maps a native quality score to a quality component value.

Static Protected Member Functions inherited from

OFIQ_LIB::modules::measures::Measure

• static double Sigmoid (double x, double x0, double w)

Sigmoid function.

Protected Attributes inherited from OFIQ_LIB::modules::measures::Measure

• const Configuration & configuration

Reference to the configuration with which the measure constructor has been invoked.

7.40.1 Detailed Description

Implementation of the over-exposure prevention measure.

The representation of a face is considered is light if it has a high proportion of pixels that have a high luminance
value i.e. hot spots

7.40.2 Constructor & Destructor Documentation

7.40.2.1 OverExposurePrevention()

OFIQ_LIB::modules::measures::OverExposurePrevention::OverExposurePrevention (
const Configuration & configuration ) [explicit]

Constructor a new Over Exposure Prevention.

Parameters

configuration Configuration object from which measure-related configuration is read.

Generated by Doxygen
7.41 OFIQ_LIB::modules::landmarks::PartExtractor Class Reference 169

7.40.3 Member Function Documentation

7.40.3.1 Execute()

void OFIQ_LIB::modules::measures::OverExposurePrevention::Execute (
OFIQ_LIB::Session & session ) [override], [virtual]

Run the computation of the over-exposure prevention measure.

Parameters

session Session object computed by the OFIQImpl::performPreprocessing() method.

Implements OFIQ_LIB::modules::measures::Measure.

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

• OverExposurePrevention.h

7.41 OFIQ_LIB::modules::landmarks::PartExtractor Class Reference

Class that provides helper methods for the administration of landmarks.

#include <PartExtractor.h>

Static Public Member Functions

• static OFIQ::Landmarks getFacePart (const OFIQ::FaceLandmarks &faceLandmarks, FaceParts part)

Extract the landmarks that correspondend to the requested face part out of a set of provided landmarks.
• static std::vector< LandmarkPair > getPairsForPart (const OFIQ::FaceLandmarks &faceLandmarks,
FaceParts part)
Get LandmarkPairs for a face part.

7.41.1 Detailed Description

Class that provides helper methods for the administration of landmarks.

7.41.2 Member Function Documentation

7.41.2.1 getFacePart()

static OFIQ::Landmarks OFIQ_LIB::modules::landmarks::PartExtractor::getFacePart (

const OFIQ::FaceLandmarks & faceLandmarks,
FaceParts part ) [static]

Extract the landmarks that correspondend to the requested face part out of a set of provided landmarks.

Generated by Doxygen
170 Class Documentation

Parameters

in faceLandmarks Landmarks to be filtered.

part Face part of interest.

Returns

OFIQ::Landmarks Filtered landmarks that belong to the requested face part.

7.41.2.2 getPairsForPart()

static std::vector< LandmarkPair > OFIQ_LIB::modules::landmarks::PartExtractor::getPairsFor←-

Part (
const OFIQ::FaceLandmarks & faceLandmarks,
FaceParts part ) [static]

Get LandmarkPairs for a face part.

LandmarkPairs might be used to compute a distance between upper and lower landmark.

Parameters

faceLandmarks Set of face landmarks.

part Face part of interest.

Returns

std::vector<LandmarkPair>

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

• PartExtractor.h

7.42 Point2f Struct Reference

Representation of a point with floating point arithmetics.

#include <utils.h>

Public Attributes

• float x
• float y

7.42.1 Detailed Description

Representation of a point with floating point arithmetics.

Generated by Doxygen
7.43 OFIQ_LIB::Point2i Struct Reference 171

7.42.2 Member Data Documentation

7.42.2.1 x

float Point2f::x

7.42.2.2 y

float Point2f::y

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

• utils.h

7.43 OFIQ_LIB::Point2i Struct Reference

Representation of a point with integer arithmetics.

#include <utils.h>

Public Attributes

• int x
• int y

7.43.1 Detailed Description

Representation of a point with integer arithmetics.

7.43.2 Member Data Documentation

7.43.2.1 x

int OFIQ_LIB::Point2i::x

7.43.2.2 y

int OFIQ_LIB::Point2i::y

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

• utils.h

Generated by Doxygen
172 Class Documentation

7.44 OFIQ_LIB::PoseEstimatorInterface Class Reference

Implementation of the base class for integrating pose estimation algorithms capable of estimating three head orien-
tation angles (yaw, pitch and roll) from a face image.

#include <poseEstimators.h>

Inheritance diagram for OFIQ_LIB::PoseEstimatorInterface:

OFIQ_LIB::PoseEstimatorInterface

OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2

Public Types

• using EulerAngle = std::array<double, 3>

Public Member Functions

• virtual ∼PoseEstimatorInterface ()=default

Standard destructor.
• EulerAngle & estimatePose (OFIQ_LIB::Session &session)
This function estimates the three head orientation angles.

Protected Member Functions

• virtual void updatePose (OFIQ_LIB::Session &session, EulerAngle &pose)=0

Call to estimate the head orientations. Has to be implemented in the derived class.

Private Attributes

• std::string m_lastSessionId
id of the session that has been used in the latest request, for internal use.
• EulerAngle m_pose
Container for storing the estimated head orientations.

7.44.1 Detailed Description

Implementation of the base class for integrating pose estimation algorithms capable of estimating three head orien-
tation angles (yaw, pitch and roll) from a face image.

7.44.2 Member Typedef Documentation

7.44.2.1 EulerAngle

using OFIQ_LIB::PoseEstimatorInterface::EulerAngle = std::array<double, 3>

The first entry encodes yaw, the second encodes pitch, and the third encodes roll.

Generated by Doxygen
7.44 OFIQ_LIB::PoseEstimatorInterface Class Reference 173

7.44.3 Constructor & Destructor Documentation

7.44.3.1 ∼PoseEstimatorInterface()

virtual OFIQ_LIB::PoseEstimatorInterface::∼PoseEstimatorInterface ( ) [virtual], [default]

Standard destructor.

7.44.4 Member Function Documentation

7.44.4.1 estimatePose()

EulerAngle & OFIQ_LIB::PoseEstimatorInterface::estimatePose (

OFIQ_LIB::Session & session )

This function estimates the three head orientation angles.

Parameters

session Session object containing the original facial image and pre-processing results computed by the
OFIQImpl::performPreprocessing() method

7.44.4.2 updatePose()

virtual void OFIQ_LIB::PoseEstimatorInterface::updatePose (

OFIQ_LIB::Session & session,
EulerAngle & pose ) [protected], [pure virtual]

Call to estimate the head orientations. Has to be implemented in the derived class.

Parameters

session Containing the input image for the estimation.

pose Return the estimated pose.

Implemented in OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2.

7.44.5 Member Data Documentation

7.44.5.1 m_lastSessionId

std::string OFIQ_LIB::PoseEstimatorInterface::m_lastSessionId [private]

id of the session that has been used in the latest request, for internal use.

Generated by Doxygen
174 Class Documentation

7.44.5.2 m_pose

EulerAngle OFIQ_LIB::PoseEstimatorInterface::m_pose [private]

Container for storing the estimated head orientations.

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

• poseEstimators.h

7.45 OFIQ::QualityMeasureResult Struct Reference

Data structure to handle the results of a quality measure.

#include <ofiq_structs.h>

Public Member Functions

• QualityMeasureResult ()=default
Default constructor.
• QualityMeasureResult (double rawScore, double scalar=-1, QualityMeasureReturnCode code=QualityMeasureReturnCode::No
Parameterized constructor.

Public Attributes

• double rawScore { -1 }
Raw value as computed by the quality measure implementation.
• double scalar { -1 }
A scalar value from the interval [0,100] Higher values mean higher quality. A value of -1.0 indicates a failed attempt
to calculate a quality score or the value is unassigned.
• QualityMeasureReturnCode code { QualityMeasureReturnCode::NotInitialized }
Return status code.

7.45.1 Detailed Description

Data structure to handle the results of a quality measure.

7.45.2 Constructor & Destructor Documentation

7.45.2.1 QualityMeasureResult() [1/2]

OFIQ::QualityMeasureResult::QualityMeasureResult ( ) [default]

Default constructor.

7.45.2.2 QualityMeasureResult() [2/2]

OFIQ::QualityMeasureResult::QualityMeasureResult (
double rawScore,
double scalar = -1,
QualityMeasureReturnCode code = QualityMeasureReturnCode::NotInitialized ) [inline]

Parameterized constructor.

Generated by Doxygen
7.46 OFIQ::ReturnStatus Struct Reference 175

Parameters

in rawScore Computed raw score.

in scalar Computed scalar score.
in code QualityMeasureReturnCode describing the state of the computation.

7.45.3 Member Data Documentation

7.45.3.1 code

QualityMeasureReturnCode OFIQ::QualityMeasureResult::code { QualityMeasureReturnCode::NotInitialized

}

Return status code.

7.45.3.2 rawScore

double OFIQ::QualityMeasureResult::rawScore { -1 }

Raw value as computed by the quality measure implementation.

7.45.3.3 scalar

double OFIQ::QualityMeasureResult::scalar { -1 }

A scalar value from the interval [0,100] Higher values mean higher quality. A value of -1.0 indicates a failed attempt
to calculate a quality score or the value is unassigned.

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

• ofiq_structs.h

7.46 OFIQ::ReturnStatus Struct Reference

A structure to contain information about a failure by the software under test.

#include <ofiq_structs.h>

Public Member Functions

• ReturnStatus ()=default
Default constructor.
• ReturnStatus (const ReturnCode code, const std::string &info="")
Parameterized constructor.

Generated by Doxygen
176 Class Documentation

Public Attributes

• ReturnCode code { ReturnCode::UnknownError }

Return status code.
• std::string info
Optional information string.

7.46.1 Detailed Description

A structure to contain information about a failure by the software under test.

An object of this class allows the software to return some information from a function call. The string within this
object can be optionally set to provide more information for debugging etc. The status code will be set by the
function to Success on success, or one of the other codes on failure.

7.46.2 Constructor & Destructor Documentation

7.46.2.1 ReturnStatus() [1/2]

OFIQ::ReturnStatus::ReturnStatus ( ) [default]

Default constructor.

7.46.2.2 ReturnStatus() [2/2]

OFIQ::ReturnStatus::ReturnStatus (
const ReturnCode code,
const std::string & info = "" ) [inline]

Parameterized constructor.

Parameters
in code The return status code; required.
in info The optional information string.

7.46.3 Member Data Documentation

7.46.3.1 code

ReturnCode OFIQ::ReturnStatus::code { ReturnCode::UnknownError }

Return status code.

Generated by Doxygen
7.47 OFIQ_LIB::SegmentationExtractorInterface Class Reference 177

7.46.3.2 info

std::string OFIQ::ReturnStatus::info

Optional information string.

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

• ofiq_structs.h

7.47 OFIQ_LIB::SegmentationExtractorInterface Class Reference

Base class for the different implementation of segmentation algorithms.

#include <segmentations.h>

Inheritance diagram for OFIQ_LIB::SegmentationExtractorInterface:

OFIQ_LIB::SegmentationExtractorInterface

OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation OFIQ_LIB::modules::segmentations::FaceParsing

Public Member Functions

• virtual ∼SegmentationExtractorInterface ()=default

Standard destructor.
• OFIQ::Image & GetMask (OFIQ_LIB::Session &session, modules::segmentations::SegmentClassLabels
faceSegment)
Get a mask of the face region requested.

Protected Member Functions

• virtual OFIQ::Image UpdateMask (OFIQ_LIB::Session &session, modules::segmentations::SegmentClassLabels

faceSegment)=0
Segmentation call that has to be implemented in the derived class.
• std::string GetLastSessionId () const
Accesses the last session id for this interface.

Private Attributes

• std::string m_lastSessionId
id of the session that has been used in the latest request, for internal use.
• std::map< modules::segmentations::SegmentClassLabels, OFIQ::Image > m_masks
Container for storing the segmented face region masks.

Generated by Doxygen
178 Class Documentation

7.47.1 Detailed Description

Base class for the different implementation of segmentation algorithms.

Base class for the FaceParsing (see OFIQ_LIB::modules::segmentations::FaceParsing) and FaceOcclusion←-

Segmentation (see OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation)

7.47.2 Constructor & Destructor Documentation

7.47.2.1 ∼SegmentationExtractorInterface()

virtual OFIQ_LIB::SegmentationExtractorInterface::∼SegmentationExtractorInterface ( ) [virtual],

[default]

Standard destructor.

7.47.3 Member Function Documentation

7.47.3.1 GetLastSessionId()

std::string OFIQ_LIB::SegmentationExtractorInterface::GetLastSessionId ( ) const [inline],

[protected]

Accesses the last session id for this interface.

Returns

Session id

7.47.3.2 GetMask()

OFIQ::Image & OFIQ_LIB::SegmentationExtractorInterface::GetMask (

OFIQ_LIB::Session & session,
modules::segmentations::SegmentClassLabels faceSegment )

Get a mask of the face region requested.

Parameters

session Object containing the relevant data information on the input image.
faceSegment Enum of the face region that is requested.

Returns

OFIQ::Image& Refernce on the mask of the face region image.

Generated by Doxygen
7.48 OFIQ_LIB::Session Class Reference 179

7.47.3.3 UpdateMask()

virtual OFIQ::Image OFIQ_LIB::SegmentationExtractorInterface::UpdateMask (

OFIQ_LIB::Session & session,
modules::segmentations::SegmentClassLabels faceSegment ) [protected], [pure virtual]

Segmentation call that has to be implemented in the derived class.

Parameters

session Object containing the relevant data information on the input image.
faceSegment Enum of the face region that is requested

Returns

OFIQ::Image Segmented face region mask.

Implemented in OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation, and OFIQ_LIB::modules::segmentations::FacePar

7.47.4 Member Data Documentation

7.47.4.1 m_lastSessionId

std::string OFIQ_LIB::SegmentationExtractorInterface::m_lastSessionId [private]

id of the session that has been used in the latest request, for internal use.

7.47.4.2 m_masks

std::map<modules::segmentations::SegmentClassLabels, OFIQ::Image> OFIQ_LIB::Segmentation←-

ExtractorInterface::m_masks [private]

Container for storing the segmented face region masks.

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

• segmentations.h

7.48 OFIQ_LIB::Session Class Reference

#include <Session.h>

Generated by Doxygen
180 Class Documentation

Public Member Functions

• Session (const OFIQ::Image &image, OFIQ::FaceImageQualityAssessment &assessment)

Construct a new Session object.
• const OFIQ::Image & image () const
Acess reference to the input image, connected to this session.
• OFIQ::FaceImageQualityAssessment & assessment ()
Access reference to the FaceImageQualityAssessment object, connected to this session.
• const std::string & Id () const
Access to the id connected to this session.
• void setDetectedFaces (const std::vector< OFIQ::BoundingBox > &i_boundingBoxes)
Set the Detected Faces.
• std::vector< OFIQ::BoundingBox > getDetectedFaces () const
Get the Detected Faces.
• void setPose (const EulerAngle &i_pose)
Set the Pose of the input image.
• EulerAngle getPose () const
Get the Pose of the input image.
• void setLandmarks (const OFIQ::FaceLandmarks &i_landmarks)
Set the Landmarks detected on the input image.
• OFIQ::FaceLandmarks getLandmarks () const
Get the Landmarks detected on the input image.
• void setAlignedFaceLandmarks (const OFIQ::FaceLandmarks &i_landmarks)
Set the Aligned Face Landmarks detected on the aligned image.
• OFIQ::FaceLandmarks getAlignedFaceLandmarks () const
Get the Aligned Face Landmarks detected on the aligned image.
• void setAlignedFaceTransformationMatrix (const cv::Mat &i_transformationMatrix)
Set the Aligned Face Transformation Matrix.
• cv::Mat getAlignedFaceTransformationMatrix () const
Get the Aligned Face Transformation Matrix.
• void setAlignedFace (const cv::Mat &i_alignedFace)
Set the Aligned Face.
• cv::Mat getAlignedFace () const
Get the Aligned Face object.
• void setAlignedFaceLandmarkedRegion (const cv::Mat &i_alignedFaceRegion)
Set the Aligned Face Landmarked Region.
• cv::Mat getAlignedFaceLandmarkedRegion () const
Get the Aligned Face Landmarked Region.
• void setFaceParsingImage (const cv::Mat &i_parsingImage)
Set the Face Parsing Image, see OFIQ_LIB::modules::segmentations::FaceParsing).
• cv::Mat getFaceParsingImage () const
Get the Face Parsing Image, see OFIQ_LIB::modules::segmentations::FaceParsing).
• void setFaceOcclusionSegmentationImage (const cv::Mat &i_segmentationImage)
Set the Face Occlusion Segmentation Image, see OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation)
• cv::Mat getFaceOcclusionSegmentationImage () const
Get the Face Occlusion Segmentation Image, see OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation)

Private Member Functions

• std::string GenerateId () const

Method for generating uuid's for the session.

Generated by Doxygen
7.48 OFIQ_LIB::Session Class Reference 181

Private Attributes

• const OFIQ::Image & m_image

Reference to the input image, connected to this session.
• OFIQ::FaceImageQualityAssessment & m_assessment
Refernce to the FaceImageQualityAssessment object, connected to this session.
• std::vector< OFIQ::BoundingBox > m_detectedFaces
Container for the faces found on the input image.
• EulerAngle m_pose
Container for storing the pose information.
• OFIQ::FaceLandmarks m_landmarks
Container for storing the landmark information.
• OFIQ::FaceLandmarks m_alignedFaceLandmarks
Container for storing the landmark information of the aligned image.
• cv::Mat m_alignedFaceTransformationMatrix
Container for storing the transformation matrix that led to the aligned image.
• cv::Mat m_alignedFace
Container for storing the aligned image.
• cv::Mat m_alignedFacelandmarkedRegion
Container for storing the landmarks of the aligned face image.
• cv::Mat m_faceParsingImage
Container for storing the segmented face image.
• cv::Mat m_faceOcclusionSegmentationImage
Container for storing the result of the face occlusion segmented image.
• std::string m_id
Container for storing the id of the session.

7.48.1 Detailed Description

@brief The session class is the data container used to distribute the image and additional data,

including the data computed during the pre-processing.

One instance of this class contains the relevant face information used for the computation of the activated measures.
Most information is acquired during the pre-processing where the detection of the facial landmarks, the aligned
image, etc. is computed.

7.48.2 Constructor & Destructor Documentation

7.48.2.1 Session()

OFIQ_LIB::Session::Session (
const OFIQ::Image & image,
OFIQ::FaceImageQualityAssessment & assessment ) [inline]

Construct a new Session object.

Generated by Doxygen
182 Class Documentation

Parameters
image Input image that shall be analysed.
assessment Container to staore the computed measures.

7.48.3 Member Function Documentation

7.48.3.1 assessment()

OFIQ::FaceImageQualityAssessment & OFIQ_LIB::Session::assessment ( ) [inline]

Access reference to the FaceImageQualityAssessment object, connected to this session.

Returns

quality assessment object reference.

7.48.3.2 GenerateId()

std::string OFIQ_LIB::Session::GenerateId ( ) const [private]

Method for generating uuid's for the session.

Returns

std::string

7.48.3.3 getAlignedFace()

cv::Mat OFIQ_LIB::Session::getAlignedFace ( ) const

Get the Aligned Face object.

Returns

cv::Mat

7.48.3.4 getAlignedFaceLandmarkedRegion()

cv::Mat OFIQ_LIB::Session::getAlignedFaceLandmarkedRegion ( ) const

Get the Aligned Face Landmarked Region.

Returns

cv::Mat

Generated by Doxygen
7.48 OFIQ_LIB::Session Class Reference 183

7.48.3.5 getAlignedFaceLandmarks()

OFIQ::FaceLandmarks OFIQ_LIB::Session::getAlignedFaceLandmarks ( ) const

Get the Aligned Face Landmarks detected on the aligned image.

Returns

OFIQ::FaceLandmarks

7.48.3.6 getAlignedFaceTransformationMatrix()

cv::Mat OFIQ_LIB::Session::getAlignedFaceTransformationMatrix ( ) const

Get the Aligned Face Transformation Matrix.

Returns

cv::Mat

7.48.3.7 getDetectedFaces()

std::vector< OFIQ::BoundingBox > OFIQ_LIB::Session::getDetectedFaces ( ) const

Get the Detected Faces.

Returns

std::vector<OFIQ::BoundingBox> Return the bounding boxes of faces found on the image.

7.48.3.8 getFaceOcclusionSegmentationImage()

cv::Mat OFIQ_LIB::Session::getFaceOcclusionSegmentationImage ( ) const

Get the Face Occlusion Segmentation Image, see OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation)

Returns

cv::Mat

7.48.3.9 getFaceParsingImage()

cv::Mat OFIQ_LIB::Session::getFaceParsingImage ( ) const

Get the Face Parsing Image, see OFIQ_LIB::modules::segmentations::FaceParsing).

Returns

cv::Mat

Generated by Doxygen
184 Class Documentation

7.48.3.10 getLandmarks()

OFIQ::FaceLandmarks OFIQ_LIB::Session::getLandmarks ( ) const

Get the Landmarks detected on the input image.

Returns

OFIQ::FaceLandmarks

7.48.3.11 getPose()

EulerAngle OFIQ_LIB::Session::getPose ( ) const

Get the Pose of the input image.

Returns

EulerAngle Pose of the ipnut image.

7.48.3.12 Id()

const std::string & OFIQ_LIB::Session::Id ( ) const [inline]

Access to the id connected to this session.

Returns

const std::string& Reference to the id of this session.

7.48.3.13 image()

const OFIQ::Image & OFIQ_LIB::Session::image ( ) const [inline]

Acess reference to the input image, connected to this session.

Returns

input image reference.

7.48.3.14 setAlignedFace()

void OFIQ_LIB::Session::setAlignedFace (
const cv::Mat & i_alignedFace )

Set the Aligned Face.

Generated by Doxygen
7.48 OFIQ_LIB::Session Class Reference 185

Parameters
i_alignedFace

7.48.3.15 setAlignedFaceLandmarkedRegion()

void OFIQ_LIB::Session::setAlignedFaceLandmarkedRegion (
const cv::Mat & i_alignedFaceRegion )

Set the Aligned Face Landmarked Region.

Parameters
i_alignedFaceRegion

7.48.3.16 setAlignedFaceLandmarks()

void OFIQ_LIB::Session::setAlignedFaceLandmarks (
const OFIQ::FaceLandmarks & i_landmarks )

Set the Aligned Face Landmarks detected on the aligned image.

Parameters
i_landmarks

7.48.3.17 setAlignedFaceTransformationMatrix()

void OFIQ_LIB::Session::setAlignedFaceTransformationMatrix (
const cv::Mat & i_transformationMatrix )

Set the Aligned Face Transformation Matrix.

Parameters

i_transformationMatrix

7.48.3.18 setDetectedFaces()

void OFIQ_LIB::Session::setDetectedFaces (
const std::vector< OFIQ::BoundingBox > & i_boundingBoxes )

Set the Detected Faces.

Generated by Doxygen
186 Class Documentation

Parameters

i_boundingBoxes Vector of face bounding boxes found by a face detector.

7.48.3.19 setFaceOcclusionSegmentationImage()

void OFIQ_LIB::Session::setFaceOcclusionSegmentationImage (
const cv::Mat & i_segmentationImage )

Set the Face Occlusion Segmentation Image, see OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation)

Parameters
i_segmentationImage

7.48.3.20 setFaceParsingImage()

void OFIQ_LIB::Session::setFaceParsingImage (
const cv::Mat & i_parsingImage )

Set the Face Parsing Image, see OFIQ_LIB::modules::segmentations::FaceParsing).

Parameters
i_parsingImage

7.48.3.21 setLandmarks()

void OFIQ_LIB::Session::setLandmarks (
const OFIQ::FaceLandmarks & i_landmarks )

Set the Landmarks detected on the input image.

Parameters
i_landmarks

7.48.3.22 setPose()

void OFIQ_LIB::Session::setPose (
const EulerAngle & i_pose )

Set the Pose of the input image.

Generated by Doxygen
7.48 OFIQ_LIB::Session Class Reference 187

Parameters
i_pose

7.48.4 Member Data Documentation

7.48.4.1 m_alignedFace

cv::Mat OFIQ_LIB::Session::m_alignedFace [private]

Container for storing the aligned image.

7.48.4.2 m_alignedFacelandmarkedRegion

cv::Mat OFIQ_LIB::Session::m_alignedFacelandmarkedRegion [private]

Container for storing the landmarks of the aligned face image.

7.48.4.3 m_alignedFaceLandmarks

OFIQ::FaceLandmarks OFIQ_LIB::Session::m_alignedFaceLandmarks [private]

Container for storing the landmark information of the aligned image.

7.48.4.4 m_alignedFaceTransformationMatrix

cv::Mat OFIQ_LIB::Session::m_alignedFaceTransformationMatrix [private]

Container for storing the transformation matrix that led to the aligned image.

7.48.4.5 m_assessment

OFIQ::FaceImageQualityAssessment& OFIQ_LIB::Session::m_assessment [private]

Refernce to the FaceImageQualityAssessment object, connected to this session.

7.48.4.6 m_detectedFaces

std::vector<OFIQ::BoundingBox> OFIQ_LIB::Session::m_detectedFaces [private]

Container for the faces found on the input image.

Generated by Doxygen
188 Class Documentation

7.48.4.7 m_faceOcclusionSegmentationImage

cv::Mat OFIQ_LIB::Session::m_faceOcclusionSegmentationImage [private]

Container for storing the result of the face occlusion segmented image.

7.48.4.8 m_faceParsingImage

cv::Mat OFIQ_LIB::Session::m_faceParsingImage [private]

Container for storing the segmented face image.

7.48.4.9 m_id

std::string OFIQ_LIB::Session::m_id [private]

Container for storing the id of the session.

7.48.4.10 m_image

const OFIQ::Image& OFIQ_LIB::Session::m_image [private]

Reference to the input image, connected to this session.

7.48.4.11 m_landmarks

OFIQ::FaceLandmarks OFIQ_LIB::Session::m_landmarks [private]

Container for storing the landmark information.

7.48.4.12 m_pose

EulerAngle OFIQ_LIB::Session::m_pose [private]

Container for storing the pose information.

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

• Session.h

Generated by Doxygen
7.49 OFIQ_LIB::modules::measures::Sharpness Class Reference 189

7.49 OFIQ_LIB::modules::measures::Sharpness Class Reference

Implemantation of the sharpness measure.

#include <Sharpness.h>

Inheritance diagram for OFIQ_LIB::modules::measures::Sharpness:

OFIQ_LIB::modules::measures::Measure

OFIQ_LIB::modules::measures::Sharpness

Public Member Functions

• Sharpness (const Configuration &configuration)

Construct a new Sharpness object.
• void Execute (OFIQ_LIB::Session &session) override
Run computation of the sharpness measure.

Public Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• Measure (const Configuration &configuration, OFIQ::QualityMeasure measure)

Constructor.
• virtual ∼Measure ()=default
Destructor.
• virtual std::string GetName () const
Returns the name of the measure.
• virtual OFIQ::QualityMeasure GetQualityMeasure () const
Returns an enum encoding the measure.
• void SetQualityMeasure (OFIQ_LIB::Session &session, OFIQ::QualityMeasure measure, double rawValue,
OFIQ::QualityMeasureReturnCode code)
Inserts the result of a quality assessment in the session object.

Private Member Functions

• void GetCroppedImages (const Session &session, cv::Mat &faceCrop, cv::Mat &maskCrop, bool useAligned,
float faceRegionAlpha) const
Get the cropped face region.
• cv::Mat GetClassifierFocusFeatures (const cv::Mat &image, const cv::Mat &mask, bool applyBlur) const
Computation of the input features using different edge detectors.

Generated by Doxygen
190 Class Documentation

Private Attributes
• std::string m_modelFile
Name of the random forest model, extracted from the configuration file.
• std::shared_ptr< cv::ml::RTrees > m_rtree
Instance of the random forest model.
• bool m_useAligned
The sharpness measure can be computed on the aligned or the original image. useAligned set to true will run the
computation on the aligned image. The member is read from the configuration file.
• double m_faceRegionAlpha
For faceRegionAlpha = 0, the algorithm uses the inner face region. For faceRegionAlpha = 0.85, the algorithm uses
the extended face region as specified for the FaceOcclusionin FRVT Quality.
• int m_numTrees
This member stores the number of trees used for the random forest. Internal use only.

Additional Inherited Members

Protected Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• void AddSigmoid (OFIQ::QualityMeasure measure, const SigmoidParameters &defaultValues)
Reads sigmoid-function based quality mapping from the configuration.
• void AddSigmoid (const std::string &key, SigmoidParameters defaultValues)
Reads sigmoid-function based quality mapping from the configuration.
• double ExecuteScalarConversion (OFIQ::QualityMeasure measure, double rawValue)
Maps a native quality score to a quality component value.
• double ExecuteScalarConversion (const std::string &key, double rawValue)
Maps a native quality score to a quality component value.

Static Protected Member Functions inherited from

OFIQ_LIB::modules::measures::Measure
• static double Sigmoid (double x, double x0, double w)
Sigmoid function.

Protected Attributes inherited from OFIQ_LIB::modules::measures::Measure

• const Configuration & configuration
Reference to the configuration with which the measure constructor has been invoked.

7.49.1 Detailed Description

Implemantation of the sharpness measure.

This quality component can be used to efficiently choose the better focused face portrait among several face sam-
ples of the same biometric capture subject. It should not be used to perform an absolute sharpness assessment if
only one sample is available

7.49.2 Constructor & Destructor Documentation

7.49.2.1 Sharpness()

OFIQ_LIB::modules::measures::Sharpness::Sharpness (
const Configuration & configuration ) [explicit]

Construct a new Sharpness object.

Generated by Doxygen
7.49 OFIQ_LIB::modules::measures::Sharpness Class Reference 191

Parameters

configuration Configuration object from which measure-related configuration is read.

7.49.3 Member Function Documentation

7.49.3.1 Execute()

void OFIQ_LIB::modules::measures::Sharpness::Execute (
OFIQ_LIB::Session & session ) [override], [virtual]

Run computation of the sharpness measure.

Parameters

session Session object computed by the OFIQImpl::performPreprocessing() method.

Implements OFIQ_LIB::modules::measures::Measure.

7.49.3.2 GetClassifierFocusFeatures()

cv::Mat OFIQ_LIB::modules::measures::Sharpness::GetClassifierFocusFeatures (
const cv::Mat & image,
const cv::Mat & mask,
bool applyBlur ) const [private]

Computation of the input features using different edge detectors.

Parameters
image Input image.
mask Input region of the face.
applyBlur Wheter or not rub a GaussianBlur before the edge detection.

Returns

cv::Mat Container storing the results of the different edge detectors.

7.49.3.3 GetCroppedImages()

void OFIQ_LIB::modules::measures::Sharpness::GetCroppedImages (
const Session & session,
cv::Mat & faceCrop,
cv::Mat & maskCrop,
bool useAligned,
float faceRegionAlpha ) const [private]

Get the cropped face region.

Generated by Doxygen
192 Class Documentation

Parameters
session Data container.
faceCrop Computed crop of the face.
maskCrop Mask used for the cropping. Will be computed in the method.
useAligned Switch for using the aligned image.
faceRegionAlpha Enlarge the face region by passing this parameter.

7.49.4 Member Data Documentation

7.49.4.1 m_faceRegionAlpha

double OFIQ_LIB::modules::measures::Sharpness::m_faceRegionAlpha [private]

For faceRegionAlpha = 0, the algorithm uses the inner face region. For faceRegionAlpha = 0.85, the algorithm uses
the extended face region as specified for the FaceOcclusionin FRVT Quality.

7.49.4.2 m_modelFile

std::string OFIQ_LIB::modules::measures::Sharpness::m_modelFile [private]

Name of the random forest model, extracted from the configuration file.

7.49.4.3 m_numTrees

int OFIQ_LIB::modules::measures::Sharpness::m_numTrees [private]

This member stores the number of trees used for the random forest. Internal use only.

7.49.4.4 m_rtree

std::shared_ptr<cv::ml::RTrees> OFIQ_LIB::modules::measures::Sharpness::m_rtree [private]

Instance of the random forest model.

7.49.4.5 m_useAligned

bool OFIQ_LIB::modules::measures::Sharpness::m_useAligned [private]

The sharpness measure can be computed on the aligned or the original image. useAligned set to true will run the
computation on the aligned image. The member is read from the configuration file.

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

• Sharpness.h

Generated by Doxygen
7.50 OFIQ_LIB::modules::measures::SigmoidParameters Struct Reference 193

7.50 OFIQ_LIB::modules::measures::SigmoidParameters Struct

Reference

Parameters of the sigmoid function based quality mapping.

#include <Measure.h>

Public Member Functions

• SigmoidParameters ()
Default constructor.
• void setInverse ()
Sets this quality mapping to a smaller-is-better variant.
• void Reset ()
Resets the members of the quality mapping to their default values.

Public Attributes

• double h
Scale factor.
• double a
Constant shift.
• double s
Signed weight for sigmoid part.
• double x0
Center point in sigmoid part.
• double w
Divisor in sigmoid part.
• bool round
Flag controlling if the compiler's native rounding function (std::round) is applied.

7.50.1 Detailed Description

Parameters of the sigmoid function based quality mapping.

A sigmoid-based quality mapping is the following function

Q(x) = h · (a + s · sigmoid(x, x0 , w))

where
sigmoid(x, x0 , w) = (1 + exp((x0 − x)/w)−1 .
Q can be used to map a native quality score x to a value between 0 and 100. The other symbols denote parameters
that can be configured using the struct.

Generated by Doxygen
194 Class Documentation

7.50.2 Constructor & Destructor Documentation

7.50.2.1 SigmoidParameters()

OFIQ_LIB::modules::measures::SigmoidParameters::SigmoidParameters ( ) [inline]

Default constructor.

After construction, all members are set to their default values.

7.50.3 Member Function Documentation

7.50.3.1 Reset()

void OFIQ_LIB::modules::measures::SigmoidParameters::Reset ( ) [inline]

Resets the members of the quality mapping to their default values.

7.50.3.2 setInverse()

void OFIQ_LIB::modules::measures::SigmoidParameters::setInverse ( ) [inline]

Sets this quality mapping to a smaller-is-better variant.

If the parameters a is 0 and s is, then this quality mapping is in larger-is-better-semantics. For those mappings, the
method can be used to set the mapping to its smaller-is- better counterpart by setting a to 1 and s to -1. This is
used by some measures to conveniently set a quality mapping.

7.50.4 Member Data Documentation

7.50.4.1 a

double OFIQ_LIB::modules::measures::SigmoidParameters::a

Constant shift.

The default value is 0.

7.50.4.2 h

double OFIQ_LIB::modules::measures::SigmoidParameters::h

Scale factor.

The default value is 100.

Generated by Doxygen
7.51 OFIQ_LIB::modules::measures::SingleFacePresent Class Reference 195

7.50.4.3 round

bool OFIQ_LIB::modules::measures::SigmoidParameters::round

Flag controlling if the compiler's native rounding function (std::round) is applied.

The default value is true.

7.50.4.4 s

double OFIQ_LIB::modules::measures::SigmoidParameters::s

Signed weight for sigmoid part.

The default value is 1.

7.50.4.5 w

double OFIQ_LIB::modules::measures::SigmoidParameters::w

Divisor in sigmoid part.

The default value of 0.7 has been chosen arbitrarily and should specified when a mapping is configured.

7.50.4.6 x0

double OFIQ_LIB::modules::measures::SigmoidParameters::x0

Center point in sigmoid part.

The default value of 4 has been chosen arbitrarily and should specified when a mapping is configured.

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

• Measure.h

7.51 OFIQ_LIB::modules::measures::SingleFacePresent Class

Reference

Implementation of the single face present measure.

#include <SingleFacePresent.h>

Inheritance diagram for OFIQ_LIB::modules::measures::SingleFacePresent:

OFIQ_LIB::modules::measures::Measure

OFIQ_LIB::modules::measures::SingleFacePresent

Generated by Doxygen
196 Class Documentation

Public Member Functions

• SingleFacePresent (const Configuration &configuration)

Construct a new Single Face Present object.
• void Execute (OFIQ_LIB::Session &session) override
Run computation of the single face present analysis.

Public Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• Measure (const Configuration &configuration, OFIQ::QualityMeasure measure)

Constructor.
• virtual ∼Measure ()=default
Destructor.
• virtual std::string GetName () const
Returns the name of the measure.
• virtual OFIQ::QualityMeasure GetQualityMeasure () const
Returns an enum encoding the measure.
• void SetQualityMeasure (OFIQ_LIB::Session &session, OFIQ::QualityMeasure measure, double rawValue,
OFIQ::QualityMeasureReturnCode code)
Inserts the result of a quality assessment in the session object.

Additional Inherited Members

Protected Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• void AddSigmoid (OFIQ::QualityMeasure measure, const SigmoidParameters &defaultValues)

Reads sigmoid-function based quality mapping from the configuration.
• void AddSigmoid (const std::string &key, SigmoidParameters defaultValues)
Reads sigmoid-function based quality mapping from the configuration.
• double ExecuteScalarConversion (OFIQ::QualityMeasure measure, double rawValue)
Maps a native quality score to a quality component value.
• double ExecuteScalarConversion (const std::string &key, double rawValue)
Maps a native quality score to a quality component value.

Static Protected Member Functions inherited from

OFIQ_LIB::modules::measures::Measure

• static double Sigmoid (double x, double x0, double w)

Sigmoid function.

Protected Attributes inherited from OFIQ_LIB::modules::measures::Measure

• const Configuration & configuration

Reference to the configuration with which the measure constructor has been invoked.

Generated by Doxygen
7.52 OFIQ_LIB::modules::detectors::SSDFaceDetector Class Reference 197

7.51.1 Detailed Description

Implementation of the single face present measure.

Single face present measure shall ensure that only one face is visible on the image.

7.51.2 Constructor & Destructor Documentation

7.51.2.1 SingleFacePresent()

OFIQ_LIB::modules::measures::SingleFacePresent::SingleFacePresent (
const Configuration & configuration ) [explicit]

Construct a new Single Face Present object.

Parameters

configuration Configuration object from which measure-related configuration is read.

7.51.3 Member Function Documentation

7.51.3.1 Execute()

void OFIQ_LIB::modules::measures::SingleFacePresent::Execute (
OFIQ_LIB::Session & session ) [override], [virtual]

Run computation of the single face present analysis.

Parameters

session Session object containing the original facial image and pre-processing results computed by the
OFIQImpl::performPreprocessing() method

Implements OFIQ_LIB::modules::measures::Measure.

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

• SingleFacePresent.h

7.52 OFIQ_LIB::modules::detectors::SSDFaceDetector Class Reference

Implementation of a face detector using the SSD face detector CNN.

#include <opencv_ssd_face_detector.h>

Inheritance diagram for OFIQ_LIB::modules::detectors::SSDFaceDetector:

Generated by Doxygen
198 Class Documentation

OFIQ_LIB::FaceDetectorInterface

OFIQ_LIB::modules::detectors::SSDFaceDetector

Public Member Functions

• SSDFaceDetector (const Configuration &config)

Constructor a new SSDFaceDetector.
• ∼SSDFaceDetector () override=default
Destructor of the SSDFaceDetector.

Public Member Functions inherited from OFIQ_LIB::FaceDetectorInterface

• virtual ∼FaceDetectorInterface ()=default
Destroy the Face Detector Interface object.
• std::vector< OFIQ::BoundingBox > detectFaces (OFIQ_LIB::Session &session)
This function detects faces in given image.

Protected Member Functions

• std::vector< OFIQ::BoundingBox > UpdateFaces (OFIQ_LIB::Session &session) override

Implementation of the face detection method.

Private Attributes

• std::shared_ptr< cv::dnn::Net > m_dnnNet {nullptr}

Instance of an opencv dnn::Net.
• double m_confidenceThreshold
Confidence threshold used for the face detection. The value is read from the configuration file.
• double m_padding
Add padding around the image (faceImage.width ∗ padding; faceImage.height ∗ padding;)
• double m_minimalRelativeFaceSize
Filter threshold for removing to small face found on the image. This value is read from the configuration file.

7.52.1 Detailed Description

Implementation of a face detector using the SSD face detector CNN.

7.52.2 Constructor & Destructor Documentation

7.52.2.1 SSDFaceDetector()

OFIQ_LIB::modules::detectors::SSDFaceDetector::SSDFaceDetector (
const Configuration & config ) [explicit]

Constructor a new SSDFaceDetector.

Generated by Doxygen
7.52 OFIQ_LIB::modules::detectors::SSDFaceDetector Class Reference 199

Parameters

config

7.52.2.2 ∼SSDFaceDetector()

OFIQ_LIB::modules::detectors::SSDFaceDetector::∼SSDFaceDetector ( ) [override], [default]

Destructor of the SSDFaceDetector.

7.52.3 Member Function Documentation

7.52.3.1 UpdateFaces()

std::vector< OFIQ::BoundingBox > OFIQ_LIB::modules::detectors::SSDFaceDetector::UpdateFaces (

OFIQ_LIB::Session & session ) [override], [protected], [virtual]

Implementation of the face detection method.

Parameters

session Session object computed by the OFIQImpl::performPreprocessing() method.

Returns

std::vector<OFIQ::BoundingBox> Bounding boxes of the detected faces

Implements OFIQ_LIB::FaceDetectorInterface.

7.52.4 Member Data Documentation

7.52.4.1 m_confidenceThreshold

double OFIQ_LIB::modules::detectors::SSDFaceDetector::m_confidenceThreshold [private]

Confidence threshold used for the face detection. The value is read from the configuration file.

7.52.4.2 m_dnnNet

std::shared_ptr<cv::dnn::Net> OFIQ_LIB::modules::detectors::SSDFaceDetector::m_dnnNet {nullptr}

[private]

Instance of an opencv dnn::Net.

Generated by Doxygen
200 Class Documentation

7.52.4.3 m_minimalRelativeFaceSize

double OFIQ_LIB::modules::detectors::SSDFaceDetector::m_minimalRelativeFaceSize [private]

Filter threshold for removing to small face found on the image. This value is read from the configuration file.

7.52.4.4 m_padding

double OFIQ_LIB::modules::detectors::SSDFaceDetector::m_padding [private]

Add padding around the image (faceImage.width ∗ padding; faceImage.height ∗ padding;)

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

• opencv_ssd_face_detector.h

7.53 OFIQ_LIB::modules::measures::UnderExposurePrevention Class

Reference

Implementation of the under-exposure prevention measure.

#include <UnderExposurePrevention.h>

Inheritance diagram for OFIQ_LIB::modules::measures::UnderExposurePrevention:

OFIQ_LIB::modules::measures::Measure

OFIQ_LIB::modules::measures::UnderExposurePrevention

Public Member Functions

• UnderExposurePrevention (const Configuration &configuration)

Constructor a new Under Exposure Prevention object.
• void Execute (OFIQ_LIB::Session &session) override
Run the computation of the under-exposure prevention measure.

Public Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• Measure (const Configuration &configuration, OFIQ::QualityMeasure measure)
Constructor.
• virtual ∼Measure ()=default
Destructor.
• virtual std::string GetName () const
Returns the name of the measure.
• virtual OFIQ::QualityMeasure GetQualityMeasure () const
Returns an enum encoding the measure.
• void SetQualityMeasure (OFIQ_LIB::Session &session, OFIQ::QualityMeasure measure, double rawValue,
OFIQ::QualityMeasureReturnCode code)
Inserts the result of a quality assessment in the session object.

Generated by Doxygen
7.53 OFIQ_LIB::modules::measures::UnderExposurePrevention Class Reference 201

Additional Inherited Members

Protected Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• void AddSigmoid (OFIQ::QualityMeasure measure, const SigmoidParameters &defaultValues)

Reads sigmoid-function based quality mapping from the configuration.
• void AddSigmoid (const std::string &key, SigmoidParameters defaultValues)
Reads sigmoid-function based quality mapping from the configuration.
• double ExecuteScalarConversion (OFIQ::QualityMeasure measure, double rawValue)
Maps a native quality score to a quality component value.
• double ExecuteScalarConversion (const std::string &key, double rawValue)
Maps a native quality score to a quality component value.

Static Protected Member Functions inherited from

OFIQ_LIB::modules::measures::Measure

• static double Sigmoid (double x, double x0, double w)

Sigmoid function.

Protected Attributes inherited from OFIQ_LIB::modules::measures::Measure

• const Configuration & configuration

Reference to the configuration with which the measure constructor has been invoked.

7.53.1 Detailed Description

Implementation of the under-exposure prevention measure.

The representation of a face is considered too dark if it has a high proportion of pixels that have a low luminance
value.

7.53.2 Constructor & Destructor Documentation

7.53.2.1 UnderExposurePrevention()

OFIQ_LIB::modules::measures::UnderExposurePrevention::UnderExposurePrevention (
const Configuration & configuration ) [explicit]

Constructor a new Under Exposure Prevention object.

Parameters

configuration Configuration object from which measure-related configuration is read.

Generated by Doxygen
202 Class Documentation

7.53.3 Member Function Documentation

7.53.3.1 Execute()

void OFIQ_LIB::modules::measures::UnderExposurePrevention::Execute (
OFIQ_LIB::Session & session ) [override], [virtual]

Run the computation of the under-exposure prevention measure.

Parameters

session Session object computed by the OFIQImpl::performPreprocessing() method.

Implements OFIQ_LIB::modules::measures::Measure.
The documentation for this class was generated from the following file:

• UnderExposurePrevention.h

7.54 OFIQ_LIB::modules::measures::UnifiedQualityScore Class

Reference

Implementation of the unified quality measure.

#include <UnifiedQualityScore.h>
Inheritance diagram for OFIQ_LIB::modules::measures::UnifiedQualityScore:

OFIQ_LIB::modules::measures::Measure

OFIQ_LIB::modules::measures::UnifiedQualityScore

Public Member Functions

• UnifiedQualityScore (const Configuration &configuration)
Construct a new Unified Quality Score object.
• void Execute (OFIQ_LIB::Session &session) override
Run the computation on the measure.

Public Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• Measure (const Configuration &configuration, OFIQ::QualityMeasure measure)
Constructor.
• virtual ∼Measure ()=default
Destructor.
• virtual std::string GetName () const
Returns the name of the measure.
• virtual OFIQ::QualityMeasure GetQualityMeasure () const
Returns an enum encoding the measure.
• void SetQualityMeasure (OFIQ_LIB::Session &session, OFIQ::QualityMeasure measure, double rawValue,
OFIQ::QualityMeasureReturnCode code)
Inserts the result of a quality assessment in the session object.

Generated by Doxygen
7.54 OFIQ_LIB::modules::measures::UnifiedQualityScore Class Reference 203

Private Attributes

• ONNXRuntimeSegmentation m_onnxRuntimeEnv
Instance of the neural network (iResNet50 model M).

Additional Inherited Members

Protected Member Functions inherited from OFIQ_LIB::modules::measures::Measure

• void AddSigmoid (OFIQ::QualityMeasure measure, const SigmoidParameters &defaultValues)

Reads sigmoid-function based quality mapping from the configuration.
• void AddSigmoid (const std::string &key, SigmoidParameters defaultValues)
Reads sigmoid-function based quality mapping from the configuration.
• double ExecuteScalarConversion (OFIQ::QualityMeasure measure, double rawValue)
Maps a native quality score to a quality component value.
• double ExecuteScalarConversion (const std::string &key, double rawValue)
Maps a native quality score to a quality component value.

Static Protected Member Functions inherited from

OFIQ_LIB::modules::measures::Measure

• static double Sigmoid (double x, double x0, double w)

Sigmoid function.

Protected Attributes inherited from OFIQ_LIB::modules::measures::Measure

• const Configuration & configuration

Reference to the configuration with which the measure constructor has been invoked.

7.54.1 Detailed Description

Implementation of the unified quality measure.

The quality score refers to the requirements in clause 5.4.8 in ISO/IEC 19794-5:2011 frontal image type (relevant
for EU-EES implementing decision 2019/329) and in clause 7.7 in ISO/IEC 39794-1 (relevant for UC1 specified in
ICAO Document 9303)

7.54.2 Constructor & Destructor Documentation

7.54.2.1 UnifiedQualityScore()

OFIQ_LIB::modules::measures::UnifiedQualityScore::UnifiedQualityScore (
const Configuration & configuration ) [explicit]

Construct a new Unified Quality Score object.

Generated by Doxygen
204 Class Documentation

Parameters

configuration Configuration object from which measure-related configuration is read.

7.54.3 Member Function Documentation

7.54.3.1 Execute()

void OFIQ_LIB::modules::measures::UnifiedQualityScore::Execute (
OFIQ_LIB::Session & session ) [override], [virtual]

Run the computation on the measure.

The algorithm uses a iResNet50 model M from https://github.com/IrvingMeng/MagFace trained

on MS1MV2 with MagFace loss without DDP parallelisation. The algorithm takes as input the image I output by the
alignment algorithm.

Parameters

session Session object computed by the OFIQImpl::performPreprocessing() method.

Implements OFIQ_LIB::modules::measures::Measure.

7.54.4 Member Data Documentation

7.54.4.1 m_onnxRuntimeEnv

ONNXRuntimeSegmentation OFIQ_LIB::modules::measures::UnifiedQualityScore::m_onnxRuntimeEnv
[private]

Instance of the neural network (iResNet50 model M).

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

• UnifiedQualityScore.h

Generated by Doxygen
Chapter 8

File Documentation

8.1 mainpage.h File Reference

This header file is for generating the doxygen documentation for OFIQ.

8.1.1 Detailed Description

This header file is for generating the doxygen documentation for OFIQ.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.2 mainpage.h

Go to the documentation of this file.

00001
00977 #pragma once

Generated by Doxygen
206 File Documentation

8.3 ofiq_lib.h File Reference

Class describing the interface to the OFIQ.

#include <cstdint>
#include <string>
#include <vector>
#include <ofiq_structs.h>

Classes

• class OFIQ::Interface
The interface to FACE QA implementation.

Namespaces

• namespace OFIQ
Namespace for OFIQ API.

Macros

• #define OFIQ_EXPORT

8.3.1 Detailed Description

Class describing the interface to the OFIQ.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

Generated by Doxygen
8.4 ofiq_lib.h 207

8.3.2 Macro Definition Documentation

8.3.2.1 OFIQ_EXPORT

#define OFIQ_EXPORT

8.4 ofiq_lib.h

Go to the documentation of this file.

00001
00027 #ifndef OFIQ_LIB_H
00028 #define OFIQ_LIB_H
00029
00030 #include <cstdint>
00031 #include <string>
00032 #include <vector>
00033
00034 #include <ofiq_structs.h>
00035
00036 #ifdef _WIN32
00037 # ifdef OFIQ_EXPORTS
00038 # define OFIQ_EXPORT __declspec(dllexport)
00039 # else
00040 # define OFIQ_EXPORT __declspec(dllimport)
00041 # endif
00042 #else
00043 # define OFIQ_EXPORT
00044 #endif
00045
00049 namespace OFIQ
00050 {
00051
00059 class Interface
00060 {
00061 public:
00066 virtual ~Interface() = default;
00067
00080 virtual OFIQ::ReturnStatus
00081 initialize(const std::string& configDir, const std::string& configFileName) = 0;
00082
00095 virtual OFIQ::ReturnStatus scalarQuality(const OFIQ::Image& face, double& quality) = 0;
00096
00115 virtual OFIQ::ReturnStatus vectorQuality(
00116 const OFIQ::Image& image, OFIQ::FaceImageQualityAssessment& assessments) = 0;
00117
00133 OFIQ_EXPORT static std::shared_ptr<Interface> getImplementation();
00134
00135 OFIQ_EXPORT void getVersion(int& major, int& minor, int& patch) const;
00136
00137 };
00138 }
00139
00140 #endif /* OFIQ_LIB_H */

8.5 ofiq_lib_impl.h File Reference

Implementation of the OFIQ_LIB.

#include "Configuration.h"
#include "Executor.h"
#include "ofiq_lib.h"
#include "NeuronalNetworkContainer.h"

Generated by Doxygen
208 File Documentation

Classes

• class OFIQ_LIB::OFIQImpl
Implementation of the OFIQ_LIB.

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.

8.5.1 Detailed Description

Implementation of the OFIQ_LIB.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.6 ofiq_lib_impl.h

Go to the documentation of this file.

00001
00027 #ifndef OFIQ_LIB_IMPL_H
00028 #define OFIQ_LIB_IMPL_H
00029
00030 #include "Configuration.h"
00031 #include "Executor.h"
00032 #include "ofiq_lib.h"
00033 #include "NeuronalNetworkContainer.h"
00034
00038 namespace OFIQ_LIB
00039 {
00044 class OFIQImpl : public OFIQ::Interface
00045 {
00046 public:
00051 OFIQImpl();
00052
00057 ~OFIQImpl() override = default;

Generated by Doxygen
8.7 ofiq_structs.h File Reference 209

00058
00066 OFIQ::ReturnStatus
00067 initialize(const std::string& configDir, const std::string& configValue) override;
00068
00069
00078 OFIQ::ReturnStatus scalarQuality(const OFIQ::Image& face, double& quality) override;
00079
00080
00088 OFIQ::ReturnStatus vectorQuality(
00089 const OFIQ::Image& image, OFIQ::FaceImageQualityAssessment& assessments) override;
00090
00091 private:
00096 std::unique_ptr<OFIQ_LIB::modules::measures::Executor> m_executorPtr;
00097
00102 OFIQ::FaceImageQualityAssessment dummyAssement;
00103
00108 OFIQ::Image dummyImage;
00109
00114 OFIQ_LIB::Session m_emptySession;
00115
00116
00121 std::unique_ptr<Configuration> config;
00122
00127 std::unique_ptr<NeuronalNetworkContainer> networks;
00128
00137 std::unique_ptr<OFIQ_LIB::modules::measures::Executor> CreateExecutor(Session& session);
00138
00139
00144 void CreateNetworks();
00145
00153 void performPreprocessing(Session& session);
00154
00162 void alignFaceImage(Session& session);
00163 };
00164 }
00165
00166 #endif /* OFIQ_LIB_IMPL_H */

8.7 ofiq_structs.h File Reference

PRovides several helper classes, enums and functions used in the OFIQ framework.

#include <cstdint>
#include <iostream>
#include <map>
#include <memory>
#include <string>
#include <utility>
#include <vector>

Classes

• struct OFIQ::Image
Struct representing a single image.
• struct OFIQ::ReturnStatus
A structure to contain information about a failure by the software under test.
• struct OFIQ::QualityMeasureResult
Data structure to handle the results of a quality measure.
• struct OFIQ::BoundingBox
Data structure for descibing bounding boxes, e.g. the face region of the faces found by a face detector.
• struct OFIQ::LandmarkPoint
Data structure to describe the x and y coordinate of a landmark.
• struct OFIQ::FaceLandmarks
Data structure for storing facial landmarks.
• struct OFIQ::FaceImageQualityAssessment
Data structure storing the results of the different measurement computations.

Generated by Doxygen
210 File Documentation

Namespaces

• namespace OFIQ
Namespace for OFIQ API.

Typedefs

• using OFIQ::QualityAssessments = std::map<QualityMeasure, QualityMeasureResult>

Data structure that stores key-value pairs, with each entry representing a quality element and its value.
• using OFIQ::Landmarks = std::vector<LandmarkPoint>
container for a collection of landmarks, e.g. belonging to all the landmarks detected on a face image.

Enumerations

• enum class OFIQ::ReturnCode {

OFIQ::Success = 0 , OFIQ::ImageReadingError , OFIQ::ImageWritingError , OFIQ::MissingConfigParamError
,
OFIQ::UnknownConfigParamError , OFIQ::FaceDetectionError , OFIQ::FaceLandmarkExtractionError ,
OFIQ::FaceOcclusionSegmentationError ,
OFIQ::FaceParsingError , OFIQ::UnknownError , OFIQ::QualityAssessmentError , OFIQ::NotImplemented }
Return codes for functions specified in this API.
• enum class OFIQ::QualityMeasure {
OFIQ::UnifiedQualityScore = 0x41 , OFIQ::BackgroundUniformity = 0x42 , OFIQ::IlluminationUniformity =
0x43 , OFIQ::Luminance = -0x44 ,
OFIQ::LuminanceMean = 0x44 , OFIQ::LuminanceVariance = 0x45 , OFIQ::UnderExposurePrevention =
0x46 , OFIQ::OverExposurePrevention = 0x47 ,
OFIQ::DynamicRange = 0x48 , OFIQ::Sharpness = 0x49 , OFIQ::CompressionArtifacts = 0x4a ,
OFIQ::NaturalColour = 0x4b ,
OFIQ::SingleFacePresent = 0x4c , OFIQ::EyesOpen = 0x4d , OFIQ::MouthClosed = 0x4e , OFIQ::EyesVisible
= 0x4f ,
OFIQ::MouthOcclusionPrevention = 0x50 , OFIQ::FaceOcclusionPrevention = 0x51 , OFIQ::InterEyeDistance
= 0x52 , OFIQ::HeadSize = 0x53 ,
OFIQ::CropOfTheFaceImage = -0x54 , OFIQ::LeftwardCropOfTheFaceImage = 0x54 , OFIQ::RightwardCropOfTheFaceImage
= 0x55 , OFIQ::MarginAboveOfTheFaceImage = 0x56 ,
OFIQ::MarginBelowOfTheFaceImage = 0x57 , OFIQ::HeadPose = -0x58 , OFIQ::HeadPoseYaw = 0x58 ,
OFIQ::HeadPosePitch = 0x59 ,
OFIQ::HeadPoseRoll = 0x5a , OFIQ::ExpressionNeutrality = 0x5b , OFIQ::NoHeadCoverings = 0x5c ,
OFIQ::NotSet = -1 }
Enums presenting the measure labels.
• enum class OFIQ::QualityMeasureReturnCode { OFIQ::Success = 0 , OFIQ::FailureToAssess ,
OFIQ::NotInitialized }
Return codes for QualityMeasureResult.
• enum class OFIQ::FaceDetectorType { OFIQ::OPENCVSSD , OFIQ::NotSet }
Enum describing the different face detector implementations.
• enum class OFIQ::LandmarkType { OFIQ::LM_98 , OFIQ::NotSet }
Enum describing the different implementations of landmarks.

Functions

• std::ostream & OFIQ::operator<< (std::ostream &s, const ReturnCode &rc)

Generated by Doxygen
8.8 ofiq_structs.h 211

8.7.1 Detailed Description

PRovides several helper classes, enums and functions used in the OFIQ framework.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.8 ofiq_structs.h

Go to the documentation of this file.

00001
00027 #ifndef OFIQ_STRUCTS_H
00028 #define OFIQ_STRUCTS_H
00029
00030 #include <cstdint>
00031 #include <iostream>
00032 #include <map>
00033 #include <memory>
00034 #include <string>
00035 #include <utility>
00036 #include <vector>
00037
00041 namespace OFIQ
00042 {
00047 struct Image
00048 {
00049
00051 uint16_t width{ 0 };
00053 uint16_t height{ 0 };
00055 uint8_t depth{ 24 };
00060 std::shared_ptr<uint8_t> data;
00061
00065 Image() = default;
00066
00075 Image(uint16_t width, uint16_t height, uint8_t depth, const std::shared_ptr<uint8_t>& data)
00076 : width{width},
00077 height{height},
00078 depth{depth},
00079 data{data}
00080 {
00081 }
00082
00084 size_t size() const { return (static_cast<size_t>(width) * height * (depth / 8)); }
00085 };
00086
00087
00092 enum class ReturnCode

Generated by Doxygen
212 File Documentation

00093 {
00095 Success = 0,
00097 ImageReadingError,
00099 ImageWritingError,
00101 MissingConfigParamError,
00103 UnknownConfigParamError,
00105 FaceDetectionError,
00107 FaceLandmarkExtractionError,
00109 FaceOcclusionSegmentationError,
00111 FaceParsingError,
00113 UnknownError,
00115 QualityAssessmentError,
00117 NotImplemented
00118 };
00119
00121 inline std::ostream& operator«(std::ostream& s, const ReturnCode& rc)
00122 {
00123 switch (rc)
00124 {
00125 case ReturnCode::Success:
00126 return (s « "Success");
00127 case ReturnCode::UnknownError:
00128 return (s « "Unknown Error");
00129 case ReturnCode::QualityAssessmentError:
00130 return (s « "Failure to generate a quality score on the input image");
00131 case ReturnCode::NotImplemented:
00132 return (s « "Function is not implemented");
00133 default:
00134 return (s « "Undefined error");
00135 }
00136 }
00137
00150 struct ReturnStatus
00151 {
00153 ReturnCode code{ ReturnCode::UnknownError };
00155 std::string info;
00156
00161 ReturnStatus() = default;
00162
00172 ReturnStatus(const ReturnCode code, const std::string& info = "")
00173 : code{code},
00174 info{info}
00175 {
00176 }
00177 };
00178
00181 enum class QualityMeasure
00182 {
00184 UnifiedQualityScore = 0x41,
00186 BackgroundUniformity = 0x42,
00188 IlluminationUniformity = 0x43,
00190 Luminance = -0x44 ,
00192 LuminanceMean = 0x44,
00194 LuminanceVariance = 0x45,
00196 UnderExposurePrevention = 0x46,
00198 OverExposurePrevention = 0x47,
00200 DynamicRange = 0x48,
00202 Sharpness = 0x49,
00204 CompressionArtifacts = 0x4a ,
00206 NaturalColour = 0x4b,
00208 SingleFacePresent = 0x4c ,
00210 EyesOpen = 0x4d ,
00212 MouthClosed = 0x4e,
00214 EyesVisible = 0x4f,
00216 MouthOcclusionPrevention = 0x50,
00218 FaceOcclusionPrevention = 0x51,
00220 InterEyeDistance = 0x52,
00222 HeadSize = 0x53,
00224 CropOfTheFaceImage = -0x54,
00226 LeftwardCropOfTheFaceImage = 0x54,
00228 RightwardCropOfTheFaceImage = 0x55,
00230 MarginAboveOfTheFaceImage = 0x56,
00232 MarginBelowOfTheFaceImage = 0x57,
00234 HeadPose = -0x58,
00236 HeadPoseYaw = 0x58,
00238 HeadPosePitch = 0x59,
00240 HeadPoseRoll = 0x5a,
00242 ExpressionNeutrality = 0x5b,
00244 NoHeadCoverings = 0x5c,
00246 NotSet = -1
00247 };
00248
00253 enum class QualityMeasureReturnCode
00254 {
00256 Success = 0,
00258 FailureToAssess,
00260 NotInitialized

Generated by Doxygen
8.8 ofiq_structs.h 213

00261 };
00262
00267 struct QualityMeasureResult
00268 {
00270 double rawScore{ -1 };
00274 double scalar{ -1 };
00276 QualityMeasureReturnCode code{ QualityMeasureReturnCode::NotInitialized };
00277
00282 QualityMeasureResult() = default;
00283
00291 QualityMeasureResult(double rawScore, double scalar = -1, QualityMeasureReturnCode code =
QualityMeasureReturnCode::NotInitialized)
00292 : rawScore{rawScore},
00293 scalar{scalar},
00294 code{code}
00295 {
00296 }
00297 };
00298
00304 using QualityAssessments = std::map<QualityMeasure, QualityMeasureResult>;
00305
00310 enum class FaceDetectorType
00311 {
00313 OPENCVSSD,
00315 NotSet
00316 };
00317
00318
00324 struct BoundingBox
00325 {
00328 int16_t xleft{ -1 };
00331 int16_t ytop{ -1 };
00333 int16_t width{ -1 };
00335 int16_t height{ -1 };
00336
00338 FaceDetectorType faceDetector = FaceDetectorType::NotSet;
00339
00344 BoundingBox() = default;
00345
00355 BoundingBox(int16_t xleft, int16_t ytop, int16_t width, int16_t height, FaceDetectorType
i_faceDetector)
00356 : xleft{xleft},
00357 ytop{ytop},
00358 width{width},
00359 height{height},
00360 faceDetector(i_faceDetector)
00361 {
00362 }
00363 };
00364
00369 struct LandmarkPoint
00370 {
00375 int16_t x{ -1 };
00380 int16_t y{-1 };
00381
00386 LandmarkPoint() = default;
00387
00394 LandmarkPoint(int16_t i_x, int16_t i_y)
00395 : x{i_x},
00396 y{i_y}
00397 {
00398 }
00399 };
00400
00405 using Landmarks = std::vector<LandmarkPoint>;
00406
00411 enum class LandmarkType
00412 {
00414 LM_98,
00416 NotSet
00417 };
00418
00419
00420
00425 struct FaceLandmarks
00426 {
00428 LandmarkType type{ LandmarkType::NotSet };
00430 Landmarks landmarks;
00431
00433 FaceLandmarks() = default;
00434 };
00435
00440 struct FaceImageQualityAssessment
00441 {
00442
00447 QualityAssessments qAssessments;
00448

Generated by Doxygen
214 File Documentation

00453 BoundingBox boundingBox;

00454
00459 FaceImageQualityAssessment() = default;
00460
00467 FaceImageQualityAssessment(
00468 const QualityAssessments& qAssessments, const BoundingBox& boundingBox)
00469 : qAssessments{qAssessments},
00470 boundingBox{boundingBox}
00471 {
00472 }
00473 };
00474
00475 }
00476
00477 #endif /* OFIQ_STRUCTS_H */

8.9 AllDetectors.h File Reference

Provides the include statements to all classes derived from FaceDetectorInterface.

#include "opencv_ssd_face_detector.h"

8.9.1 Detailed Description

Provides the include statements to all classes derived from FaceDetectorInterface.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.10 AllDetectors.h

Go to the documentation of this file.

00001
00028 #include "opencv_ssd_face_detector.h"

Generated by Doxygen
8.11 detectors.h File Reference 215

8.11 detectors.h File Reference

Provides the interface class to the face detector implementations.

#include "ofiq_lib.h"
#include "Session.h"

Classes

• class OFIQ_LIB::FaceDetectorInterface
Provides the interface class to the face detector implementations.

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.

8.11.1 Detailed Description

Provides the interface class to the face detector implementations.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

Generated by Doxygen
216 File Documentation

8.12 detectors.h

Go to the documentation of this file.

00001
00028 #pragma once
00029
00030 #include "ofiq_lib.h"
00031 #include "Session.h"
00032
00036 namespace OFIQ_LIB
00037 {
00038
00043 class FaceDetectorInterface
00044 {
00045 public:
00050 virtual ~FaceDetectorInterface() = default;
00051
00058 std::vector<OFIQ::BoundingBox> detectFaces(OFIQ_LIB::Session& session);
00059
00060 protected:
00068 virtual std::vector<OFIQ::BoundingBox> UpdateFaces(OFIQ_LIB::Session& session) = 0;
00069 };
00070 }

8.13 opencv_ssd_face_detector.h File Reference

Implementation of a face detector using the SSD face detector CNN.

#include "Configuration.h"
#include "detectors.h"
#include <opencv2/dnn.hpp>

Classes

• class OFIQ_LIB::modules::detectors::SSDFaceDetector
Implementation of a face detector using the SSD face detector CNN.

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::detectors
Provides face detector implementations.

8.13.1 Detailed Description

Implementation of a face detector using the SSD face detector CNN.

Generated by Doxygen
8.14 opencv_ssd_face_detector.h 217

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.14 opencv_ssd_face_detector.h

Go to the documentation of this file.

00001
00027 #pragma once
00028
00029 #include "Configuration.h"
00030 #include "detectors.h"
00031 #include <opencv2/dnn.hpp>
00032
00033
00037 namespace OFIQ_LIB::modules::detectors
00038 {
00039
00043 class SSDFaceDetector : public OFIQ_LIB::FaceDetectorInterface
00044 {
00045 public:
00051 explicit SSDFaceDetector(const Configuration& config);
00052
00057 ~SSDFaceDetector() override = default;
00058
00059 protected:
00067 std::vector<OFIQ::BoundingBox> UpdateFaces(OFIQ_LIB::Session& session) override;
00068
00069
00070 private:
00075 std::shared_ptr<cv::dnn::Net> m_dnnNet{nullptr};
00076
00081 double m_confidenceThreshold;
00082
00087 double m_padding;
00088
00093 double m_minimalRelativeFaceSize;
00094 };
00095 }

8.15 adnet_FaceMap.h File Reference

Provides definitions of landmark indices to access specific parts of ADNet landmarks.

#include "FaceParts.h"
#include <array>
#include <map>
#include <vector>

Generated by Doxygen
218 File Documentation

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::landmarks
Provides implementations of a landmark extractors.
• namespace OFIQ_LIB::modules::landmarks::adnet
Namespace for ADNet-specific landmarks.

Variables

• const LandmarkIds OFIQ_LIB::modules::landmarks::adnet::leftEye {60,61,62,63,64,65,66,67}

Landmark indices (ADNet) of the left eye.
• const LandmarkIds OFIQ_LIB::modules::landmarks::adnet::rightEye {68,69,70,71,72,73,74,75}
Landmark indices (ADNet) of the right eye.
• const LandmarkIds OFIQ_LIB::modules::landmarks::adnet::leftEyeCorners {60,64}
Landmark indices (ADNet) of the left eyes' corners.
• const LandmarkIds OFIQ_LIB::modules::landmarks::adnet::rightEyeCorners {68,72}
Landmark indices (ADNet) of the right eyes' corners.
• const LandmarkIds OFIQ_LIB::modules::landmarks::adnet::nosetip {54}
Landmark index (ADNet) of the nose tip.
• const LandmarkIds OFIQ_LIB::modules::landmarks::adnet::mouthOuter {76,77,78,79,80,81,82,83,84,85,86,87}
Landmark indices (ADNet) on the mouth's outer contour.
• const LandmarkIds OFIQ_LIB::modules::landmarks::adnet::mouthInner {88,89,90,91,92,93,94,95}
Landmark indices (ADNet) on the mouth's inner lip borders.
• const LandmarkIds OFIQ_LIB::modules::landmarks::adnet::contour {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22
Landmark indices (ADNet) of the face contour.
• const LandmarkIds OFIQ_LIB::modules::landmarks::adnet::forehead {}
Landmark indices (ADNet) of the forehead (empty for ADNet).
• const LandmarkIds OFIQ_LIB::modules::landmarks::adnet::chin {16}
Landmark index (ADNet) of the chin.
• const landmarks::FaceMap OFIQ_LIB::modules::landmarks::adnet::FaceMap
ADNets face map definition.
• const LandmarkIdPairs OFIQ_LIB::modules::landmarks::adnet::pairsLeftEye
Pair indices of landmarks (ADNet) for the left eye.
• const LandmarkIdPairs OFIQ_LIB::modules::landmarks::adnet::pairsRightEye
Landmark index pairs (ADNet) of landmarks for the right eye.
• const LandmarkIdPairs OFIQ_LIB::modules::landmarks::adnet::pairsInnerLip
Landmark index pairs (ADNet) of inner lip pairs.
• const LandmarkIdPairs OFIQ_LIB::modules::landmarks::adnet::pairsMouthCenter
Landmark index pair (ADNet) of the inner mouth (lips) center.
• const landmarks::FacePairMap OFIQ_LIB::modules::landmarks::adnet::FacePairMap
ADNets face pair map definition.

Generated by Doxygen
8.16 adnet_FaceMap.h 219

8.15.1 Detailed Description

Provides definitions of landmark indices to access specific parts of ADNet landmarks.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

The definitions provided by this header were taken from https://arxiv.org/pdf/2109.05721.pdf

Appendix A, Figure 6.

Author

OFIQ development team

8.16 adnet_FaceMap.h

Go to the documentation of this file.

00001
00033 #pragma once
00034
00035 #include "FaceParts.h"
00036 #include <array>
00037 #include <map>
00038 #include <vector>
00039
00043 namespace OFIQ_LIB::modules::landmarks::adnet
00044 {
00049 const LandmarkIds leftEye{60,61,62,63,64,65,66,67};
00050
00055 const LandmarkIds rightEye{68,69,70,71,72,73,74,75};
00056
00060 const LandmarkIds leftEyeCorners{60,64};
00061
00065 const LandmarkIds rightEyeCorners{68,72};
00066
00070 const LandmarkIds nosetip{54};
00071
00075 const LandmarkIds mouthOuter{76,77,78,79,80,81,82,83,84,85,86,87};
00076
00080 const LandmarkIds mouthInner{88,89,90,91,92,93,94,95};
00081
00085 const LandmarkIds
contour{0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32};
00086
00090 const LandmarkIds forehead{};
00091
00095 const LandmarkIds chin{16};
00096
00100 const landmarks::FaceMap FaceMap{

Generated by Doxygen
220 File Documentation

00101 {FaceParts::LEFT_EYE, leftEye },

00102 {FaceParts::RIGHT_EYE, rightEye },
00103 {FaceParts::LEFT_EYE_CORNERS, leftEyeCorners},
00104 {FaceParts::RIGHT_EYE_CORNERS, rightEyeCorners},
00105 {FaceParts::MOUTH_OUTER, mouthOuter },
00106 {FaceParts::MOUTH_INNER, mouthInner },
00107 {FaceParts::FACE_CONTOUR, contour },
00108 {FaceParts::CHIN, chin },
00109 {FaceParts::NOSETIP, nosetip },
00110 {FaceParts::FOREHEAD, forehead }
00111 };
00112
00117 const LandmarkIdPairs pairsLeftEye{
00118 {61, 67},
00119 {62, 66},
00120 {63, 65}
00121 };
00122
00127 const LandmarkIdPairs pairsRightEye{
00128 {69, 75},
00129 {70, 74},
00130 {71, 73}
00131 };
00132
00137 const LandmarkIdPairs pairsInnerLip{
00138 {89, 95},
00139 {90, 94},
00140 {91, 93}
00141 };
00142
00147 const LandmarkIdPairs pairsMouthCenter{
00148 {90, 94}
00149 };
00150
00154 const landmarks::FacePairMap FacePairMap{
00155 {FaceParts::LEFT_EYE, pairsLeftEye },
00156 {FaceParts::RIGHT_EYE, pairsRightEye },
00157 {FaceParts::MOUTH_INNER, pairsInnerLip },
00158 {FaceParts::MOUTH_CENTER, pairsMouthCenter}
00159 };
00160 }

8.17 adnet_landmarks.h File Reference

Provides the ADNetFaceLandmarkExtractor class.

#include <memory>
#include "Configuration.h"
#include "detectors.h"
#include "landmarks.h"

Classes

• class OFIQ_LIB::modules::landmarks::ADNetFaceLandmarkExtractor
Class implementing the FaceLandmarkExtractorInterface interface.

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::landmarks
Provides implementations of a landmark extractors.

Generated by Doxygen
8.18 adnet_landmarks.h 221

8.17.1 Detailed Description

Provides the ADNetFaceLandmarkExtractor class.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.18 adnet_landmarks.h

Go to the documentation of this file.

00001
00028 #pragma once
00029
00030 #include <memory>
00031 #include "Configuration.h"
00032 #include "detectors.h"
00033 #include "landmarks.h"
00034
00038 namespace OFIQ_LIB::modules::landmarks
00039 {
00040
00042 class ADNetFaceLandmarkExtractorImpl;
00043
00049 class ADNetFaceLandmarkExtractor : public FaceLandmarkExtractorInterface
00050 {
00051 public:
00056 explicit ADNetFaceLandmarkExtractor(const Configuration& config);
00057
00061 ~ADNetFaceLandmarkExtractor() override;
00062
00063 protected:
00071 OFIQ::FaceLandmarks updateLandmarks(OFIQ_LIB::Session& session) override;
00072
00073 private:
00074
00078 std::unique_ptr<ADNetFaceLandmarkExtractorImpl> landmarkExtractor_;
00079 };
00080 }

8.19 AllLandmarks.h File Reference

Provides the include statements to all classes derived from FaceLandmarkExtractorInterface.

#include "adnet_landmarks.h"

Generated by Doxygen
222 File Documentation

8.19.1 Detailed Description

Provides the include statements to all classes derived from FaceLandmarkExtractorInterface.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.20 AllLandmarks.h

Go to the documentation of this file.

00001
00029 #include "adnet_landmarks.h"

8.21 FaceMeasures.h File Reference

Provides a class implementing two luminance measures.

#include "ofiq_lib.h"
#include "PartExtractor.h"
#include <opencv2/opencv.hpp>

Classes

• class OFIQ_LIB::modules::landmarks::FaceMeasures
Provides static functions doing computations with landmarks.

Generated by Doxygen
8.22 FaceMeasures.h 223

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::landmarks
Provides implementations of a landmark extractors.

8.21.1 Detailed Description

Provides a class implementing two luminance measures.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.22 FaceMeasures.h

Go to the documentation of this file.

00001
00027 #pragma once
00028
00029 #include "ofiq_lib.h"
00030 #include "PartExtractor.h"
00031 #include <opencv2/opencv.hpp>
00032
00036 namespace OFIQ_LIB::modules::landmarks
00037 {
00041 class FaceMeasures
00042 {
00043 public:
00047 FaceMeasures() = delete;
00048
00066 static double InterEyeDistance(const OFIQ::FaceLandmarks& faceLandmarks, double yaw);
00067
00078 static cv::Mat GetFaceMask
00079 (const OFIQ::FaceLandmarks& faceLandmarks, const int height, const int width,
00080 const float alpha = 0);
00081
00088 static double GetDistance(const OFIQ::LandmarkPoint& a, const OFIQ::LandmarkPoint& b);
00089

Generated by Doxygen
224 File Documentation

00096 static double GetDistance(const LandmarkPair& pair)

00097 {
00098 return GetDistance(pair.Lower, pair.Upper);
00099 }
00100
00106 static OFIQ::LandmarkPoint GetMiddle(const OFIQ::Landmarks& landmarks);
00107
00113 static OFIQ::LandmarkPoint GetMiddle(const LandmarkPair& pair)
00114 {
00115 return GetMiddle(OFIQ::Landmarks{pair.Lower, pair.Upper});
00116 }
00117
00125 static OFIQ::LandmarkPoint GetMiddle(const std::vector<LandmarkPair>& pairs)
00126 {
00127 std::vector<OFIQ::LandmarkPoint> points;
00128 for (auto pair : pairs)
00129 {
00130 points.push_back(GetMiddle(pair));
00131 }
00132 return GetMiddle(points);
00133 }
00134
00147 static double GetMaxPairDistance(
00148 const OFIQ::FaceLandmarks& landmarks,
00149 landmarks::FaceParts facePart);
00150 };
00151 }

8.23 FaceParts.h File Reference

PRovides several helper classes, enums and functions used in the OFIQ framework.

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::landmarks
Provides implementations of a landmark extractors.

Typedefs

• using OFIQ_LIB::modules::landmarks::LandmarkId = int

Type definition of a landmark index.
• using OFIQ_LIB::modules::landmarks::LandmarkIds = std::vector<LandmarkId>
Type definition of a list of landmark indices.
• using OFIQ_LIB::modules::landmarks::FaceMap = std::map<FaceParts, LandmarkIds>
Type definition of a face map to access landmark indices for a queried face part.
• using OFIQ_LIB::modules::landmarks::LandmarkIdPair = std::array<LandmarkId, 2>
Type definition for a pair of landmark index.
• using OFIQ_LIB::modules::landmarks::LandmarkIdPairs = std::vector<LandmarkIdPair>
Type definition for a list of landmark index pairs.
• using OFIQ_LIB::modules::landmarks::FacePairMap = std::map<FaceParts, LandmarkIdPairs>
Structure defining pairs of landmark indices.

Generated by Doxygen
8.24 FaceParts.h 225

Enumerations

• enum class OFIQ_LIB::modules::landmarks::FaceParts {

OFIQ_LIB::modules::landmarks::LEFT_EYE , OFIQ_LIB::modules::landmarks::RIGHT_EYE , OFIQ_LIB::modules::landmarks::
, OFIQ_LIB::modules::landmarks::RIGHT_EYE_CORNERS ,
OFIQ_LIB::modules::landmarks::MOUTH_OUTER , OFIQ_LIB::modules::landmarks::MOUTH_INNER ,
OFIQ_LIB::modules::landmarks::FACE_CONTOUR , OFIQ_LIB::modules::landmarks::MOUTH_CENTER
,
OFIQ_LIB::modules::landmarks::CHIN , OFIQ_LIB::modules::landmarks::NOSETIP , OFIQ_LIB::modules::landmarks::FOREHE
}
Enumeration of facial landmark parts.

8.23.1 Detailed Description

PRovides several helper classes, enums and functions used in the OFIQ framework.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.24 FaceParts.h

Go to the documentation of this file.

00001
00028 #pragma once
00029
00033 namespace OFIQ_LIB::modules::landmarks
00034 {
00038 enum class FaceParts
00039 {
00041 LEFT_EYE,
00043 RIGHT_EYE,
00045 LEFT_EYE_CORNERS,
00047 RIGHT_EYE_CORNERS,
00049 MOUTH_OUTER,
00051 MOUTH_INNER,
00053 FACE_CONTOUR,
00055 MOUTH_CENTER,
00057 CHIN,

Generated by Doxygen
226 File Documentation

00059 NOSETIP,
00061 FOREHEAD
00062 };
00063
00067 using LandmarkId = int;
00068
00072 using LandmarkIds = std::vector<LandmarkId>;
00073
00078 using FaceMap = std::map<FaceParts, LandmarkIds>;
00079
00083 using LandmarkIdPair = std::array<LandmarkId, 2>;
00084
00088 using LandmarkIdPairs = std::vector<LandmarkIdPair>;
00089
00093 using FacePairMap = std::map<FaceParts, LandmarkIdPairs>;
00094 }

8.25 landmarks.h File Reference

Provides the base class for the implementation of face landmark extractors.

#include "ofiq_lib.h"
#include "Session.h"

Classes

• class OFIQ_LIB::FaceLandmarkExtractorInterface
Implements the base class for the face landmark extractors.

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.

8.25.1 Detailed Description

Provides the base class for the implementation of face landmark extractors.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

Generated by Doxygen
8.26 landmarks.h 227

8.26 landmarks.h

Go to the documentation of this file.

00001
00027 #pragma once
00028
00029 #include "ofiq_lib.h"
00030 #include "Session.h"
00031
00035 namespace OFIQ_LIB
00036 {
00041 class FaceLandmarkExtractorInterface
00042 {
00043 public:
00048 virtual ~FaceLandmarkExtractorInterface() = default;
00049
00056 OFIQ::FaceLandmarks extractLandmarks(OFIQ_LIB::Session& session);
00057
00058 protected:
00065 virtual OFIQ::FaceLandmarks updateLandmarks(OFIQ_LIB::Session& session) = 0;
00066 };
00067 }

8.27 PartExtractor.h File Reference

Provides helper class for face landmark handling.

#include "ofiq_lib.h"
#include "FaceParts.h"

Classes

• struct OFIQ_LIB::modules::landmarks::LandmarkPair
Data container for storing pairs of landmarks.
• class OFIQ_LIB::modules::landmarks::PartExtractor
Class that provides helper methods for the administration of landmarks.

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::landmarks
Provides implementations of a landmark extractors.

8.27.1 Detailed Description

Provides helper class for face landmark handling.

Generated by Doxygen
228 File Documentation

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.28 PartExtractor.h

Go to the documentation of this file.

00001
00027 #pragma once
00028
00029 #include "ofiq_lib.h"
00030 #include "FaceParts.h"
00031
00035 namespace OFIQ_LIB::modules::landmarks
00036 {
00037
00042 enum class FaceParts;
00043
00048 struct LandmarkPair
00049 {
00054 OFIQ::LandmarkPoint Upper;
00055
00060 OFIQ::LandmarkPoint Lower;
00061
00068 LandmarkPair(OFIQ::LandmarkPoint upper, OFIQ::LandmarkPoint lower) : Upper{upper},
Lower{lower}
00069 {
00070 }
00071 };
00072
00077 class PartExtractor
00078 {
00079 public:
00088 static OFIQ::Landmarks getFacePart(const OFIQ::FaceLandmarks& faceLandmarks, FaceParts part);
00089
00098 static std::vector<LandmarkPair> getPairsForPart(const OFIQ::FaceLandmarks& faceLandmarks,
FaceParts part);
00099 };
00100 }

8.29 AllMeasures.h File Reference

Provides all classes derived from the OFIQ_LIB::modules::measures::Measure class.

Generated by Doxygen
8.29 AllMeasures.h File Reference 229

#include "BackgroundUniformity.h"
#include "CompressionArtifacts.h"
#include "CropOfTheFaceImage.h"
#include "DynamicRange.h"
#include "ExpressionNeutrality.h"
#include "EyesOpen.h"
#include "EyesVisible.h"
#include "FaceOcclusionPrevention.h"
#include "FaceOcclusionSegmentation.h"
#include "FaceParsing.h"
#include "HeadPose.h"
#include "HeadSize.h"
#include "IlluminationUniformity.h"
#include "InterEyeDistance.h"
#include "Luminance.h"
#include "MouthClosed.h"
#include "MouthOcclusionPrevention.h"
#include "NaturalColour.h"
#include "NoHeadCoverings.h"
#include "OverExposurePrevention.h"
#include "Sharpness.h"
#include "SingleFacePresent.h"
#include "UnderExposurePrevention.h"
#include "UnifiedQualityScore.h"

8.29.1 Detailed Description

Provides all classes derived from the OFIQ_LIB::modules::measures::Measure class.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

Generated by Doxygen
230 File Documentation

8.30 AllMeasures.h

Go to the documentation of this file.

00001
00029 #include "BackgroundUniformity.h"
00030 #include "CompressionArtifacts.h"
00031 #include "CropOfTheFaceImage.h"
00032 #include "DynamicRange.h"
00033 #include "ExpressionNeutrality.h"
00034 #include "EyesOpen.h"
00035 #include "EyesVisible.h"
00036 #include "FaceOcclusionPrevention.h"
00037 #include "FaceOcclusionSegmentation.h"
00038 #include "FaceParsing.h"
00039 #include "HeadPose.h"
00040 #include "HeadSize.h"
00041 #include "IlluminationUniformity.h"
00042 #include "InterEyeDistance.h"
00043 #include "Luminance.h"
00044 #include "MouthClosed.h"
00045 #include "MouthOcclusionPrevention.h"
00046 #include "NaturalColour.h"
00047 #include "NoHeadCoverings.h"
00048 #include "OverExposurePrevention.h"
00049 #include "Sharpness.h"
00050 #include "SingleFacePresent.h"
00051 #include "UnderExposurePrevention.h"
00052 #include "UnifiedQualityScore.h"

8.31 BackgroundUniformity.h File Reference

Provides a class implementing the background uniformity measure.

#include "Measure.h"

Classes

• class OFIQ_LIB::modules::measures::BackgroundUniformity
Implementation of the background uniformity measure.

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::measures
Provides measures implemented in OFIQ.

8.31.1 Detailed Description

Provides a class implementing the background uniformity measure.

Generated by Doxygen
8.32 BackgroundUniformity.h 231

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.32 BackgroundUniformity.h

Go to the documentation of this file.

00001
00028 #pragma once
00029
00030 #include "Measure.h"
00031
00035 namespace OFIQ_LIB::modules::measures
00036 {
00043 class BackgroundUniformity : public Measure
00044 {
00045 public:
00050 explicit BackgroundUniformity(
00051 const Configuration& configuration);
00052
00060 void Execute(OFIQ_LIB::Session & session) override;
00061
00062 private:
00067 uint16_t m_targetHeight = 292;
00068
00073 uint16_t m_targetWidth = 354;
00074
00080 uint16_t m_cropLeft = 62;
00081
00087 uint16_t m_cropRight = 62;
00088
00094 uint16_t m_cropTop = 0;
00095
00101 uint16_t m_cropBottom = 210;
00102
00109 uint16_t m_erosionKernelSize = 4;
00110 };
00111 }

8.33 CompressionArtifacts.h File Reference

Provides a class implemtenting the no compression artifact measure.

#include "landmarks.h"
#include "Measure.h"
#include <ONNXRTSegmentation.h>

Generated by Doxygen
232 File Documentation

Classes
• class OFIQ_LIB::modules::measures::CompressionArtifacts
Implementation of the no compression artifacts measure.

Namespaces
• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::measures
Provides measures implemented in OFIQ.

8.33.1 Detailed Description

Provides a class implemtenting the no compression artifact measure.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.34 CompressionArtifacts.h

Go to the documentation of this file.

00001
00028 #pragma once
00029
00030 #include "landmarks.h"
00031 #include "Measure.h"
00032 #include <ONNXRTSegmentation.h>
00033
00037 namespace OFIQ_LIB::modules::measures
00038 {
00045 class CompressionArtifacts : public Measure
00046 {
00047 public:
00068 explicit CompressionArtifacts(const Configuration& configuration);
00069
00078 void Execute(OFIQ_LIB::Session& session) override;
00079
00080 private:
00087 int m_crop;
00088
00096 int m_dim;
00097
00101 ONNXRuntimeSegmentation m_onnxRuntimeEnv;
00102 };
00103 }

Generated by Doxygen
8.35 CropOfTheFaceImage.h File Reference 233

8.35 CropOfTheFaceImage.h File Reference

Provides a class implementing the crop of the face image measure.

#include "landmarks.h"
#include "Measure.h"

Classes

• class OFIQ_LIB::modules::measures::CropOfTheFaceImage
Implementation of the crop of the face image measure.

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::measures
Provides measures implemented in OFIQ.

8.35.1 Detailed Description

Provides a class implementing the crop of the face image measure.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ devlopment team

Generated by Doxygen
234 File Documentation

8.36 CropOfTheFaceImage.h

Go to the documentation of this file.

00001
00027 #pragma once
00028
00029 #include "landmarks.h"
00030 #include "Measure.h"
00031
00035 namespace OFIQ_LIB::modules::measures
00036 {
00042 class CropOfTheFaceImage : public Measure
00043 {
00044 public:
00049 explicit CropOfTheFaceImage(const Configuration& configuration);
00050
00057 void Execute(OFIQ_LIB::Session & session) override;
00058 };
00059 }

8.37 DynamicRange.h File Reference

Provides a class implemtenting the dynamic range measure.

#include "landmarks.h"
#include "Measure.h"

Classes

• class OFIQ_LIB::modules::measures::DynamicRange
Implementation of the dynamic range measure.

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::measures
Provides measures implemented in OFIQ.

8.37.1 Detailed Description

Provides a class implemtenting the dynamic range measure.

Generated by Doxygen
8.38 DynamicRange.h 235

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.38 DynamicRange.h

Go to the documentation of this file.

00001
00028 #pragma once
00029
00030 #include "landmarks.h"
00031 #include "Measure.h"
00032
00036 namespace OFIQ_LIB::modules::measures
00037 {
00043 class DynamicRange : public Measure
00044 {
00045 public:
00050 explicit DynamicRange(
00051 const Configuration& configuration);
00052
00058 void Execute(OFIQ_LIB::Session & session) override;
00059 };
00060 }

8.39 Executor.h File Reference

This class takes care of the computation of the measures activated.

#include "Measure.h"

Classes

• class OFIQ_LIB::modules::measures::Executor
This class takes care of the computation of the measures activated.

Generated by Doxygen
236 File Documentation

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::measures
Provides measures implemented in OFIQ.

Functions

• void OFIQ_LIB::modules::measures::log (const std::string_view &msg)

Logging function for writing debug messages to std::cout.

Variables

• static const bool OFIQ_LIB::modules::measures::ExecutorLogActive = false

This variable enables logging to std::cout for debug purposes. By default the logging is switched off.

8.39.1 Detailed Description

This class takes care of the computation of the measures activated.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

Generated by Doxygen
8.40 Executor.h 237

8.40 Executor.h

Go to the documentation of this file.

00001
00027 #pragma once
00028
00029 #include "Measure.h"
00030
00034 namespace OFIQ_LIB::modules::measures
00035 {
00039 const static bool ExecutorLogActive = false;
00040
00046 void log(const std::string_view& msg);
00047
00051 class Executor
00052 {
00053 public:
00059 explicit Executor(std::vector<std::unique_ptr<Measure» measures)
00060 : m_measures{std::move(measures)}
00061 {
00062 }
00063
00069 void ExecuteAll(Session & i_currentSession) const;
00070
00075 const std::vector<std::unique_ptr<Measure»& GetMeasures() const { return m_measures; }
00076
00077 private:
00082 std::vector<std::unique_ptr<Measure» m_measures;
00083 };
00084 }

8.41 ExpressionNeutrality.h File Reference

Provides a class implementing the expression neutrality measure.

#include "landmarks.h"
#include "Measure.h"
#include <ONNXRTSegmentation.h>

Classes

• class OFIQ_LIB::modules::measures::ExpressionNeutrality
Provides a class implementing the expression neutrality measure.

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::measures
Provides measures implemented in OFIQ.

Generated by Doxygen
238 File Documentation

8.41.1 Detailed Description

Provides a class implementing the expression neutrality measure.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.42 ExpressionNeutrality.h

Go to the documentation of this file.

00001
00028 #pragma once
00029
00030 #include "landmarks.h"
00031 #include "Measure.h"
00032 #include <ONNXRTSegmentation.h>
00033
00037 namespace OFIQ_LIB::modules::measures
00038 {
00047 class ExpressionNeutrality : public Measure
00048 {
00049 public:
00054 explicit ExpressionNeutrality(
00055 const Configuration& configuration);
00056
00062 void Execute(OFIQ_LIB::Session& session) override;
00063
00064 private:
00069 ONNXRuntimeSegmentation m_onnxRuntimeEnvCNN1;
00070
00075 ONNXRuntimeSegmentation m_onnxRuntimeEnvCNN2;
00076
00081 std::shared_ptr<cv::ml::Boost> m_classifier;
00082 };
00083 }

8.43 EyesOpen.h File Reference

Provides a class implementing the eyes open measure.

#include "landmarks.h"
#include "Measure.h"

Generated by Doxygen
8.44 EyesOpen.h 239

Classes

• class OFIQ_LIB::modules::measures::EyesOpen
Implementation of the eyes open measure.

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::measures
Provides measures implemented in OFIQ.

8.43.1 Detailed Description

Provides a class implementing the eyes open measure.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.44 EyesOpen.h

Go to the documentation of this file.

00001
00028 #pragma once
00029
00030 #include "landmarks.h"
00031 #include "Measure.h"
00032
00036 namespace OFIQ_LIB::modules::measures
00037 {
00043 class EyesOpen : public Measure
00044 {
00045 public:
00050 explicit EyesOpen(const Configuration& configuration);
00051
00060 void Execute(OFIQ_LIB::Session & session) override;
00061 };
00062 }

Generated by Doxygen
240 File Documentation

8.45 EyesVisible.h File Reference

Provides a class implementing the eyes visible measure.

#include "landmarks.h"
#include "Measure.h"

Classes

• class OFIQ_LIB::modules::measures::EyesVisible
Implementation of the eyes visible measure.

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::measures
Provides measures implemented in OFIQ.

8.45.1 Detailed Description

Provides a class implementing the eyes visible measure.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

Generated by Doxygen
8.46 EyesVisible.h 241

8.46 EyesVisible.h

Go to the documentation of this file.

00001
00027 #pragma once
00028
00029 #include "landmarks.h"
00030 #include "Measure.h"
00031
00035 namespace OFIQ_LIB::modules::measures
00036 {
00043 class EyesVisible : public Measure
00044 {
00045 public:
00050 explicit EyesVisible(const Configuration& configuration);
00051
00061 void Execute(OFIQ_LIB::Session & session) override;
00062 };
00063 }

8.47 FaceOcclusionPrevention.h File Reference

Provides a class implementing the face occlusion prevention measure.

#include "landmarks.h"
#include "Measure.h"
#include <ONNXRTSegmentation.h>

Classes

• class OFIQ_LIB::modules::measures::FaceOcclusionPrevention
Implementation of the face occlusion prevention measure.

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::measures
Provides measures implemented in OFIQ.

8.47.1 Detailed Description

Provides a class implementing the face occlusion prevention measure.

Generated by Doxygen
242 File Documentation

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.48 FaceOcclusionPrevention.h

Go to the documentation of this file.

00001
00027 #pragma once
00028
00029 #include "landmarks.h"
00030 #include "Measure.h"
00031 #include <ONNXRTSegmentation.h>
00032
00036 namespace OFIQ_LIB::modules::measures
00037 {
00044 class FaceOcclusionPrevention : public Measure
00045 {
00046 public:
00051 explicit FaceOcclusionPrevention(
00052 const Configuration& configuration);
00053
00064 void Execute(OFIQ_LIB::Session & session) override;
00065 };
00066 }

8.49 HeadPose.h File Reference

Provides a class implementing head pose measures.

#include "Measure.h"

Classes

• class OFIQ_LIB::modules::measures::HeadPose
Implementation of head pose measures.

Generated by Doxygen
8.50 HeadPose.h 243

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::measures
Provides measures implemented in OFIQ.

8.49.1 Detailed Description

Provides a class implementing head pose measures.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.50 HeadPose.h

Go to the documentation of this file.

00001
00027 #pragma once
00028
00029 #include "Measure.h"
00030
00034 namespace OFIQ_LIB::modules::measures
00035 {
00040 class HeadPose : public Measure
00041 {
00042 public:
00047 explicit HeadPose(
00048 const Configuration& configuration);
00049
00057 void Execute(OFIQ_LIB::Session & session) override;
00058 };
00059 }

Generated by Doxygen
244 File Documentation

8.51 HeadSize.h File Reference

Provides a class implementing the head size measure.

#include "landmarks.h"
#include "Measure.h"

Classes

• class OFIQ_LIB::modules::measures::HeadSize
Implementation of the head size measure.

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::measures
Provides measures implemented in OFIQ.

8.51.1 Detailed Description

Provides a class implementing the head size measure.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

Generated by Doxygen
8.52 HeadSize.h 245

8.52 HeadSize.h

Go to the documentation of this file.

00001
00027 #pragma once
00028
00029 #include "landmarks.h"
00030 #include "Measure.h"
00031
00035 namespace OFIQ_LIB::modules::measures
00036 {
00042 class HeadSize : public Measure
00043 {
00044 public:
00049 explicit HeadSize(
00050 const Configuration& configuration);
00051
00057 void Execute(OFIQ_LIB::Session & session) override;
00058 };
00059 }

8.53 IlluminationUniformity.h File Reference

Provides a class implementing the illumination uniformity measure.

#include "landmarks.h"
#include "Measure.h"

Classes

• class OFIQ_LIB::modules::measures::IlluminationUniformity
Implementation of the illumination uniformity measure.

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::measures
Provides measures implemented in OFIQ.

8.53.1 Detailed Description

Provides a class implementing the illumination uniformity measure.

Generated by Doxygen
246 File Documentation

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.54 IlluminationUniformity.h

Go to the documentation of this file.

00001
00028 #pragma once
00029
00030 #include "landmarks.h"
00031 #include "Measure.h"
00032
00036 namespace OFIQ_LIB::modules::measures
00037 {
00044 class IlluminationUniformity : public Measure
00045 {
00046 public:
00051 explicit IlluminationUniformity(const Configuration& configuration);
00052
00061 void Execute(OFIQ_LIB::Session & session) override;
00062 };
00063 }

8.55 InterEyeDistance.h File Reference

Provides a class implementing the inter-eye distance measure.

#include "landmarks.h"
#include "Measure.h"

Classes

• class OFIQ_LIB::modules::measures::InterEyeDistance
Implementation of the inter-eye distance measure.

Generated by Doxygen
8.56 InterEyeDistance.h 247

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::measures
Provides measures implemented in OFIQ.

8.55.1 Detailed Description

Provides a class implementing the inter-eye distance measure.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.56 InterEyeDistance.h

Go to the documentation of this file.

00001
00027 #pragma once
00028
00029 #include "landmarks.h"
00030 #include "Measure.h"
00031
00035 namespace OFIQ_LIB::modules::measures
00036 {
00043 class InterEyeDistance : public Measure
00044 {
00045 public:
00050 explicit InterEyeDistance(const Configuration& configuration);
00051
00060 void Execute(OFIQ_LIB::Session & session) override;
00061 };
00062 }

Generated by Doxygen
248 File Documentation

8.57 Luminance.h File Reference

Provides a class implementing two luminance measures.

#include "landmarks.h"
#include "Measure.h"

Classes

• class OFIQ_LIB::modules::measures::Luminance
Implementation of two luminance measures.

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::measures
Provides measures implemented in OFIQ.

8.57.1 Detailed Description

Provides a class implementing two luminance measures.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

Generated by Doxygen
8.58 Luminance.h 249

8.58 Luminance.h

Go to the documentation of this file.

00001
00027 #pragma once
00028
00029 #include "landmarks.h"
00030 #include "Measure.h"
00031
00035 namespace OFIQ_LIB::modules::measures
00036 {
00042 class Luminance : public Measure
00043 {
00044 public:
00049 explicit Luminance(const Configuration& configuration);
00050
00058 void Execute(OFIQ_LIB::Session & session) override;
00059 };
00060 }

8.59 Measure.h File Reference

Provides the base class for all measures implemented in OFIQ.

#include "Configuration.h"
#include "ofiq_lib.h"
#include "Session.h"
#include <math.h>

Classes

• struct OFIQ_LIB::modules::measures::SigmoidParameters
Parameters of the sigmoid function based quality mapping.
• class OFIQ_LIB::modules::measures::Measure
Base class for measures implemented in OFIQ.

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::measures
Provides measures implemented in OFIQ.

8.59.1 Detailed Description

Provides the base class for all measures implemented in OFIQ.

Generated by Doxygen
250 File Documentation

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.60 Measure.h

Go to the documentation of this file.

00001
00027 #pragma once
00028
00029 #include "Configuration.h"
00030 #include "ofiq_lib.h"
00031 #include "Session.h"
00032 #ifndef _WIN32
00033 # include <math.h>
00034 #endif
00035
00039 namespace OFIQ_LIB::modules::measures
00040 {
00056 struct SigmoidParameters
00057 {
00063 SigmoidParameters() { Reset(); }
00064
00069 double h;
00070
00075 double a;
00076
00081 double s;
00082
00088 double x0;
00089
00095 double w;
00096
00102 bool round;
00103
00112 void setInverse()
00113 {
00114 a = 1;
00115 s = -1;
00116 }
00117
00121 void Reset()
00122 {
00123 h = 100;
00124 a = 0;
00125 s = 1;
00126 x0 = 4;
00127 w = 0.7;
00128 round = true;
00129 }
00130 };
00131

Generated by Doxygen
8.61 MeasureFactory.h File Reference 251

00135 class Measure

00136 {
00137 public:
00146 Measure(const Configuration& configuration,
00147 OFIQ::QualityMeasure measure)
00148 : configuration{configuration}, m_measure(measure)
00149 {
00150 }
00151
00161 virtual void Execute(OFIQ_LIB::Session& session) = 0;
00162
00166 virtual ~Measure() = default;
00167
00175 virtual std::string GetName() const;
00176
00181 virtual OFIQ::QualityMeasure GetQualityMeasure() const;
00182
00196 void SetQualityMeasure(OFIQ_LIB::Session& session, OFIQ::QualityMeasure measure, double
rawValue, OFIQ::QualityMeasureReturnCode code);
00197
00198 protected:
00206 static double Sigmoid(double x, double x0, double w)
00207 {
00208 return 1.0 / (1 + exp((x0 - x) / w));
00209 }
00210
00223 void AddSigmoid(OFIQ::QualityMeasure measure, const SigmoidParameters& defaultValues);
00224
00237 void AddSigmoid(const std::string& key, SigmoidParameters defaultValues);
00238
00246 double ExecuteScalarConversion(OFIQ::QualityMeasure measure, double rawValue);
00247
00255 double ExecuteScalarConversion(const std::string& key, double rawValue);
00256
00261 const Configuration& configuration;
00262
00263 private:
00274 static double ScalarConversion(double rawValue, const SigmoidParameters& par)
00275 {
00276 double scalarScore = par.h * (par.a + par.s * Sigmoid(rawValue, par.x0, par.w));
00277 if (par.round)
00278 scalarScore = round(scalarScore);
00279 if (scalarScore < 0.0)
00280 {
00281 scalarScore = 0.0;
00282 }
00283 else if (scalarScore > 100.0)
00284 {
00285 scalarScore = 100.0;
00286 }
00287 return scalarScore;
00288 }
00289
00294 std::map<std::string, SigmoidParameters, std::less<» m_sigmoidMap;
00295
00301 static std::string GetMeasureName(OFIQ::QualityMeasure measure);
00302
00310 static std::string ExpandKey(std::string_view rawKey);
00311
00317 OFIQ::QualityMeasure m_measure = OFIQ::QualityMeasure::NotSet;
00318 };
00319 }

8.61 MeasureFactory.h File Reference

Provides a class for requesting creation of measure implementations.

#include "Configuration.h"
#include "ofiq_lib.h"
#include "Measure.h"
#include "Session.h"

Classes

• class OFIQ_LIB::modules::measures::MeasureFactory
Measure factor class.

Generated by Doxygen
252 File Documentation

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::measures
Provides measures implemented in OFIQ.

8.61.1 Detailed Description

Provides a class for requesting creation of measure implementations.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.62 MeasureFactory.h

Go to the documentation of this file.

00001
00028 #pragma once
00029
00030 #include "Configuration.h"
00031 #include "ofiq_lib.h"
00032 #include "Measure.h"
00033 #include "Session.h"
00034
00038 namespace OFIQ_LIB::modules::measures
00039 {
00043 class MeasureFactory
00044 {
00045 public:
00046 // Avoids instantiation from this class
00047 MeasureFactory() = delete;
00048
00059 static std::unique_ptr<Measure> CreateMeasure(
00060 const OFIQ::QualityMeasure measure,
00061 const Configuration& configuration);
00062 };
00063 }

Generated by Doxygen
8.63 MouthClosed.h File Reference 253

8.63 MouthClosed.h File Reference

Provides a class implementing the mouth closed measure.

#include "landmarks.h"
#include "Measure.h"

Classes

• class OFIQ_LIB::modules::measures::MouthClosed
Implementation of the mouth closed measure.

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::measures
Provides measures implemented in OFIQ.

8.63.1 Detailed Description

Provides a class implementing the mouth closed measure.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

Generated by Doxygen
254 File Documentation

8.64 MouthClosed.h

Go to the documentation of this file.

00001
00027 #pragma once
00028
00029 #include "landmarks.h"
00030 #include "Measure.h"
00031
00035 namespace OFIQ_LIB::modules::measures
00036 {
00042 class MouthClosed : public Measure
00043 {
00044 public:
00049 explicit MouthClosed(const Configuration& configuration);
00050
00059 void Execute(OFIQ_LIB::Session& session) override;
00060 };
00061 }

8.65 MouthOcclusionPrevention.h File Reference

Provides a class implementing the mouth occlusion prevention measure.

#include "Measure.h"

Classes

• class OFIQ_LIB::modules::measures::MouthOcclusionPrevention
Implementation of the mouth occlusion prevention measure.

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::measures
Provides measures implemented in OFIQ.

8.65.1 Detailed Description

Provides a class implementing the mouth occlusion prevention measure.

Generated by Doxygen
8.66 MouthOcclusionPrevention.h 255

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.66 MouthOcclusionPrevention.h

Go to the documentation of this file.

00001
00027 #pragma once
00028
00029 #include "Measure.h"
00030
00034 namespace OFIQ_LIB::modules::measures
00035 {
00042 class MouthOcclusionPrevention : public Measure
00043 {
00044 public:
00049 explicit MouthOcclusionPrevention(const Configuration& configuration);
00050
00062 void Execute(OFIQ_LIB::Session & session) override;
00063 };
00064 }

8.67 NaturalColour.h File Reference

Provides a class implementing the natural colour measure.

#include "landmarks.h"
#include "Measure.h"

Classes

• class OFIQ_LIB::modules::measures::NaturalColour
Implementation of the natural colour measure.

Generated by Doxygen
256 File Documentation

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::measures
Provides measures implemented in OFIQ.

8.67.1 Detailed Description

Provides a class implementing the natural colour measure.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.68 NaturalColour.h

Go to the documentation of this file.

00001
00027 #pragma once
00028
00029 #include "landmarks.h"
00030 #include "Measure.h"
00031
00035 namespace OFIQ_LIB::modules::measures
00036 {
00043 class NaturalColour : public Measure
00044 {
00045 public:
00050 explicit NaturalColour(const Configuration& configuration);
00051
00060 void Execute(OFIQ_LIB::Session & session) override;
00061
00062 private:
00069 cv::Mat CreateMaskedImage(const OFIQ::FaceLandmarks& landmarks, const cv::Mat& cvImage) const;
00070
00081 cv::Mat ReduceImageToRegionOfInterest(
00082 const cv::Mat& maskedImage,
00083 const cv::Rect& leftRegionOfInterest,
00084 const cv::Rect& rightRegionOfInterest) const;
00085
00099 double CalculateScore(double meanChannelA, double meanChannelB) const;
00100 };
00101 }

Generated by Doxygen
8.69 NoHeadCoverings.h File Reference 257

8.69 NoHeadCoverings.h File Reference

Provides a class implementing the no head covering measure.

#include "Measure.h"
#include "segmentations.h"

Classes

• class OFIQ_LIB::modules::measures::NoHeadCoverings
Implementation of the no head covering measure.

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::measures
Provides measures implemented in OFIQ.

8.69.1 Detailed Description

Provides a class implementing the no head covering measure.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

Generated by Doxygen
258 File Documentation

8.70 NoHeadCoverings.h

Go to the documentation of this file.

00001
00027 #pragma once
00028
00029 #include "Measure.h"
00030 #include "segmentations.h"
00031
00035 namespace OFIQ_LIB::modules::measures
00036 {
00051 class NoHeadCoverings : public Measure
00052 {
00053 public:
00062 explicit NoHeadCoverings(const Configuration& configuration);
00063
00080 void Execute(OFIQ_LIB::Session & session) override;
00081
00082 private:
00089 double m_t0;
00090
00097 double m_t1;
00098
00105 double m_w;
00106
00113 double m_x0;
00114 };
00115 }

8.71 OverExposurePrevention.h File Reference

Provides a class implementing the background uniformity measure.

#include "Measure.h"

Classes

• class OFIQ_LIB::modules::measures::OverExposurePrevention
Implementation of the over-exposure prevention measure.

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::measures
Provides measures implemented in OFIQ.

8.71.1 Detailed Description

Provides a class implementing the background uniformity measure.

Generated by Doxygen
8.72 OverExposurePrevention.h 259

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.72 OverExposurePrevention.h

Go to the documentation of this file.

00001
00027 #pragma once
00028
00029 #include "Measure.h"
00030
00031
00035 namespace OFIQ_LIB::modules::measures
00036 {
00042 class OverExposurePrevention : public Measure
00043 {
00044 public:
00049 explicit OverExposurePrevention(const Configuration& configuration);
00050
00056 void Execute(OFIQ_LIB::Session & session) override;
00057 };
00058 }

8.73 Sharpness.h File Reference

Provides a class implementing the sharpness measure.

#include "Measure.h"

Classes

• class OFIQ_LIB::modules::measures::Sharpness
Implemantation of the sharpness measure.

Generated by Doxygen
260 File Documentation

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::measures
Provides measures implemented in OFIQ.

8.73.1 Detailed Description

Provides a class implementing the sharpness measure.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.74 Sharpness.h

Go to the documentation of this file.

00001
00027 #pragma once
00028
00029 #include "Measure.h"
00030
00034 namespace OFIQ_LIB::modules::measures
00035 {
00043 class Sharpness : public Measure
00044 {
00045 public:
00050 explicit Sharpness(const Configuration& configuration);
00051
00057 void Execute(OFIQ_LIB::Session & session) override;
00058
00059 private:
00060
00064 std::string m_modelFile;
00065
00070 std::shared_ptr<cv::ml::RTrees> m_rtree;
00071
00077 bool m_useAligned;
00078

Generated by Doxygen
8.75 SingleFacePresent.h File Reference 261

00084 double m_faceRegionAlpha;

00085
00090 int m_numTrees;
00091
00101 void GetCroppedImages(
00102 const Session& session,
00103 cv::Mat& faceCrop,
00104 cv::Mat& maskCrop,
00105 bool useAligned,
00106 float faceRegionAlpha) const;
00107
00116 cv::Mat GetClassifierFocusFeatures(const cv::Mat& image, const cv::Mat& mask, bool applyBlur)
const;
00117 };
00118 }

8.75 SingleFacePresent.h File Reference

Provides a class implementing the single face present measure.

#include "detectors.h"
#include "Measure.h"

Classes
• class OFIQ_LIB::modules::measures::SingleFacePresent
Implementation of the single face present measure.

Namespaces
• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::measures
Provides measures implemented in OFIQ.

8.75.1 Detailed Description

Provides a class implementing the single face present measure.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

Generated by Doxygen
262 File Documentation

8.76 SingleFacePresent.h

Go to the documentation of this file.

00001
00027 #pragma once
00028
00029 #include "detectors.h"
00030 #include "Measure.h"
00031
00035 namespace OFIQ_LIB::modules::measures
00036 {
00041 class SingleFacePresent : public Measure
00042 {
00043 public:
00048 explicit SingleFacePresent(const Configuration& configuration);
00049
00056 void Execute(OFIQ_LIB::Session & session) override;
00057 };
00058 }

8.77 UnderExposurePrevention.h File Reference

Provides a class implemtenting the under-exposure prevention measure.

#include "Measure.h"

Classes

• class OFIQ_LIB::modules::measures::UnderExposurePrevention
Implementation of the under-exposure prevention measure.

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::measures
Provides measures implemented in OFIQ.

8.77.1 Detailed Description

Provides a class implemtenting the under-exposure prevention measure.

Generated by Doxygen
8.78 UnderExposurePrevention.h 263

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.78 UnderExposurePrevention.h

Go to the documentation of this file.

00001
00027 #pragma once
00028
00029 #include "Measure.h"
00030
00034 namespace OFIQ_LIB::modules::measures
00035 {
00041 class UnderExposurePrevention : public Measure
00042 {
00043 public:
00048 explicit UnderExposurePrevention(const Configuration& configuration);
00049
00055 void Execute(OFIQ_LIB::Session & session) override;
00056 };
00057 }

8.79 UnifiedQualityScore.h File Reference

Provides a class implemtenting the unified quality measure.

#include "landmarks.h"
#include "Measure.h"
#include <opencv2/dnn.hpp>
#include <ONNXRTSegmentation.h>

Classes

• class OFIQ_LIB::modules::measures::UnifiedQualityScore
Implementation of the unified quality measure.

Generated by Doxygen
264 File Documentation

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::measures
Provides measures implemented in OFIQ.

8.79.1 Detailed Description

Provides a class implemtenting the unified quality measure.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.80 UnifiedQualityScore.h

Go to the documentation of this file.

00001
00027 #pragma once
00028
00029 #include "landmarks.h"
00030 #include "Measure.h"
00031 #include <opencv2/dnn.hpp>
00032 #include <ONNXRTSegmentation.h>
00033
00037 namespace OFIQ_LIB::modules::measures
00038 {
00046 class UnifiedQualityScore : public Measure
00047 {
00048 public:
00053 explicit UnifiedQualityScore(const Configuration& configuration);
00054
00064 void Execute(OFIQ_LIB::Session & session) override;
00065
00066 private:
00071 ONNXRuntimeSegmentation m_onnxRuntimeEnv;
00072 };
00073 }

Generated by Doxygen
8.81 AllPoseEstimators.h File Reference 265

8.81 AllPoseEstimators.h File Reference

#include "HeadPose3DDFAV2.h"

8.81.1 Detailed Description

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

@briefPProvides the include statements to all classes derived from PoseEstimatorInterface.

Author

OFIQ development team

8.82 AllPoseEstimators.h

Go to the documentation of this file.

00001
00029 #include "HeadPose3DDFAV2.h"

8.83 HeadPose3DDFAV2.h File Reference

Provides a class implementing a head pose estimator based on https://github.com/cleardusk/3←-

DDFA_V2.

#include "Configuration.h"
#include "poseEstimators.h"
#include <onnxruntime_cxx_api.h>
#include <opencv2/core/mat.hpp>

Generated by Doxygen
266 File Documentation

Classes

• class OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2
Implementation of a head pose estimator.

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::poseEstimators
Provides implementation of a head pose estimator.

8.83.1 Detailed Description

Provides a class implementing a head pose estimator based on https://github.com/cleardusk/3←-

DDFA_V2.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

Generated by Doxygen
8.84 HeadPose3DDFAV2.h 267

8.84 HeadPose3DDFAV2.h

Go to the documentation of this file.

00001
00027 #pragma once
00028
00029 #include "Configuration.h"
00030 #include "poseEstimators.h"
00031 #include <onnxruntime_cxx_api.h>
00032 #include <opencv2/core/mat.hpp>
00033
00038 namespace OFIQ_LIB::modules::poseEstimators
00039 {
00044 class HeadPose3DDFAV2 : public PoseEstimatorInterface
00045 {
00046 public:
00053 explicit HeadPose3DDFAV2(const Configuration& config);
00054
00058 ~HeadPose3DDFAV2() override = default;
00059
00060 protected:
00068 void updatePose(OFIQ_LIB::Session& session, EulerAngle& pose) override;
00069
00070 private:
00074 static const std::string m_paramPoseEstimatorModel;
00075
00079 Ort::Env m_ortenv;
00080
00084 std::unique_ptr<Ort::Session> m_ortSession;
00085
00089 int64_t m_expectedImageWidth = 0;
00090
00094 int64_t m_expectedImageHeight = 0;
00095
00099 int64_t m_expectedImageNumberOfChannels = 0;
00100
00104 int64_t m_numberOfInputElements = 0;
00105
00109 std::array<int64_t, 4> m_inputShape;
00110
00118 cv::Mat CropImage(const cv::Mat& image, const OFIQ::BoundingBox& biggestFace);
00119 };
00120 }

8.85 poseEstimators.h File Reference

Base class for the different implementation of pose estimation algorithms.

#include "ofiq_lib.h"
#include "Session.h"
#include <array>

Classes

• class OFIQ_LIB::PoseEstimatorInterface
Implementation of the base class for integrating pose estimation algorithms capable of estimating three head orienta-
tion angles (yaw, pitch and roll) from a face image.

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.

Generated by Doxygen
268 File Documentation

8.85.1 Detailed Description

Base class for the different implementation of pose estimation algorithms.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.86 poseEstimators.h

Go to the documentation of this file.

00001
00027 #pragma once
00028
00029 #include "ofiq_lib.h"
00030 #include "Session.h"
00031 #include <array>
00032
00036 namespace OFIQ_LIB
00037 {
00038
00043 class PoseEstimatorInterface
00044 {
00045 public:
00049 using EulerAngle = std::array<double, 3>;
00050
00055 virtual ~PoseEstimatorInterface() = default;
00056
00064 EulerAngle& estimatePose(OFIQ_LIB::Session& session);
00065
00066 protected:
00073 virtual void updatePose(OFIQ_LIB::Session& session, EulerAngle& pose) = 0;
00074
00075 private:
00080 std::string m_lastSessionId;
00081
00086 EulerAngle m_pose;
00087 };
00088 }

Generated by Doxygen
8.87 FaceOcclusionSegmentation.h File Reference 269

8.87 FaceOcclusionSegmentation.h File Reference

Provides a class for segmenting the facial part not occluded by any non-facial parts from an image.

#include "Configuration.h"
#include "segmentations.h"
#include <ONNXRTSegmentation.h>

Classes

• class OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation
Class managing the separation of facial parts not occluded by non-facial parts from other parts.

Namespaces

• namespace cv
OpenCV's namespace.
• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::segmentations
Provides segmentation-related implementations.

8.87.1 Detailed Description

Provides a class for segmenting the facial part not occluded by any non-facial parts from an image.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

Generated by Doxygen
270 File Documentation

8.88 FaceOcclusionSegmentation.h

Go to the documentation of this file.

00001
00028 #pragma once
00029
00030 #include "Configuration.h"
00031 #include "segmentations.h"
00032 #include <ONNXRTSegmentation.h>
00033
00037 namespace cv
00038 {
00042 class Mat;
00043 }
00044
00048 namespace OFIQ_LIB::modules::segmentations
00049 {
00056 class FaceOcclusionSegmentation : public SegmentationExtractorInterface
00057 {
00058 public:
00065 explicit FaceOcclusionSegmentation(const Configuration& config);
00066
00070 ~FaceOcclusionSegmentation() override = default;
00071
00072
00073 protected:
00093 OFIQ::Image UpdateMask(
00094 OFIQ_LIB::Session& session, modules::segmentations::SegmentClassLabels faceSegment)
override;
00095
00096 private:
00097
00105 cv::Mat GetFaceOcclusionSegmentation(const cv::Mat& alignedImage);
00106
00110 ONNXRuntimeSegmentation m_onnxRuntimeEnv;
00111
00117 std::shared_ptr<cv::Mat> m_segmentationImage;
00118
00123 const std::string m_modelConfigItem = "params.measures.FaceOcclusionSegmentation.model_path";
00124
00128 const int m_cropLeft = 96;
00129
00133 const int m_cropRight = 96;
00134
00138 const int m_cropTop = 96;
00139
00143 const int m_cropBottom = 96;
00144
00150 const int m_scaledWidth = 224;
00151
00157 const int m_scaledHeight = 224;
00158
00159 };
00160 }

8.89 FaceParsing.h File Reference

Provides a class implementing the face parsing pre-processing.

#include "Configuration.h"
#include "segmentations.h"
#include <ONNXRTSegmentation.h>

Classes

• class OFIQ_LIB::modules::segmentations::FaceParsing
Class managing the separation of facial parts not occluded by non-facial parts from other parts.

Generated by Doxygen
8.90 FaceParsing.h 271

Namespaces

• namespace cv
OpenCV's namespace.
• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::segmentations
Provides segmentation-related implementations.

8.89.1 Detailed Description

Provides a class implementing the face parsing pre-processing.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.90 FaceParsing.h

Go to the documentation of this file.

00001
00028 #pragma once
00029
00030 #include "Configuration.h"
00031 #include "segmentations.h"
00032
00033 #include <ONNXRTSegmentation.h>
00034
00038 namespace cv
00039 {
00043 class Mat;
00044 }
00045
00049 namespace OFIQ_LIB::modules::segmentations
00050 {
00083 class FaceParsing : public SegmentationExtractorInterface
00084 {
00085 public:

Generated by Doxygen
272 File Documentation

00092 explicit FaceParsing(const Configuration& config);

00093
00097 ~FaceParsing() override = default;
00098
00099
00100 protected:
00126 OFIQ::Image UpdateMask(
00127 OFIQ_LIB::Session& session, modules::segmentations::SegmentClassLabels faceSegment)
override;
00128
00129 private:
00130
00134 ONNXRuntimeSegmentation m_onnxRuntimeEnv;
00135
00141 std::shared_ptr<cv::Mat> m_segmentationImage;
00142
00148 const std::string m_modelConfigItem = "params.measures.FaceParsing.model_path";
00149
00153 const int m_imageSize = 400;
00154
00158 const int m_cropLeft = 30;
00159
00163 const int m_cropRight = 30;
00164
00168 const int m_cropTop = 0;
00169
00173 const int m_cropBottom = 60;
00174
00183 static cv::Mat CreateBlob(const cv::Mat& image, int i_imageSize_one_dim);
00184
00196 static std::shared_ptr<cv::Mat> CalculateClassIds(
00197 const cv::Mat& resultImage,
00198 int i_imageSize_one_dim);
00199
00200 /*/
00201 * @brief Derives the private member \link segmentationImage\endlink
00202 * from the facial image data provided by the session object.
00203 * @details Implements CNN processing step of \link
OFIQ_LIB::modules::segmentations::FaceParsing::UpdateMask()
00204 * UpdateMask()\endlink.
00205 * @param session Session object containing the original facial image and pre-processing
results
00206 * computed by the \link OFIQ_LIB::OFIQImpl::performPreprocessing()
00207 * OFIQImpl::performPreprocessing()\endlink method.
00208 */
00209 void SetImage(OFIQ_LIB::Session& session);
00210 };
00211 }

8.91 ONNXRTSegmentation.h File Reference

Helper class to manage the ONNXRuntime session object.

#include <vector>
#include <opencv2/opencv.hpp>
#include <onnxruntime_cxx_api.h>

Classes

• class ONNXRuntimeSegmentation
Helper class to manage the ONNXRuntime session object.

8.91.1 Detailed Description

Helper class to manage the ONNXRuntime session object.

Generated by Doxygen
8.92 ONNXRTSegmentation.h 273

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.92 ONNXRTSegmentation.h

Go to the documentation of this file.

00001
00027 #pragma once
00028
00029 #include <vector>
00030
00031 #include <opencv2/opencv.hpp>
00032 #include <onnxruntime_cxx_api.h>
00033
00039 class ONNXRuntimeSegmentation
00040 {
00041 private:
00042
00047 Ort::Env m_ortenv;
00048
00053 Ort::MemoryInfo m_memoryInfo = Ort::MemoryInfo::CreateCpu(OrtDeviceAllocator, OrtMemTypeCPU);
00054
00059 std::array<int64_t, 4> m_inputShape;
00060
00065 std::unique_ptr<Ort::Session> m_ortSession;
00066
00074 void init_session(const std::vector<uint8_t>& i_model_data, int64_t i_imageWidth, int64_t
i_imageHeight);
00075
00076
00077 public:
00082 ONNXRuntimeSegmentation() = default;
00083
00088 ~ONNXRuntimeSegmentation() = default;
00089
00097 void initialize(
00098 const std::vector<uint8_t>& i_modelData, int64_t i_imageWidth, int64_t i_imageHeight);
00099
00105 size_t getNumberOfOutputNodes();
00106
00113 std::vector<Ort::Value> run( std::vector<float>& i_netInput);
00114
00115 };

8.93 segmentations.h File Reference

Base class for the different implementation of segmentation algorithms.

#include "ofiq_lib.h"
#include "Session.h"

Generated by Doxygen
274 File Documentation

Classes

• class OFIQ_LIB::SegmentationExtractorInterface
Base class for the different implementation of segmentation algorithms.

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.
• namespace OFIQ_LIB::modules
• namespace OFIQ_LIB::modules::segmentations
Provides segmentation-related implementations.

Enumerations

• enum class OFIQ_LIB::modules::segmentations::SegmentClassLabels {

OFIQ_LIB::modules::segmentations::background , OFIQ_LIB::modules::segmentations::skin , OFIQ_LIB::modules::segmentatio
, OFIQ_LIB::modules::segmentations::r_brow ,
OFIQ_LIB::modules::segmentations::l_eye , OFIQ_LIB::modules::segmentations::r_eye , OFIQ_LIB::modules::segmentations::e
, OFIQ_LIB::modules::segmentations::l_ear ,
OFIQ_LIB::modules::segmentations::r_ear , OFIQ_LIB::modules::segmentations::ear_r , OFIQ_LIB::modules::segmentations::n
, OFIQ_LIB::modules::segmentations::mouth ,
OFIQ_LIB::modules::segmentations::u_lip , OFIQ_LIB::modules::segmentations::l_lip , OFIQ_LIB::modules::segmentations::ne
, OFIQ_LIB::modules::segmentations::neck_l ,
OFIQ_LIB::modules::segmentations::cloth , OFIQ_LIB::modules::segmentations::hair , OFIQ_LIB::modules::segmentations::hat
, OFIQ_LIB::modules::segmentations::face }
Enum class of the different face regioons that can be segmented.

8.93.1 Detailed Description

Base class for the different implementation of segmentation algorithms.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

Generated by Doxygen
8.94 segmentations.h 275

8.94 segmentations.h

Go to the documentation of this file.

00001
00027 #pragma once
00028
00029 #include "ofiq_lib.h"
00030 #include "Session.h"
00031
00035 namespace OFIQ_LIB
00036 {
00040 namespace modules::segmentations
00041 {
00045 enum class SegmentClassLabels
00046 {
00050 background,
00054 skin,
00058 l_brow,
00062 r_brow,
00066 l_eye,
00070 r_eye,
00074 eye_g,
00078 l_ear,
00082 r_ear,
00086 ear_r,
00090 nose,
00094 mouth,
00098 u_lip,
00102 l_lip,
00106 neck,
00110 neck_l,
00114 cloth,
00118 hair,
00122 hat,
00126 face
00127 };
00128 }
00129
00137 class SegmentationExtractorInterface
00138 {
00139 public:
00144 virtual ~SegmentationExtractorInterface() = default;
00145
00153 OFIQ::Image& GetMask(
00154 OFIQ_LIB::Session& session, modules::segmentations::SegmentClassLabels faceSegment);
00155
00156 protected:
00157
00165 virtual OFIQ::Image UpdateMask(
00166 OFIQ_LIB::Session& session,
00167 modules::segmentations::SegmentClassLabels faceSegment) = 0;
00168
00173 std::string GetLastSessionId() const { return m_lastSessionId; };
00174
00175 private:
00180 std::string m_lastSessionId;
00185 std::map<modules::segmentations::SegmentClassLabels, OFIQ::Image> m_masks;
00186 };
00187 }

8.95 Configuration.h File Reference

Provides a configuration class for handling configurations.

#include <map>
#include <string>
#include <filesystem>
#include <tao/json/forward.hpp>
#include <tao/json/value.hpp>

Classes

• class OFIQ_LIB::Configuration
Configuration class.

Generated by Doxygen
276 File Documentation

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.

8.95.1 Detailed Description

Provides a configuration class for handling configurations.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.96 Configuration.h

Go to the documentation of this file.

00001
00029 #pragma once
00030
00031 #include <map>
00032 #include <string>
00033 #include <filesystem>
00034
00035 #include <tao/json/forward.hpp>
00036 #include <tao/json/value.hpp>
00037
00041 namespace OFIQ_LIB
00042 {
00049 class Configuration
00050 {
00051 public:
00058 Configuration(const std::string& configDir, const std::string& configFilename);
00059
00068 bool GetBool(const std::string& key, bool& value) const;
00069
00078 bool GetString(const std::string& key, std::string& value) const;
00079
00089 bool GetNumber(const std::string& key, double& value) const;
00090
00102 bool GetStringList(const std::string& key, std::vector<std::string>& value) const;
00103
00110 bool GetBool(const std::string& key) const;
00111

Generated by Doxygen
8.97 image_io.h File Reference 277

00118 std::string GetString(const std::string& key) const;

00119
00126 double GetNumber(const std::string& key) const;
00127
00135 std::string getDataDir() const;
00136
00143 void SetDataDir(std::string dataDir);
00144
00145 private:
00149 std::map<std::string, tao::json::value, std::less<» parameters;
00150
00156 std::filesystem::path m_dataDir;
00157 };
00158 }

8.97 image_io.h File Reference

Provides helper functions for reading/writing images from/to disk.

#include "ofiq_lib.h"

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.

Functions

• OFIQ_EXPORT OFIQ::ReturnStatus OFIQ_LIB::readImage (const std::string &filename, OFIQ::Image &im-

age)
Read image from disk.

8.97.1 Detailed Description

Provides helper functions for reading/writing images from/to disk.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

Generated by Doxygen
278 File Documentation

8.98 image_io.h

Go to the documentation of this file.

00001
00027 #ifndef OFIQ_LIB_IMAGE_IO_H
00028 #define OFIQ_LIB_IMAGE_IO_H
00029
00030 #include "ofiq_lib.h"
00031
00035 namespace OFIQ_LIB {
00036
00044 OFIQ_EXPORT OFIQ::ReturnStatus
00045 readImage(const std::string& filename, OFIQ::Image& image);
00046
00047 }
00048
00049 #endif

8.99 image_utils.h File Reference

Provides image utility functions such as color conversion, luminance computation etc.

#include "ofiq_lib.h"
#include "Session.h"
#include <opencv2/imgcodecs.hpp>
#include <opencv2/imgproc.hpp>

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.

Typedefs

• using OFIQ_LIB::ExposureRange = std::array<int, 2>

Functions

• OFIQ_EXPORT double OFIQ_LIB::ColorConvert (double v)

Converts a color as specified in ISO/IEC 29794-5.
• OFIQ_EXPORT double OFIQ_LIB::Cubic (double x, double k, double eps)
Cubic flattening function.
• OFIQ_EXPORT void OFIQ_LIB::ConvertBGRToCIELAB (const cv::Mat &bgrImage, double &a, double &b)
Computes CIELAB values a∗ and b∗ from a BGR image.
• OFIQ_EXPORT cv::Mat OFIQ_LIB::GetLuminanceImageFromBGR (const cv::Mat &bgrImage)
Converts a BGR image to the luminance image.
• OFIQ_EXPORT void OFIQ_LIB::CalculateReferencePoints (const OFIQ::FaceLandmarks &landmarks,
OFIQ::LandmarkPoint &leftEyeCenter, OFIQ::LandmarkPoint &rightEyeCenter, double &interEyeDistance,
double &eyeMouthDistance)
Computes the left eye center, the right eye center, the (planar) inter-eye-distance and the eye to mouth distance from
facial landmarks.

Generated by Doxygen
8.100 image_utils.h 279

• OFIQ_EXPORT void OFIQ_LIB::CalculateRegionOfInterest (cv::Rect &leftRegionOfInterest, cv::Rect

&rightRegionOfInterest, const OFIQ::LandmarkPoint &leftEyeCenter, const OFIQ::LandmarkPoint &right←-
EyeCenter, const double interEyeDistance, const double eyeMouthDistance)
Extracts regions being of interest for some measures (e.g. NaturalColour).
• OFIQ_EXPORT void OFIQ_LIB::GetNormalizedHistogram (const cv::Mat &luminanceImage, const cv::Mat
&maskImage, cv::Mat1f &histogram)
Computes the normalized histogram from a luminance image in 256 chunks.
• OFIQ_EXPORT double OFIQ_LIB::CalculateExposure (const Session &session, const ExposureRange
&exposureRange)
Helper function for some measures.
• OFIQ_EXPORT double OFIQ_LIB::ComputeBrightnessAspect (const cv::Mat &luminanceImage, const cv←-
::Mat &maskImage, const ExposureRange &exposureRange)
Helper function for some measures.

8.99.1 Detailed Description

Provides image utility functions such as color conversion, luminance computation etc.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.100 image_utils.h

Go to the documentation of this file.

00001
00027 #pragma once
00028
00029 #include "ofiq_lib.h"
00030 #include "Session.h"
00031 #include <opencv2/imgcodecs.hpp>
00032 #include <opencv2/imgproc.hpp>
00033
00037 namespace OFIQ_LIB {
00038
00039 using ExposureRange = std::array<int, 2>;
00040

Generated by Doxygen
280 File Documentation

00047 OFIQ_EXPORT double ColorConvert(double v);

00048
00057 OFIQ_EXPORT double Cubic(double x, double k, double eps);
00058
00065 OFIQ_EXPORT void ConvertBGRToCIELAB(const cv::Mat& bgrImage, double& a, double& b);
00066
00074 OFIQ_EXPORT cv::Mat GetLuminanceImageFromBGR(const cv::Mat& bgrImage );
00075
00085 OFIQ_EXPORT void CalculateReferencePoints(const OFIQ::FaceLandmarks& landmarks,
00086 OFIQ::LandmarkPoint& leftEyeCenter,
00087 OFIQ::LandmarkPoint& rightEyeCenter,
00088 double& interEyeDistance,
00089 double& eyeMouthDistance);
00090
00104 OFIQ_EXPORT void CalculateRegionOfInterest(cv::Rect& leftRegionOfInterest,
00105 cv::Rect& rightRegionOfInterest,
00106 const OFIQ::LandmarkPoint& leftEyeCenter,
00107 const OFIQ::LandmarkPoint& rightEyeCenter,
00108 const double interEyeDistance, const double eyeMouthDistance);
00109
00117 OFIQ_EXPORT void GetNormalizedHistogram(const cv::Mat& luminanceImage, const cv::Mat& maskImage,
cv::Mat1f& histogram);
00118
00132 OFIQ_EXPORT double CalculateExposure(const Session& session, const ExposureRange& exposureRange);
00133
00145 OFIQ_EXPORT double ComputeBrightnessAspect(
00146 const cv::Mat& luminanceImage, const cv::Mat& maskImage, const ExposureRange& exposureRange);
00147 }

8.101 NeuronalNetworkContainer.h File Reference

#include "detectors.h"
#include "landmarks.h"
#include "segmentations.h"
#include "poseEstimators.h"

Classes

• struct OFIQ_LIB::NeuronalNetworkContainer
Neural network container for OFIQ's preprocessing steps.

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.

8.102 NeuronalNetworkContainer.h

Go to the documentation of this file.

00001
00027 #pragma once
00028 #include "detectors.h"
00029 #include "landmarks.h"
00030 #include "segmentations.h"
00031 #include "poseEstimators.h"
00032
00036 namespace OFIQ_LIB
00037 {
00041 struct NeuronalNetworkContainer
00042 {
00055 NeuronalNetworkContainer(
00056 std::shared_ptr<FaceDetectorInterface> faceDetector,
00057 std::shared_ptr<FaceLandmarkExtractorInterface> landmarkExtractor,

Generated by Doxygen
8.103 OFIQError.h File Reference 281

00058 std::shared_ptr<SegmentationExtractorInterface> segmentationExtractor,

00059 std::shared_ptr<PoseEstimatorInterface> poseEstimator,
00060 std::shared_ptr<SegmentationExtractorInterface> faceOcclusionExtractor
00061 )
00062 : faceDetector{faceDetector},
00063 landmarkExtractor{landmarkExtractor},
00064 segmentationExtractor{segmentationExtractor},
00065 poseEstimator{poseEstimator},
00066 faceOcclusionExtractor{faceOcclusionExtractor}
00067 {
00068 }
00069
00073 std::shared_ptr<FaceDetectorInterface> faceDetector;
00074
00078 std::shared_ptr<FaceLandmarkExtractorInterface> landmarkExtractor;
00079
00085 std::shared_ptr<SegmentationExtractorInterface> segmentationExtractor;
00086
00092 std::shared_ptr<SegmentationExtractorInterface> faceOcclusionExtractor;
00093
00097 std::shared_ptr<PoseEstimatorInterface> poseEstimator;
00098 };
00099 }

8.103 OFIQError.h File Reference

Provides a class for the error handling within the QFIQ.

#include "ofiq_lib.h"
#include <string_view>

Classes

• class OFIQ_LIB::OFIQError
Implementation of a custom exception.

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.

8.103.1 Detailed Description

Provides a class for the error handling within the QFIQ.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Generated by Doxygen
282 File Documentation

Author

OFIQ development team

8.104 OFIQError.h

Go to the documentation of this file.

00001
00027 #pragma once
00028 #include "ofiq_lib.h"
00029 #include <string_view>
00030
00034 namespace OFIQ_LIB
00035 {
00040 class OFIQError : public std::exception
00041 {
00042 public:
00049 OFIQError(OFIQ::ReturnCode returnCode, std::string_view message);
00050
00056 const char* what() const noexcept override { return m_extendedMessage.c_str(); }
00057
00063 OFIQ::ReturnCode whatCode() const noexcept { return m_returnCode; }
00064
00065 private:
00070 OFIQ::ReturnCode m_returnCode;
00071
00076 std::string m_message;
00077
00082 std::string m_extendedMessage;
00083 };
00084 }

8.105 Session.h File Reference

The session class is the data container used to distribute the image and additional data, including the data computed
during the pre-processing.

#include "ofiq_lib.h"
#include <opencv2/opencv.hpp>

Classes

• class OFIQ_LIB::Session

Namespaces

• namespace OFIQ_LIB
Namespace for OFIQ implementations.

Typedefs

• using OFIQ_LIB::EulerAngle = std::array<double, 3>

Generated by Doxygen
8.106 Session.h 283

8.105.1 Detailed Description

The session class is the data container used to distribute the image and additional data, including the data computed
during the pre-processing.

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.106 Session.h

Go to the documentation of this file.

00001
00028 #pragma once
00029
00030 #include "ofiq_lib.h"
00031 #include <opencv2/opencv.hpp>
00032
00036 namespace OFIQ_LIB
00037 {
00041 struct NeuronalNetworkContainer;
00042
00043 using EulerAngle = std::array<double, 3>;
00044
00051 class Session
00052 {
00053 public:
00054
00061 Session(const OFIQ::Image& image, OFIQ::FaceImageQualityAssessment& assessment)
00062 : m_image{image},
00063 m_assessment{assessment},
00064 m_id{GenerateId()}
00065 {
00066 }
00067
00072 const OFIQ::Image& image() const { return m_image; }
00073
00078 OFIQ::FaceImageQualityAssessment& assessment() { return m_assessment; }
00079
00085 const std::string& Id() const { return m_id; }
00086
00087 // use the session object as data container
00088
00094 void setDetectedFaces(const std::vector<OFIQ::BoundingBox>& i_boundingBoxes);
00095
00101 std::vector<OFIQ::BoundingBox> getDetectedFaces() const;
00102

Generated by Doxygen
284 File Documentation

00108 void setPose(const EulerAngle& i_pose);

00109
00115 EulerAngle getPose() const;
00116
00122 void setLandmarks(const OFIQ::FaceLandmarks& i_landmarks);
00123
00129 OFIQ::FaceLandmarks getLandmarks() const;
00130
00131
00137 void setAlignedFaceLandmarks(const OFIQ::FaceLandmarks& i_landmarks);
00138
00144 OFIQ::FaceLandmarks getAlignedFaceLandmarks() const;
00145
00151 void setAlignedFaceTransformationMatrix(const cv::Mat & i_transformationMatrix);
00152
00153
00159 cv::Mat getAlignedFaceTransformationMatrix() const;
00160
00161
00167 void setAlignedFace(const cv::Mat & i_alignedFace);
00168
00174 cv::Mat getAlignedFace() const;
00175
00181 void setAlignedFaceLandmarkedRegion(const cv::Mat & i_alignedFaceRegion);
00182
00188 cv::Mat getAlignedFaceLandmarkedRegion() const;
00189
00195 void setFaceParsingImage(const cv::Mat& i_parsingImage);
00196
00202 cv::Mat getFaceParsingImage() const;
00203
00209 void setFaceOcclusionSegmentationImage(const cv::Mat& i_segmentationImage);
00210
00216 cv::Mat getFaceOcclusionSegmentationImage() const;
00217
00218 private:
00223 const OFIQ::Image& m_image;
00224
00229 OFIQ::FaceImageQualityAssessment& m_assessment;
00234 std::vector<OFIQ::BoundingBox> m_detectedFaces;
00235
00240 EulerAngle m_pose;
00241
00246 OFIQ::FaceLandmarks m_landmarks;
00247
00252 OFIQ::FaceLandmarks m_alignedFaceLandmarks;
00253
00258 cv::Mat m_alignedFaceTransformationMatrix;
00259
00264 cv::Mat m_alignedFace;
00265
00270 cv::Mat m_alignedFacelandmarkedRegion;
00271
00276 cv::Mat m_faceParsingImage;
00277
00282 cv::Mat m_faceOcclusionSegmentationImage;
00283
00289 std::string GenerateId() const;
00290
00295 std::string m_id;
00296 };
00297 }

8.107 utils.h File Reference

Helper functions used by several classes.

#include "ofiq_lib.h"

Classes

• struct Point2f
Representation of a point with floating point arithmetics.
• struct OFIQ_LIB::Point2i
Representation of a point with integer arithmetics.

Generated by Doxygen
8.107 utils.h File Reference 285

Namespaces

• namespace cv
OpenCV's namespace.
• namespace OFIQ_LIB
Namespace for OFIQ implementations.

Functions

• OFIQ_EXPORT void OFIQ_LIB::makeSquareBoundingBoxWithPadding (const OFIQ::BoundingBox &i_←-

bb, const cv::Mat &i_input_image, cv::Mat &o_output_image, OFIQ::BoundingBox &o_bb, Point2i &o_←-
translation_vector)
Some computations, especially neural networks, need a squarred image as input. This funtion consumes a boundig
box and an input image. The greater parameter of width or height is used to define the side length of the new squarred
bounding box. The face will be centered in the bounding box. Padding is added if needed. The squarred bounding box
is used generate a new cropped image, the o_output_image. Required translations are described by the translation
vector o_translation_vector.
• OFIQ_EXPORT OFIQ::BoundingBox OFIQ_LIB::makeSquareBoundingBox (const OFIQ::BoundingBox &i←-
_bb)
This function converts a non-squarred bounding box into an squarred one. The side length is defined by the greater
one of height or width.
• OFIQ_EXPORT size_t OFIQ_LIB::findLargestBoundingBox (const std::vector< OFIQ::BoundingBox >
&faceRects)
This function returns the position of the largest bounding box (largest in terms of area) from a vector of bounding
boxes.
• OFIQ_EXPORT cv::Mat OFIQ_LIB::copyToCvImage (const OFIQ::Image &sourceImage, bool asGray←-
Image=false)
Convert images in OFIQ::Image format into the OpenCV cv::Mat format. The image can be converted from color to
gray scale by setting the parameter asGrayImage to true.
• OFIQ_EXPORT cv::Mat OFIQ_LIB::alignImage (const OFIQ::Image &faceImage, const OFIQ::FaceLandmarks
&faceLandmarks, OFIQ::FaceLandmarks &alignedFaceLandmarks, cv::Mat &transformationMatrix)
This function transforms a face image so that the position of the eyes, nose and mouth are roughly at a pre-defined
position. Face alignment is the translation, rotation and scaling of the image to do this.
• OFIQ_EXPORT void OFIQ_LIB::calculateEyeCenter (const OFIQ::FaceLandmarks &faceLandmarks, Point2f
&leftEyeCenter, Point2f &rightEyeCenter)
Based on face landmarks the center of the left and right eye are computed.
• OFIQ_EXPORT OFIQ::Image OFIQ_LIB::MakeGreyImage (uint16_t width, uint16_t height)
This function generates a gray scaled image with the resolution passed by the call.
• OFIQ_EXPORT float OFIQ_LIB::tmetric (const OFIQ::FaceLandmarks &faceLandmarks)
Based on the provided landmarks this function computes the distance between the point between the eyes and the
chin.

8.107.1 Detailed Description

Helper functions used by several classes.

Generated by Doxygen
286 File Documentation

Copyright

Copyright (c) 2024 Federal Office for Information Security, Germany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, IN-
CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Author

OFIQ development team

8.108 utils.h

Go to the documentation of this file.

00001
00027 #ifndef OFIQ_LIB_UTILS_H
00028 #define OFIQ_LIB_UTILS_H
00029
00030 #include "ofiq_lib.h"
00031
00035 namespace cv
00036 {
00040 class Mat;
00041 }
00042
00047 struct Point2f
00048 {
00049 float x;
00050 float y;
00051 };
00052
00053
00054
00055 namespace OFIQ_LIB
00056 {
00061 struct Point2i
00062 {
00063 int x;
00064 int y;
00065 };
00066
00081 OFIQ_EXPORT void makeSquareBoundingBoxWithPadding(
00082 const OFIQ::BoundingBox& i_bb,
00083 const cv::Mat& i_input_image,
00084 cv::Mat& o_output_image,
00085 OFIQ::BoundingBox& o_bb,
00086 Point2i & o_translation_vector
00087 );
00088
00095 OFIQ_EXPORT OFIQ::BoundingBox makeSquareBoundingBox(
00096 const OFIQ::BoundingBox& i_bb);
00097
00104 OFIQ_EXPORT size_t findLargestBoundingBox(
00105 const std::vector<OFIQ::BoundingBox>& faceRects);
00106
00114 OFIQ_EXPORT cv::Mat copyToCvImage(const OFIQ::Image& sourceImage, bool asGrayImage = false);
00115
00125 OFIQ_EXPORT cv::Mat alignImage(
00126 const OFIQ::Image& faceImage,

Generated by Doxygen
8.108 utils.h 287

00127 const OFIQ::FaceLandmarks& faceLandmarks,

00128 OFIQ::FaceLandmarks& alignedFaceLandmarks,
00129 cv::Mat& transformationMatrix);
00130
00138 OFIQ_EXPORT void calculateEyeCenter(
00139 const OFIQ::FaceLandmarks& faceLandmarks,
00140 Point2f& leftEyeCenter,
00141 Point2f& rightEyeCenter);
00142
00150 OFIQ_EXPORT OFIQ::Image MakeGreyImage(uint16_t width, uint16_t height);
00151
00158 OFIQ_EXPORT float tmetric(const OFIQ::FaceLandmarks& faceLandmarks);
00159 }
00160
00161 #endif

Generated by Doxygen
288 File Documentation

Generated by Doxygen
Index

∼ADNetFaceLandmarkExtractor assessment
OFIQ_LIB::modules::landmarks::ADNetFaceLandmarkExtractor,
OFIQ_LIB::Session, 182
64
∼FaceDetectorInterface background
OFIQ_LIB::FaceDetectorInterface, 93 OFIQ_LIB::modules::segmentations, 61
∼FaceLandmarkExtractorInterface BackgroundUniformity
OFIQ_LIB::FaceLandmarkExtractorInterface, 96 OFIQ, 39
∼FaceOcclusionSegmentation OFIQ_LIB::modules::measures::BackgroundUniformity,
67
OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation,
106 BackgroundUniformity.h, 230, 231
∼FaceParsing BoundingBox
OFIQ_LIB::modules::segmentations::FaceParsing, OFIQ::BoundingBox, 69
110 boundingBox
∼HeadPose3DDFAV2 OFIQ::FaceImageQualityAssessment, 95
OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2,
117 CalculateClassIds
∼Interface OFIQ_LIB::modules::segmentations::FaceParsing,
OFIQ::Interface, 129 111
∼Measure CalculateExposure
OFIQ_LIB::modules::measures::Measure, 137 OFIQ_LIB, 44
∼OFIQImpl calculateEyeCenter
OFIQ_LIB::OFIQImpl, 160 OFIQ_LIB, 44
∼ONNXRuntimeSegmentation CalculateReferencePoints
ONNXRuntimeSegmentation, 165 OFIQ_LIB, 44
∼PoseEstimatorInterface CalculateRegionOfInterest
OFIQ_LIB::PoseEstimatorInterface, 173 OFIQ_LIB, 45
∼SSDFaceDetector CalculateScore
OFIQ_LIB::modules::detectors::SSDFaceDetector, OFIQ_LIB::modules::measures::NaturalColour,
199 150
∼SegmentationExtractorInterface CHIN
OFIQ_LIB::SegmentationExtractorInterface, 178 OFIQ_LIB::modules::landmarks, 54
chin
a OFIQ_LIB::modules::landmarks::adnet, 55
OFIQ_LIB::modules::measures::SigmoidParameters, cloth
194 OFIQ_LIB::modules::segmentations, 61
AddSigmoid code
OFIQ_LIB::modules::measures::Measure, 138 OFIQ::QualityMeasureResult, 175
adnet_FaceMap.h, 217, 219 OFIQ::ReturnStatus, 176
adnet_landmarks.h, 220, 221 ColorConvert
ADNetFaceLandmarkExtractor OFIQ_LIB, 45
CompressionArtifacts
OFIQ_LIB::modules::landmarks::ADNetFaceLandmarkExtractor,
64 OFIQ, 40
alignFaceImage OFIQ_LIB::modules::measures::CompressionArtifacts,
OFIQ_LIB::OFIQImpl, 161 72
alignImage CompressionArtifacts.h, 231, 232
OFIQ_LIB, 43 ComputeBrightnessAspect
AllDetectors.h, 214 OFIQ_LIB, 46
AllLandmarks.h, 221, 222 config
AllMeasures.h, 228, 230 OFIQ_LIB::OFIQImpl, 163
AllPoseEstimators.h, 265 Configuration

Generated by Doxygen
290 INDEX

OFIQ_LIB::Configuration, 75 Execute
configuration OFIQ_LIB::modules::measures::BackgroundUniformity,
OFIQ_LIB::modules::measures::Measure, 142 67
Configuration.h, 275, 276 OFIQ_LIB::modules::measures::CompressionArtifacts,
contour 73
OFIQ_LIB::modules::landmarks::adnet, 55 OFIQ_LIB::modules::measures::CropOfTheFaceImage,
ConvertBGRToCIELAB 81
OFIQ_LIB, 46 OFIQ_LIB::modules::measures::DynamicRange,
copyToCvImage 83
OFIQ_LIB, 46 OFIQ_LIB::modules::measures::ExpressionNeutrality,
CreateBlob 87
OFIQ_LIB::modules::segmentations::FaceParsing, OFIQ_LIB::modules::measures::EyesOpen, 89
111 OFIQ_LIB::modules::measures::EyesVisible, 92
CreateExecutor OFIQ_LIB::modules::measures::FaceOcclusionPrevention,
OFIQ_LIB::OFIQImpl, 161 103
CreateMaskedImage OFIQ_LIB::modules::measures::HeadPose, 115
OFIQ_LIB::modules::measures::NaturalColour, OFIQ_LIB::modules::measures::HeadSize, 121
150 OFIQ_LIB::modules::measures::IlluminationUniformity,
CreateMeasure 123
OFIQ_LIB::modules::measures::MeasureFactory, OFIQ_LIB::modules::measures::InterEyeDistance,
143 127
CreateNetworks OFIQ_LIB::modules::measures::Luminance, 135
OFIQ_LIB::OFIQImpl, 161 OFIQ_LIB::modules::measures::Measure, 138
CropImage OFIQ_LIB::modules::measures::MouthClosed, 145
OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2,OFIQ_LIB::modules::measures::MouthOcclusionPrevention,
118 147
CropOfTheFaceImage OFIQ_LIB::modules::measures::NaturalColour,
OFIQ, 40 150
OFIQ_LIB::modules::measures::CropOfTheFaceImage, OFIQ_LIB::modules::measures::NoHeadCoverings,
80 156
CropOfTheFaceImage.h, 233, 234 OFIQ_LIB::modules::measures::OverExposurePrevention,
Cubic 169
OFIQ_LIB, 47 OFIQ_LIB::modules::measures::Sharpness, 191
cv, 37 OFIQ_LIB::modules::measures::SingleFacePresent,
197
data OFIQ_LIB::modules::measures::UnderExposurePrevention,
OFIQ::Image, 125 202
depth OFIQ_LIB::modules::measures::UnifiedQualityScore,
OFIQ::Image, 125 204
detectFaces ExecuteAll
OFIQ_LIB::FaceDetectorInterface, 93 OFIQ_LIB::modules::measures::Executor, 84
detectors.h, 215, 216 ExecuteScalarConversion
dummyAssement OFIQ_LIB::modules::measures::Measure, 139
OFIQ_LIB::OFIQImpl, 163 Executor
dummyImage OFIQ_LIB::modules::measures::Executor, 84
OFIQ_LIB::OFIQImpl, 163 Executor.h, 235, 237
DynamicRange ExecutorLogActive
OFIQ, 40 OFIQ_LIB::modules::measures, 60
OFIQ_LIB::modules::measures::DynamicRange, ExpandKey
82 OFIQ_LIB::modules::measures::Measure, 139
DynamicRange.h, 234, 235 ExposureRange
OFIQ_LIB, 43
ear_r ExpressionNeutrality
OFIQ_LIB::modules::segmentations, 61 OFIQ, 40
estimatePose OFIQ_LIB::modules::measures::ExpressionNeutrality,
OFIQ_LIB::PoseEstimatorInterface, 173 86
EulerAngle ExpressionNeutrality.h, 237, 238
OFIQ_LIB, 43 extractLandmarks
OFIQ_LIB::PoseEstimatorInterface, 172

Generated by Doxygen
INDEX 291

OFIQ_LIB::FaceLandmarkExtractorInterface, 96 OFIQ_LIB::modules::landmarks, 54
eye_g FaceParts.h, 224, 225
OFIQ_LIB::modules::segmentations, 61 FailureToAssess
EyesOpen OFIQ, 40
OFIQ, 40 findLargestBoundingBox
OFIQ_LIB::modules::measures::EyesOpen, 89 OFIQ_LIB, 47
EyesOpen.h, 238, 239 FOREHEAD
EyesVisible OFIQ_LIB::modules::landmarks, 54
OFIQ, 40 forehead
OFIQ_LIB::modules::measures::EyesVisible, 91 OFIQ_LIB::modules::landmarks::adnet, 56
EyesVisible.h, 240, 241
GenerateId
face OFIQ_LIB::Session, 182
OFIQ_LIB::modules::segmentations, 61 getAlignedFace
FACE_CONTOUR OFIQ_LIB::Session, 182
OFIQ_LIB::modules::landmarks, 54 getAlignedFaceLandmarkedRegion
FaceDetectionError OFIQ_LIB::Session, 182
OFIQ, 41 getAlignedFaceLandmarks
faceDetector OFIQ_LIB::Session, 182
OFIQ::BoundingBox, 70 getAlignedFaceTransformationMatrix
OFIQ_LIB::NeuronalNetworkContainer, 153 OFIQ_LIB::Session, 183
FaceDetectorType GetBool
OFIQ, 39 OFIQ_LIB::Configuration, 75
FaceImageQualityAssessment GetClassifierFocusFeatures
OFIQ::FaceImageQualityAssessment, 94 OFIQ_LIB::modules::measures::Sharpness, 191
FaceLandmarkExtractionError GetCroppedImages
OFIQ, 41 OFIQ_LIB::modules::measures::Sharpness, 191
FaceLandmarks getDataDir
OFIQ::FaceLandmarks, 97 OFIQ_LIB::Configuration, 76
FaceMap getDetectedFaces
OFIQ_LIB::modules::landmarks, 53 OFIQ_LIB::Session, 183
OFIQ_LIB::modules::landmarks::adnet, 55 GetDistance
FaceMeasures OFIQ_LIB::modules::landmarks::FaceMeasures,
OFIQ_LIB::modules::landmarks::FaceMeasures, 98, 99
98 GetFaceMask
FaceMeasures.h, 222, 223 OFIQ_LIB::modules::landmarks::FaceMeasures,
faceOcclusionExtractor 99
OFIQ_LIB::NeuronalNetworkContainer, 153 GetFaceOcclusionSegmentation
FaceOcclusionPrevention OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation,
OFIQ, 40 106
OFIQ_LIB::modules::measures::FaceOcclusionPrevention,
getFaceOcclusionSegmentationImage
103 OFIQ_LIB::Session, 183
FaceOcclusionPrevention.h, 241, 242 getFaceParsingImage
FaceOcclusionSegmentation OFIQ_LIB::Session, 183
OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation,
getFacePart
105 OFIQ_LIB::modules::landmarks::PartExtractor,
FaceOcclusionSegmentation.h, 269, 270 169
FaceOcclusionSegmentationError getImplementation
OFIQ, 41 OFIQ::Interface, 129
FacePairMap getLandmarks
OFIQ_LIB::modules::landmarks, 53 OFIQ_LIB::Session, 183
OFIQ_LIB::modules::landmarks::adnet, 55 GetLastSessionId
FaceParsing OFIQ_LIB::SegmentationExtractorInterface, 178
OFIQ_LIB::modules::segmentations::FaceParsing, GetLuminanceImageFromBGR
110 OFIQ_LIB, 48
FaceParsing.h, 270, 271 GetMask
FaceParsingError OFIQ_LIB::SegmentationExtractorInterface, 178
OFIQ, 41 GetMaxPairDistance
FaceParts

Generated by Doxygen
292 INDEX

OFIQ_LIB::modules::landmarks::FaceMeasures, Id
99 OFIQ_LIB::Session, 184
GetMeasureName IlluminationUniformity
OFIQ_LIB::modules::measures::Measure, 140 OFIQ, 39
GetMeasures OFIQ_LIB::modules::measures::IlluminationUniformity,
OFIQ_LIB::modules::measures::Executor, 84 123
GetMiddle IlluminationUniformity.h, 245, 246
OFIQ_LIB::modules::landmarks::FaceMeasures, Image
100, 101 OFIQ::Image, 124
GetName image
OFIQ_LIB::modules::measures::Measure, 140 OFIQ_LIB::Session, 184
GetNormalizedHistogram image_io.h, 277, 278
OFIQ_LIB, 48 image_utils.h, 278, 279
GetNumber ImageReadingError
OFIQ_LIB::Configuration, 76 OFIQ, 41
getNumberOfOutputNodes ImageWritingError
ONNXRuntimeSegmentation, 165 OFIQ, 41
getPairsForPart info
OFIQ_LIB::modules::landmarks::PartExtractor, OFIQ::ReturnStatus, 176
170 init_session
getPose ONNXRuntimeSegmentation, 165
OFIQ_LIB::Session, 184 initialize
GetQualityMeasure OFIQ::Interface, 129
OFIQ_LIB::modules::measures::Measure, 140 OFIQ_LIB::OFIQImpl, 161
GetString ONNXRuntimeSegmentation, 166
OFIQ_LIB::Configuration, 77 InterEyeDistance
GetStringList OFIQ, 40
OFIQ_LIB::Configuration, 78 OFIQ_LIB::modules::landmarks::FaceMeasures,
getVersion 101
OFIQ::Interface, 129 OFIQ_LIB::modules::measures::InterEyeDistance,
127
h InterEyeDistance.h, 246, 247
OFIQ_LIB::modules::measures::SigmoidParameters,
194 l_brow
hair OFIQ_LIB::modules::segmentations, 61
OFIQ_LIB::modules::segmentations, 61 l_ear
hat OFIQ_LIB::modules::segmentations, 61
OFIQ_LIB::modules::segmentations, 61 l_eye
HeadPose OFIQ_LIB::modules::segmentations, 61
OFIQ, 40 l_lip
OFIQ_LIB::modules::measures::HeadPose, 115 OFIQ_LIB::modules::segmentations, 61
HeadPose.h, 242, 243 landmarkExtractor
HeadPose3DDFAV2 OFIQ_LIB::NeuronalNetworkContainer, 153
OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2,
landmarkExtractor_
117 OFIQ_LIB::modules::landmarks::ADNetFaceLandmarkExtractor,
HeadPose3DDFAV2.h, 265, 267 65
HeadPosePitch LandmarkId
OFIQ, 40 OFIQ_LIB::modules::landmarks, 53
HeadPoseRoll LandmarkIdPair
OFIQ, 40 OFIQ_LIB::modules::landmarks, 53
HeadPoseYaw LandmarkIdPairs
OFIQ, 40 OFIQ_LIB::modules::landmarks, 53
HeadSize LandmarkIds
OFIQ, 40 OFIQ_LIB::modules::landmarks, 53
OFIQ_LIB::modules::measures::HeadSize, 121 LandmarkPair
HeadSize.h, 244, 245 OFIQ_LIB::modules::landmarks::LandmarkPair,
height 131
OFIQ::BoundingBox, 70 LandmarkPoint
OFIQ::Image, 125 OFIQ::LandmarkPoint, 132

Generated by Doxygen
INDEX 293

Landmarks m_cropLeft
OFIQ, 38 OFIQ_LIB::modules::measures::BackgroundUniformity,
landmarks 67
OFIQ::FaceLandmarks, 97 OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation,
landmarks.h, 226, 227 107
LandmarkType OFIQ_LIB::modules::segmentations::FaceParsing,
OFIQ, 39 112
LEFT_EYE m_cropRight
OFIQ_LIB::modules::landmarks, 54 OFIQ_LIB::modules::measures::BackgroundUniformity,
LEFT_EYE_CORNERS 68
OFIQ_LIB::modules::landmarks, 54 OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation,
leftEye 107
OFIQ_LIB::modules::landmarks::adnet, 56 OFIQ_LIB::modules::segmentations::FaceParsing,
leftEyeCorners 112
OFIQ_LIB::modules::landmarks::adnet, 56 m_cropTop
LeftwardCropOfTheFaceImage OFIQ_LIB::modules::measures::BackgroundUniformity,
OFIQ, 40 68
LM_98 OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation,
OFIQ, 39 107
log OFIQ_LIB::modules::segmentations::FaceParsing,
OFIQ_LIB::modules::measures, 59 113
Lower m_dataDir
OFIQ_LIB::modules::landmarks::LandmarkPair, OFIQ_LIB::Configuration, 78
132 m_detectedFaces
Luminance OFIQ_LIB::Session, 187
OFIQ, 39 m_dim
OFIQ_LIB::modules::measures::Luminance, 134 OFIQ_LIB::modules::measures::CompressionArtifacts,
Luminance.h, 248, 249 73
LuminanceMean m_dnnNet
OFIQ, 39 OFIQ_LIB::modules::detectors::SSDFaceDetector,
LuminanceVariance 199
OFIQ, 39 m_emptySession
OFIQ_LIB::OFIQImpl, 163
m_alignedFace m_erosionKernelSize
OFIQ_LIB::Session, 187 OFIQ_LIB::modules::measures::BackgroundUniformity,
m_alignedFacelandmarkedRegion 68
OFIQ_LIB::Session, 187 m_executorPtr
m_alignedFaceLandmarks OFIQ_LIB::OFIQImpl, 163
OFIQ_LIB::Session, 187 m_expectedImageHeight
m_alignedFaceTransformationMatrix OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2,
OFIQ_LIB::Session, 187 118
m_assessment m_expectedImageNumberOfChannels
OFIQ_LIB::Session, 187 OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2,
m_classifier 118
OFIQ_LIB::modules::measures::ExpressionNeutrality,m_expectedImageWidth
87 OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2,
m_confidenceThreshold 119
OFIQ_LIB::modules::detectors::SSDFaceDetector, m_extendedMessage
199 OFIQ_LIB::OFIQError, 159
m_crop m_faceOcclusionSegmentationImage
OFIQ_LIB::modules::measures::CompressionArtifacts, OFIQ_LIB::Session, 187
73 m_faceParsingImage
m_cropBottom OFIQ_LIB::Session, 188
OFIQ_LIB::modules::measures::BackgroundUniformity,m_faceRegionAlpha
67 OFIQ_LIB::modules::measures::Sharpness, 192
OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation,
m_id
107 OFIQ_LIB::Session, 188
OFIQ_LIB::modules::segmentations::FaceParsing, m_image
112

Generated by Doxygen
294 INDEX

OFIQ_LIB::Session, 188 OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2,

m_imageSize 119
OFIQ_LIB::modules::segmentations::FaceParsing, ONNXRuntimeSegmentation, 166
113 m_padding
m_inputShape OFIQ_LIB::modules::detectors::SSDFaceDetector,
OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2, 200
119 m_paramPoseEstimatorModel
ONNXRuntimeSegmentation, 166 OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2,
m_landmarks 119
OFIQ_LIB::Session, 188 m_pose
m_lastSessionId OFIQ_LIB::PoseEstimatorInterface, 173
OFIQ_LIB::PoseEstimatorInterface, 173 OFIQ_LIB::Session, 188
OFIQ_LIB::SegmentationExtractorInterface, 179 m_returnCode
m_masks OFIQ_LIB::OFIQError, 159
OFIQ_LIB::SegmentationExtractorInterface, 179 m_rtree
m_measure OFIQ_LIB::modules::measures::Sharpness, 192
OFIQ_LIB::modules::measures::Measure, 142 m_scaledHeight
m_measures OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation,
OFIQ_LIB::modules::measures::Executor, 84 108
m_memoryInfo m_scaledWidth
ONNXRuntimeSegmentation, 166 OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation,
m_message 108
OFIQ_LIB::OFIQError, 159 m_segmentationImage
m_minimalRelativeFaceSize OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation,
OFIQ_LIB::modules::detectors::SSDFaceDetector, 108
199 OFIQ_LIB::modules::segmentations::FaceParsing,
m_modelConfigItem 113
OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation,
m_sigmoidMap
107 OFIQ_LIB::modules::measures::Measure, 142
OFIQ_LIB::modules::segmentations::FaceParsing, m_t0
113 OFIQ_LIB::modules::measures::NoHeadCoverings,
m_modelFile 156
OFIQ_LIB::modules::measures::Sharpness, 192 m_t1
m_numberOfInputElements OFIQ_LIB::modules::measures::NoHeadCoverings,
OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2, 156
119 m_targetHeight
m_numTrees OFIQ_LIB::modules::measures::BackgroundUniformity,
OFIQ_LIB::modules::measures::Sharpness, 192 68
m_onnxRuntimeEnv m_targetWidth
OFIQ_LIB::modules::measures::CompressionArtifacts, OFIQ_LIB::modules::measures::BackgroundUniformity,
73 68
OFIQ_LIB::modules::measures::UnifiedQualityScore, m_useAligned
204 OFIQ_LIB::modules::measures::Sharpness, 192
OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation,
m_w
107 OFIQ_LIB::modules::measures::NoHeadCoverings,
OFIQ_LIB::modules::segmentations::FaceParsing, 156
113 m_x0
m_onnxRuntimeEnvCNN1 OFIQ_LIB::modules::measures::NoHeadCoverings,
OFIQ_LIB::modules::measures::ExpressionNeutrality, 157
87 mainpage.h, 205
m_onnxRuntimeEnvCNN2 MakeGreyImage
OFIQ_LIB::modules::measures::ExpressionNeutrality, OFIQ_LIB, 48
87 makeSquareBoundingBox
m_ortenv OFIQ_LIB, 49
OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2,
makeSquareBoundingBoxWithPadding
119 OFIQ_LIB, 49
ONNXRuntimeSegmentation, 166 MarginAboveOfTheFaceImage
m_ortSession OFIQ, 40

Generated by Doxygen
INDEX 295

MarginBelowOfTheFaceImage OFIQ, 41
OFIQ, 40 NotInitialized
Measure OFIQ, 40
OFIQ_LIB::modules::measures::Measure, 137 NotSet
Measure.h, 249, 250 OFIQ, 39, 40
MeasureFactory
OFIQ_LIB::modules::measures::MeasureFactory, OFIQ, 37
143 BackgroundUniformity, 39
MeasureFactory.h, 251, 252 CompressionArtifacts, 40
MissingConfigParamError CropOfTheFaceImage, 40
OFIQ, 41 DynamicRange, 40
mouth ExpressionNeutrality, 40
OFIQ_LIB::modules::segmentations, 61 EyesOpen, 40
MOUTH_CENTER EyesVisible, 40
OFIQ_LIB::modules::landmarks, 54 FaceDetectionError, 41
MOUTH_INNER FaceDetectorType, 39
OFIQ_LIB::modules::landmarks, 54 FaceLandmarkExtractionError, 41
MOUTH_OUTER FaceOcclusionPrevention, 40
OFIQ_LIB::modules::landmarks, 54 FaceOcclusionSegmentationError, 41
MouthClosed FaceParsingError, 41
OFIQ, 40 FailureToAssess, 40
OFIQ_LIB::modules::measures::MouthClosed, 145 HeadPose, 40
MouthClosed.h, 253, 254 HeadPosePitch, 40
mouthInner HeadPoseRoll, 40
OFIQ_LIB::modules::landmarks::adnet, 56 HeadPoseYaw, 40
MouthOcclusionPrevention HeadSize, 40
OFIQ, 40 IlluminationUniformity, 39
ImageReadingError, 41
OFIQ_LIB::modules::measures::MouthOcclusionPrevention,
147 ImageWritingError, 41
MouthOcclusionPrevention.h, 254, 255 InterEyeDistance, 40
mouthOuter Landmarks, 38
OFIQ_LIB::modules::landmarks::adnet, 56 LandmarkType, 39
LeftwardCropOfTheFaceImage, 40
NaturalColour LM_98, 39
OFIQ, 40 Luminance, 39
OFIQ_LIB::modules::measures::NaturalColour, LuminanceMean, 39
149 LuminanceVariance, 39
NaturalColour.h, 255, 256 MarginAboveOfTheFaceImage, 40
neck MarginBelowOfTheFaceImage, 40
OFIQ_LIB::modules::segmentations, 61 MissingConfigParamError, 41
neck_l MouthClosed, 40
OFIQ_LIB::modules::segmentations, 61 MouthOcclusionPrevention, 40
networks NaturalColour, 40
OFIQ_LIB::OFIQImpl, 163 NoHeadCoverings, 40
NeuronalNetworkContainer NotImplemented, 41
OFIQ_LIB::NeuronalNetworkContainer, 152 NotInitialized, 40
NeuronalNetworkContainer.h, 280 NotSet, 39, 40
NoHeadCoverings OPENCVSSD, 39
OFIQ, 40 operator<<, 41
OFIQ_LIB::modules::measures::NoHeadCoverings, OverExposurePrevention, 39
155 QualityAssessmentError, 41
NoHeadCoverings.h, 257, 258 QualityAssessments, 38
nose QualityMeasure, 39
OFIQ_LIB::modules::segmentations, 61 QualityMeasureReturnCode, 40
NOSETIP ReturnCode, 40
OFIQ_LIB::modules::landmarks, 54 RightwardCropOfTheFaceImage, 40
nosetip Sharpness, 40
OFIQ_LIB::modules::landmarks::adnet, 56 SingleFacePresent, 40
NotImplemented Success, 40, 41

Generated by Doxygen
296 INDEX

UnderExposurePrevention, 39 Cubic, 47
UnifiedQualityScore, 39 EulerAngle, 43
UnknownConfigParamError, 41 ExposureRange, 43
UnknownError, 41 findLargestBoundingBox, 47
OFIQ::BoundingBox, 69 GetLuminanceImageFromBGR, 48
BoundingBox, 69 GetNormalizedHistogram, 48
faceDetector, 70 MakeGreyImage, 48
height, 70 makeSquareBoundingBox, 49
width, 70 makeSquareBoundingBoxWithPadding, 49
xleft, 70 readImage, 49
ytop, 70 tmetric, 51
OFIQ::FaceImageQualityAssessment, 94 ofiq_lib.h, 206, 207
boundingBox, 95 OFIQ_EXPORT, 207
FaceImageQualityAssessment, 94 OFIQ_LIB::Configuration, 74
qAssessments, 95 Configuration, 75
OFIQ::FaceLandmarks, 97 GetBool, 75
FaceLandmarks, 97 getDataDir, 76
landmarks, 97 GetNumber, 76
type, 97 GetString, 77
OFIQ::Image, 124 GetStringList, 78
data, 125 m_dataDir, 78
depth, 125 parameters, 78
height, 125 SetDataDir, 78
Image, 124 OFIQ_LIB::FaceDetectorInterface, 92
size, 125 ∼FaceDetectorInterface, 93
width, 125 detectFaces, 93
OFIQ::Interface, 128 UpdateFaces, 93
∼Interface, 129 OFIQ_LIB::FaceLandmarkExtractorInterface, 95
getImplementation, 129 ∼FaceLandmarkExtractorInterface, 96
getVersion, 129 extractLandmarks, 96
initialize, 129 updateLandmarks, 96
scalarQuality, 130 OFIQ_LIB::modules, 51
vectorQuality, 130 OFIQ_LIB::modules::detectors, 51
OFIQ::LandmarkPoint, 132 OFIQ_LIB::modules::detectors::SSDFaceDetector, 197
LandmarkPoint, 132 ∼SSDFaceDetector, 199
x, 133 m_confidenceThreshold, 199
y, 133 m_dnnNet, 199
OFIQ::QualityMeasureResult, 174 m_minimalRelativeFaceSize, 199
code, 175 m_padding, 200
QualityMeasureResult, 174 SSDFaceDetector, 198
rawScore, 175 UpdateFaces, 199
scalar, 175 OFIQ_LIB::modules::landmarks, 52
OFIQ::ReturnStatus, 175 CHIN, 54
code, 176 FACE_CONTOUR, 54
info, 176 FaceMap, 53
ReturnStatus, 176 FacePairMap, 53
OFIQ_EXPORT FaceParts, 54
ofiq_lib.h, 207 FOREHEAD, 54
OFIQ_LIB, 41 LandmarkId, 53
alignImage, 43 LandmarkIdPair, 53
CalculateExposure, 44 LandmarkIdPairs, 53
calculateEyeCenter, 44 LandmarkIds, 53
CalculateReferencePoints, 44 LEFT_EYE, 54
CalculateRegionOfInterest, 45 LEFT_EYE_CORNERS, 54
ColorConvert, 45 MOUTH_CENTER, 54
ComputeBrightnessAspect, 46 MOUTH_INNER, 54
ConvertBGRToCIELAB, 46 MOUTH_OUTER, 54
copyToCvImage, 46 NOSETIP, 54

Generated by Doxygen
INDEX 297

RIGHT_EYE, 54 m_dim, 73
RIGHT_EYE_CORNERS, 54 m_onnxRuntimeEnv, 73
OFIQ_LIB::modules::landmarks::adnet, 54 OFIQ_LIB::modules::measures::CropOfTheFaceImage,
chin, 55 79
contour, 55 CropOfTheFaceImage, 80
FaceMap, 55 Execute, 81
FacePairMap, 55 OFIQ_LIB::modules::measures::DynamicRange, 81
forehead, 56 DynamicRange, 82
leftEye, 56 Execute, 83
leftEyeCorners, 56 OFIQ_LIB::modules::measures::Executor, 83
mouthInner, 56 ExecuteAll, 84
mouthOuter, 56 Executor, 84
nosetip, 56 GetMeasures, 84
pairsInnerLip, 56 m_measures, 84
pairsLeftEye, 57 OFIQ_LIB::modules::measures::ExpressionNeutrality,
pairsMouthCenter, 57 85
pairsRightEye, 57 Execute, 87
rightEye, 57 ExpressionNeutrality, 86
rightEyeCorners, 58 m_classifier, 87
OFIQ_LIB::modules::landmarks::ADNetFaceLandmarkExtractor,m_onnxRuntimeEnvCNN1, 87
63 m_onnxRuntimeEnvCNN2, 87
∼ADNetFaceLandmarkExtractor, 64 OFIQ_LIB::modules::measures::EyesOpen, 88
ADNetFaceLandmarkExtractor, 64 Execute, 89
landmarkExtractor_, 65 EyesOpen, 89
updateLandmarks, 64 OFIQ_LIB::modules::measures::EyesVisible, 90
OFIQ_LIB::modules::landmarks::FaceMeasures, 98 Execute, 92
FaceMeasures, 98 EyesVisible, 91
GetDistance, 98, 99 OFIQ_LIB::modules::measures::FaceOcclusionPrevention,
GetFaceMask, 99 102
GetMaxPairDistance, 99 Execute, 103
GetMiddle, 100, 101 FaceOcclusionPrevention, 103
InterEyeDistance, 101 OFIQ_LIB::modules::measures::HeadPose, 114
OFIQ_LIB::modules::landmarks::LandmarkPair, 131 Execute, 115
LandmarkPair, 131 HeadPose, 115
Lower, 132 OFIQ_LIB::modules::measures::HeadSize, 120
Upper, 132 Execute, 121
OFIQ_LIB::modules::landmarks::PartExtractor, 169 HeadSize, 121
getFacePart, 169 OFIQ_LIB::modules::measures::IlluminationUniformity,
getPairsForPart, 170 122
OFIQ_LIB::modules::measures, 58 Execute, 123
ExecutorLogActive, 60 IlluminationUniformity, 123
log, 59 OFIQ_LIB::modules::measures::InterEyeDistance, 126
OFIQ_LIB::modules::measures::BackgroundUniformity, Execute, 127
65 InterEyeDistance, 127
BackgroundUniformity, 67 OFIQ_LIB::modules::measures::Luminance, 133
Execute, 67 Execute, 135
m_cropBottom, 67 Luminance, 134
m_cropLeft, 67 OFIQ_LIB::modules::measures::Measure, 135
m_cropRight, 68 ∼Measure, 137
m_cropTop, 68 AddSigmoid, 138
m_erosionKernelSize, 68 configuration, 142
m_targetHeight, 68 Execute, 138
m_targetWidth, 68 ExecuteScalarConversion, 139
OFIQ_LIB::modules::measures::CompressionArtifacts, ExpandKey, 139
71 GetMeasureName, 140
CompressionArtifacts, 72 GetName, 140
Execute, 73 GetQualityMeasure, 140
m_crop, 73 m_measure, 142

Generated by Doxygen
298 INDEX

m_sigmoidMap, 142 OFIQ_LIB::modules::measures::UnderExposurePrevention,

Measure, 137 200
ScalarConversion, 140 Execute, 202
SetQualityMeasure, 141 UnderExposurePrevention, 201
Sigmoid, 141 OFIQ_LIB::modules::measures::UnifiedQualityScore,
OFIQ_LIB::modules::measures::MeasureFactory, 142 202
CreateMeasure, 143 Execute, 204
MeasureFactory, 143 m_onnxRuntimeEnv, 204
OFIQ_LIB::modules::measures::MouthClosed, 143 UnifiedQualityScore, 203
Execute, 145 OFIQ_LIB::modules::poseEstimators, 60
MouthClosed, 145 OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2,
OFIQ_LIB::modules::measures::MouthOcclusionPrevention, 116
146 ∼HeadPose3DDFAV2, 117
Execute, 147 CropImage, 118
MouthOcclusionPrevention, 147 HeadPose3DDFAV2, 117
OFIQ_LIB::modules::measures::NaturalColour, 148 m_expectedImageHeight, 118
CalculateScore, 150 m_expectedImageNumberOfChannels, 118
CreateMaskedImage, 150 m_expectedImageWidth, 119
Execute, 150 m_inputShape, 119
NaturalColour, 149 m_numberOfInputElements, 119
ReduceImageToRegionOfInterest, 151 m_ortenv, 119
OFIQ_LIB::modules::measures::NoHeadCoverings, 154 m_ortSession, 119
Execute, 156 m_paramPoseEstimatorModel, 119
m_t0, 156 updatePose, 118
m_t1, 156 OFIQ_LIB::modules::segmentations, 60
m_w, 156 background, 61
m_x0, 157 cloth, 61
NoHeadCoverings, 155 ear_r, 61
OFIQ_LIB::modules::measures::OverExposurePrevention, eye_g, 61
167 face, 61
Execute, 169 hair, 61
OverExposurePrevention, 168 hat, 61
OFIQ_LIB::modules::measures::Sharpness, 189 l_brow, 61
Execute, 191 l_ear, 61
GetClassifierFocusFeatures, 191 l_eye, 61
GetCroppedImages, 191 l_lip, 61
m_faceRegionAlpha, 192 mouth, 61
m_modelFile, 192 neck, 61
m_numTrees, 192 neck_l, 61
m_rtree, 192 nose, 61
m_useAligned, 192 r_brow, 61
Sharpness, 190 r_ear, 61
OFIQ_LIB::modules::measures::SigmoidParameters, r_eye, 61
193 SegmentClassLabels, 61
a, 194 skin, 61
h, 194 u_lip, 61
Reset, 194 OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation,
round, 194 104
s, 195 ∼FaceOcclusionSegmentation, 106
setInverse, 194 FaceOcclusionSegmentation, 105
SigmoidParameters, 194 GetFaceOcclusionSegmentation, 106
w, 195 m_cropBottom, 107
x0, 195 m_cropLeft, 107
OFIQ_LIB::modules::measures::SingleFacePresent, m_cropRight, 107
195 m_cropTop, 107
Execute, 197 m_modelConfigItem, 107
SingleFacePresent, 197 m_onnxRuntimeEnv, 107
m_scaledHeight, 108

Generated by Doxygen
INDEX 299

m_scaledWidth, 108 OFIQ_LIB::SegmentationExtractorInterface, 177

m_segmentationImage, 108 ∼SegmentationExtractorInterface, 178
UpdateMask, 106 GetLastSessionId, 178
OFIQ_LIB::modules::segmentations::FaceParsing, 108 GetMask, 178
∼FaceParsing, 110 m_lastSessionId, 179
CalculateClassIds, 111 m_masks, 179
CreateBlob, 111 UpdateMask, 178
FaceParsing, 110 OFIQ_LIB::Session, 179
m_cropBottom, 112 assessment, 182
m_cropLeft, 112 GenerateId, 182
m_cropRight, 112 getAlignedFace, 182
m_cropTop, 113 getAlignedFaceLandmarkedRegion, 182
m_imageSize, 113 getAlignedFaceLandmarks, 182
m_modelConfigItem, 113 getAlignedFaceTransformationMatrix, 183
m_onnxRuntimeEnv, 113 getDetectedFaces, 183
m_segmentationImage, 113 getFaceOcclusionSegmentationImage, 183
SetImage, 111 getFaceParsingImage, 183
UpdateMask, 112 getLandmarks, 183
OFIQ_LIB::NeuronalNetworkContainer, 151 getPose, 184
faceDetector, 153 Id, 184
faceOcclusionExtractor, 153 image, 184
landmarkExtractor, 153 m_alignedFace, 187
NeuronalNetworkContainer, 152 m_alignedFacelandmarkedRegion, 187
poseEstimator, 153 m_alignedFaceLandmarks, 187
segmentationExtractor, 153 m_alignedFaceTransformationMatrix, 187
OFIQ_LIB::OFIQError, 157 m_assessment, 187
m_extendedMessage, 159 m_detectedFaces, 187
m_message, 159 m_faceOcclusionSegmentationImage, 187
m_returnCode, 159 m_faceParsingImage, 188
OFIQError, 158 m_id, 188
what, 158 m_image, 188
whatCode, 158 m_landmarks, 188
OFIQ_LIB::OFIQImpl, 159 m_pose, 188
∼OFIQImpl, 160 Session, 181
alignFaceImage, 161 setAlignedFace, 184
config, 163 setAlignedFaceLandmarkedRegion, 185
CreateExecutor, 161 setAlignedFaceLandmarks, 185
CreateNetworks, 161 setAlignedFaceTransformationMatrix, 185
dummyAssement, 163 setDetectedFaces, 185
dummyImage, 163 setFaceOcclusionSegmentationImage, 186
initialize, 161 setFaceParsingImage, 186
m_emptySession, 163 setLandmarks, 186
m_executorPtr, 163 setPose, 186
networks, 163 ofiq_lib_impl.h, 207, 208
OFIQImpl, 160 ofiq_structs.h, 209, 211
performPreprocessing, 162 OFIQError
scalarQuality, 162 OFIQ_LIB::OFIQError, 158
vectorQuality, 162 OFIQError.h, 281, 282
OFIQ_LIB::Point2i, 171 OFIQImpl
x, 171 OFIQ_LIB::OFIQImpl, 160
y, 171 ONNXRTSegmentation.h, 272, 273
OFIQ_LIB::PoseEstimatorInterface, 172 ONNXRuntimeSegmentation, 164
∼PoseEstimatorInterface, 173 ∼ONNXRuntimeSegmentation, 165
estimatePose, 173 getNumberOfOutputNodes, 165
EulerAngle, 172 init_session, 165
m_lastSessionId, 173 initialize, 166
m_pose, 173 m_inputShape, 166
updatePose, 173 m_memoryInfo, 166

Generated by Doxygen
300 INDEX

m_ortenv, 166 ReduceImageToRegionOfInterest

m_ortSession, 166 OFIQ_LIB::modules::measures::NaturalColour,
ONNXRuntimeSegmentation, 165 151
run, 166 Reset
Open Source Face Image Quality (OFIQ) Library, 1 OFIQ_LIB::modules::measures::SigmoidParameters,
opencv_ssd_face_detector.h, 216, 217 194
OPENCVSSD ReturnCode
OFIQ, 39 OFIQ, 40
operator<< ReturnStatus
OFIQ, 41 OFIQ::ReturnStatus, 176
OverExposurePrevention RIGHT_EYE
OFIQ, 39 OFIQ_LIB::modules::landmarks, 54
OFIQ_LIB::modules::measures::OverExposurePrevention,
RIGHT_EYE_CORNERS
168 OFIQ_LIB::modules::landmarks, 54
OverExposurePrevention.h, 258, 259 rightEye
OFIQ_LIB::modules::landmarks::adnet, 57
pairsInnerLip rightEyeCorners
OFIQ_LIB::modules::landmarks::adnet, 56 OFIQ_LIB::modules::landmarks::adnet, 58
pairsLeftEye RightwardCropOfTheFaceImage
OFIQ_LIB::modules::landmarks::adnet, 57 OFIQ, 40
pairsMouthCenter round
OFIQ_LIB::modules::landmarks::adnet, 57 OFIQ_LIB::modules::measures::SigmoidParameters,
pairsRightEye 194
OFIQ_LIB::modules::landmarks::adnet, 57 run
parameters ONNXRuntimeSegmentation, 166
OFIQ_LIB::Configuration, 78
PartExtractor.h, 227, 228 s
performPreprocessing OFIQ_LIB::modules::measures::SigmoidParameters,
OFIQ_LIB::OFIQImpl, 162 195
Point2f, 170 scalar
x, 171 OFIQ::QualityMeasureResult, 175
y, 171 ScalarConversion
poseEstimator OFIQ_LIB::modules::measures::Measure, 140
OFIQ_LIB::NeuronalNetworkContainer, 153 scalarQuality
poseEstimators.h, 267, 268 OFIQ::Interface, 130
OFIQ_LIB::OFIQImpl, 162
qAssessments segmentationExtractor
OFIQ::FaceImageQualityAssessment, 95 OFIQ_LIB::NeuronalNetworkContainer, 153
QualityAssessmentError segmentations.h, 273, 275
OFIQ, 41 SegmentClassLabels
QualityAssessments OFIQ_LIB::modules::segmentations, 61
OFIQ, 38 Session
QualityMeasure OFIQ_LIB::Session, 181
OFIQ, 39 Session.h, 282, 283
QualityMeasureResult setAlignedFace
OFIQ::QualityMeasureResult, 174 OFIQ_LIB::Session, 184
QualityMeasureReturnCode setAlignedFaceLandmarkedRegion
OFIQ, 40 OFIQ_LIB::Session, 185
setAlignedFaceLandmarks
r_brow OFIQ_LIB::Session, 185
OFIQ_LIB::modules::segmentations, 61 setAlignedFaceTransformationMatrix
r_ear OFIQ_LIB::Session, 185
OFIQ_LIB::modules::segmentations, 61 SetDataDir
r_eye OFIQ_LIB::Configuration, 78
OFIQ_LIB::modules::segmentations, 61 setDetectedFaces
rawScore OFIQ_LIB::Session, 185
OFIQ::QualityMeasureResult, 175 setFaceOcclusionSegmentationImage
readImage OFIQ_LIB::Session, 186
OFIQ_LIB, 49 setFaceParsingImage

Generated by Doxygen
INDEX 301

OFIQ_LIB::Session, 186 OFIQ_LIB::FaceDetectorInterface, 93

SetImage OFIQ_LIB::modules::detectors::SSDFaceDetector,
OFIQ_LIB::modules::segmentations::FaceParsing, 199
111 updateLandmarks
setInverse OFIQ_LIB::FaceLandmarkExtractorInterface, 96
OFIQ_LIB::modules::measures::SigmoidParameters, OFIQ_LIB::modules::landmarks::ADNetFaceLandmarkExtractor,
194 64
setLandmarks UpdateMask
OFIQ_LIB::Session, 186 OFIQ_LIB::modules::segmentations::FaceOcclusionSegmentation,
setPose 106
OFIQ_LIB::Session, 186 OFIQ_LIB::modules::segmentations::FaceParsing,
SetQualityMeasure 112
OFIQ_LIB::modules::measures::Measure, 141 OFIQ_LIB::SegmentationExtractorInterface, 178
Sharpness updatePose
OFIQ, 40 OFIQ_LIB::modules::poseEstimators::HeadPose3DDFAV2,
OFIQ_LIB::modules::measures::Sharpness, 190 118
Sharpness.h, 259, 260 OFIQ_LIB::PoseEstimatorInterface, 173
Sigmoid Upper
OFIQ_LIB::modules::measures::Measure, 141 OFIQ_LIB::modules::landmarks::LandmarkPair,
SigmoidParameters 132
OFIQ_LIB::modules::measures::SigmoidParameters, utils.h, 284, 286
194
SingleFacePresent vectorQuality
OFIQ, 40 OFIQ::Interface, 130
OFIQ_LIB::modules::measures::SingleFacePresent, OFIQ_LIB::OFIQImpl, 162
197
SingleFacePresent.h, 261, 262 w
size OFIQ_LIB::modules::measures::SigmoidParameters,
OFIQ::Image, 125 195
skin what
OFIQ_LIB::modules::segmentations, 61 OFIQ_LIB::OFIQError, 158
SSDFaceDetector whatCode
OFIQ_LIB::modules::detectors::SSDFaceDetector, OFIQ_LIB::OFIQError, 158
198 width
Success OFIQ::BoundingBox, 70
OFIQ, 40, 41 OFIQ::Image, 125

tmetric x
OFIQ_LIB, 51 OFIQ::LandmarkPoint, 133
type OFIQ_LIB::Point2i, 171
OFIQ::FaceLandmarks, 97 Point2f, 171
x0
u_lip OFIQ_LIB::modules::measures::SigmoidParameters,
OFIQ_LIB::modules::segmentations, 61 195
UnderExposurePrevention xleft
OFIQ, 39 OFIQ::BoundingBox, 70
OFIQ_LIB::modules::measures::UnderExposurePrevention,
201 y
UnderExposurePrevention.h, 262, 263 OFIQ::LandmarkPoint, 133
UnifiedQualityScore OFIQ_LIB::Point2i, 171
OFIQ, 39 Point2f, 171
OFIQ_LIB::modules::measures::UnifiedQualityScore, ytop
203 OFIQ::BoundingBox, 70
UnifiedQualityScore.h, 263, 264
UnknownConfigParamError
OFIQ, 41
UnknownError
OFIQ, 41
UpdateFaces

Generated by Doxygen