File indexing completed on 2025-03-09 03:55:01

 /* ============================================================
  *
  * This file is a part of digiKam
  *
  * Date        : 2020-05-22
  * Description : Wrapper of face recognition using OpenFace
  *
  * SPDX-FileCopyrightText: 2019      by Thanh Trung Dinh <dinhthanhtrung1996 at gmail dot com>
  * SPDX-FileCopyrightText: 2020-2024 by Gilles Caulier <caulier dot gilles at gmail dot com>
  * SPDX-FileCopyrightText: 2020      by Nghia Duong <minhnghiaduong997 at gmail dot com>
  *
  * SPDX-License-Identifier: GPL-2.0-or-later
  *
  * ============================================================ */
 
 #ifndef OPENCV_DNN_FACERECOGNIZER_H
 #define OPENCV_DNN_FACERECOGNIZER_H
 
 // Qt includes
 
 #include <QImage>
 
 // Local includes
 
 #include "digikam_opencv.h"
 #include "digikam_export.h"
 #include "identity.h"
 
 namespace Digikam
 {
 
 class DIGIKAM_GUI_EXPORT OpenCVDNNFaceRecognizer
 {
 public:
 
     enum Classifier
     {
         SVM = 0,
         OpenCV_KNN,
         Tree,
         DB,
     };
 
     /**
      *  @brief OpenCVDNNFaceRecognizer:Master class to control entire recognition using OpenFace algorithm
      */
     explicit OpenCVDNNFaceRecognizer(Classifier method = Tree);
     ~OpenCVDNNFaceRecognizer();
 
 public:
 
     /**
      *  Returns a cvMat created from the inputImage, optimized for recognition
      */
     static cv::Mat prepareForRecognition(QImage& inputImage);
 
     /**
      *  Returns a cvMat created from the cvinputImage, optimized for recognition
      */
     static cv::Mat prepareForRecognition(const cv::Mat& cvinputImage);
 
     /**
      * Register faces corresponding to an identity
      */
     void train(const QList<QImage*>& images, const int label, const QString& context);
 
     /**
      * Try to recognize the given image.
      * Returns the identity id.
      * If the identity cannot be recognized, returns -1.
      * TODO: verify workflow to economize this routine
      */
     int recognize(QImage* inputImage);
 
     /**
      * Try to recognize a list of given images.
      * Returns a list of identity ids.
      * If an identity cannot be recognized, returns -1.
      */
     QVector<int> recognize(const QList<QImage*>& inputImages);
 
     /**
      * clear specified trained data
      */
     void clearTraining(const QList<int>& idsToClear, const QString& trainingContext);
 
     /**
      * set K parameter of K-Nearest neighbors algorithm
      */
     void setNbNeighBors(int k);
 
     /**
      * set maximum square distance of 2 vector
      */
     void setThreshold(float threshold);
 
     /**
      * @brief register training data for unit test
      */
     bool registerTrainingData(const cv::Mat& preprocessedImage, int label);
 
     /**
      * @brief predict label of test data for unit test
      */
     int verifyTestData(const cv::Mat& preprocessedImage);
 
 private:
 
     // Disable
     OpenCVDNNFaceRecognizer(const OpenCVDNNFaceRecognizer&)            = delete;
     OpenCVDNNFaceRecognizer& operator=(const OpenCVDNNFaceRecognizer&) = delete;
 
 private:
 
     class Private;
     Private* d;
 };
 
 } // namespace Digikam
 
 #endif // OPENCV_DNN_FACERECOGNIZER_H