facedb.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam
 *
 * Date        : 02-02-2012
 * Description : Face database interface to train identities.
 *
 * Copyright (C) 2012-2013 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2010-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 DIGIKAM_FACE_DB_H
#define DIGIKAM_FACE_DB_H
 
// C++ includes
 
#include <vector>
 
// Qt includes
 
#include <QString>
#include <QFile>
#include <QDataStream>
#include <QStandardPaths>
 
// Local includes
 
#include "digikam_config.h"
#include "digikam_opencv.h"
#include "identity.h"
#include "facedbbackend.h"
 
namespace Digikam
{
 
class KDTree;
 
class FaceDb
{
public:
 
    explicit FaceDb(FaceDbBackend* const db);
    ~FaceDb();
 
    BdEngineBackend::QueryState setSetting(const QString& keyword, const QString& value);
    QString setting(const QString& keyword)                                     const;
 
    bool integrityCheck();
 
    void vacuum();
 
public:
 
    // --- Identity management (facedb_identity.cpp)
 
    int  addIdentity()                                                          const;
    int  getNumberOfIdentities()                                                const;
 
    void updateIdentity(const Identity& p);
    void deleteIdentity(int id);
    void deleteIdentity(const QString& uuid);
    void clearIdentities();
 
    QList<Identity> identities()                                                const;
    QList<int>      identityIds()                                               const;
 
public:
 
    // --- OpenCV DNN
 
    int insertFaceVector(const cv::Mat& faceEmbedding,
                         const int label,
                         const QString& context)                                const;
 
    KDTree* reconstructTree()                                                   const;
 
    cv::Ptr<cv::ml::TrainData> trainData()                                      const;
 
    bool insertToTreeDb(const int nodeID,
                        const cv::Mat& faceEmbedding)                           const;
 
    QMap<double, QVector<int> > getClosestNeighborsTreeDb(const cv::Mat& position,
                                                          float sqRange,
                                                          float cosThreshold,
                                                          int maxNbNeighbors)   const;
 
    void clearTreeDb()                                                          const;
 
    void clearDNNTraining(const QString& context = QString());
    void clearDNNTraining(const QList<int>& identities, const QString& context = QString());
 
private:
 
    void updateRangeTreeDb(int nodeId,
                           cv::Mat& minRange,
                           cv::Mat& maxRange,
                           const cv::Mat& position)                             const;
    int findParentTreeDb(const cv::Mat& nodePos,
                         bool& leftChild,
                         int& parentSplitAxis)                                  const;
 
    class DataNode;
 
    double getClosestNeighborsTreeDb(const DataNode& subTree,
                                     QMap<double, QVector<int> >& neighborList,
                                     const cv::Mat& position,
                                     float sqRange,
                                     float cosThreshold,
                                     int maxNbNeighbors)                        const;
 
private:
 
    // Disable
    FaceDb(const FaceDb&)            = delete;
    FaceDb& operator=(const FaceDb&) = delete;
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_FACE_DB_H