opencvdnnfacerecognizer.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam
 *
 * Date        : 2020-05-22
 * Description : Wrapper of face recognition using OpenFace
 *
 * Copyright (C) 2019      by Thanh Trung Dinh <dinhthanhtrung1996 at gmail dot com>
 * Copyright (C) 2020-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 * Copyright (C) 2020      by Nghia Duong <minhnghiaduong997 at gmail dot com>
 *
 * This program is free software; you can redistribute it
 * and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation;
 * either version 2, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * ============================================================ */
 
#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,
    };
 
    explicit OpenCVDNNFaceRecognizer(Classifier method = Tree);
    ~OpenCVDNNFaceRecognizer();
 
public:
 
    static cv::Mat prepareForRecognition(QImage& inputImage);
 
    static cv::Mat prepareForRecognition(const cv::Mat& cvinputImage);
 
    void train(const QList<QImage*>& images, const int label, const QString& context);
 
    int recognize(QImage* inputImage);
 
    QVector<int> recognize(const QList<QImage*>& inputImages);
 
    void clearTraining(const QList<int>& idsToClear, const QString& trainingContext);
 
    void setNbNeighBors(int k);
 
    void setThreshold(float threshold);
 
    bool registerTrainingData(const cv::Mat& preprocessedImage, int label);
 
    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