digiKam Developer Documentation
Professional Photo Management with the Power of Open Source
Loading...
Searching...
No Matches
Digikam::FaceScanSettings Class Reference

Public Types

enum  AlreadyScannedHandling { Skip , Rescan , ClearAll , RecognizeOnly }
 To detect and recognize. More...
 
enum  FaceDetectionModel { SSDMOBILENET , YOLOv3 , YuNet }
 Face detection AI models. More...
 
enum  FaceDetectionSize {
  ExtraSmall , Small , Medium , Large ,
  ExtraLarge
}
 Face detection size.
 
enum  FaceRecognitionModel { OpenFace , SFace }
 Face recognition AI models. More...
 
enum  ScanTask { DetectAndRecognize , RecognizeMarkedFaces , RetrainAll , Reset }
 Different possible tasks processed while scanning operation. More...
 

Public Attributes

AlbumList albums
 Albums to scan.
 
AlreadyScannedHandling alreadyScannedHandling = Skip
 
int detectAccuracy = DNN_MODEL_THRESHOLD_NOT_SET
 Detection accuracy.
 
FaceDetectionModel detectModel = FaceDetectionModel::YuNet
 Detection Model.
 
FaceDetectionSize detectSize = FaceDetectionSize::Large
 Detection Model.
 
ItemInfoList infos
 Image infos to scan.
 
int recognizeAccuracy = DNN_MODEL_THRESHOLD_NOT_SET
 Detection accuracy.
 
FaceRecognitionModel recognizeModel = FaceRecognitionModel::SFace
 Detection Model.
 
ScanTask task = DetectAndRecognize
 
bool useFullCpu = false
 Processing power.
 
bool wholeAlbums = false
 Whole albums checked.
 

Member Enumeration Documentation

◆ AlreadyScannedHandling

Enumerator
Skip 

Skip faces from images already scanned.

Rescan 

Rescan faces from images already scanned.

ClearAll 

Clear all faces data from images already scanned. Clear identities and training data from FacesDb.

RecognizeOnly 

Recognize faces from images already scanned.

◆ FaceDetectionModel

Enumerator
SSDMOBILENET 

SSD MobileNet neural network inference [https://github.com/arunponnusamy/cvlib].

YOLOv3 

YOLO neural network inference [https://github.com/sthanhng/yoloface].

YuNet 

YuNet neural network inference [https://github.com/opencv/opencv_zoo/tree/main].

◆ FaceRecognitionModel

Enumerator
OpenFace 

OpenFace pre-trained neural network model [https://github.com/sahilshah/openface/tree/master].

SFace 

SFace pre-trained neural network model [https://github.com/opencv/opencv_zoo/blob/main/models/face_recognition_sface/].

◆ ScanTask

Enumerator
DetectAndRecognize 

Detect and recognize faces only.

RecognizeMarkedFaces 

Recognize already marked faces only.

RetrainAll 

Retrain faces only.

Member Data Documentation

◆ detectAccuracy

int Digikam::FaceScanSettings::detectAccuracy = DNN_MODEL_THRESHOLD_NOT_SET

use default value from dnnmodels.conf

◆ recognizeAccuracy

int Digikam::FaceScanSettings::recognizeAccuracy = DNN_MODEL_THRESHOLD_NOT_SET

use default value from dnnmodels.conf