digiKam
Loading...
Searching...
No Matches
Digikam::FaceScanSettings Class Reference

#include <facescansettings.h>

Public Types

enum  AlreadyScannedHandling { Skip , Merge , Rescan , ClearAll }
 
enum  FaceDetectionModel { SSDMOBILENET , YOLOv3 , YuNet }
 
enum  FaceDetectionSize {
  ExtraSmall , Small , Medium , Large ,
  ExtraLarge
}
 
enum  FaceRecognitionModel { OpenFace , SFace }
 
enum  ScanTask {
  Detect , DetectAndRecognize , RecognizeMarkedFaces , RetrainAll ,
  BenchmarkDetection , BenchmarkRecognition
}
 

Public Member Functions

 FaceScanSettings ()
 
 ~FaceScanSettings ()
 

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::Medium
 Detection Model.
 
ItemInfoList infos
 Image infos to scan.
 
int recognizeAccuracy = DNN_MODEL_THRESHOLD_NOT_SET
 Detection accuracy.
 
FaceRecognitionModel recognizeModel = FaceRecognitionModel::OpenFace
 Detection Model.
 
ScanTask task = Detect
 
bool useFullCpu = false
 Processing power.
 
bool wholeAlbums = false
 Whole albums checked.
 

Member Enumeration Documentation

◆ AlreadyScannedHandling

To detect and recognize.

Enumerator
Skip 

Skip faces from images already scanned.

Merge 

Merge 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.

◆ FaceDetectionModel

Face detection AI models.

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].

◆ FaceDetectionSize

Face detection size.

Enumerator
ExtraSmall 
Small 
Medium 
Large 
ExtraLarge 

◆ FaceRecognitionModel

Face recognition AI models.

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

Different possible tasks processed while scanning operation.

Enumerator
Detect 

Detect faces only.

DetectAndRecognize 

Detect and recognize faces only.

RecognizeMarkedFaces 

Recognize already marked faces only.

RetrainAll 

Retrain faces only.

BenchmarkDetection 

Bench performances of detect faces.

BenchmarkRecognition 

Bench performance of recognize faces.

Constructor & Destructor Documentation

◆ FaceScanSettings()

Digikam::FaceScanSettings::FaceScanSettings ( )

◆ ~FaceScanSettings()

Digikam::FaceScanSettings::~FaceScanSettings ( )

Member Data Documentation

◆ albums

◆ alreadyScannedHandling

◆ detectAccuracy

int Digikam::FaceScanSettings::detectAccuracy = DNN_MODEL_THRESHOLD_NOT_SET

◆ detectModel

◆ detectSize

◆ infos

◆ recognizeAccuracy

int Digikam::FaceScanSettings::recognizeAccuracy = DNN_MODEL_THRESHOLD_NOT_SET

◆ recognizeModel

◆ task

◆ useFullCpu

bool Digikam::FaceScanSettings::useFullCpu = false

◆ wholeAlbums

bool Digikam::FaceScanSettings::wholeAlbums = false

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