facedetector.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam
 *
 * Date        : 2010-09-02
 * Description : A convenience class for a standalone face detector
 *
 * Copyright (C)      2010 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C)      2010 by Aditya Bhatt <adityabhatt1991 at gmail dot com>
 * Copyright (C) 2010-2022 by Gilles Caulier <caulier dot gilles 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_FACESENGINE_FACEDETECTOR_H
#define DIGIKAM_FACESENGINE_FACEDETECTOR_H
 
// Qt includes
 
#include <QExplicitlySharedDataPointer>
#include <QImage>
#include <QVariant>
 
// Local includes
 
#include "digikam_export.h"
#include "dimg.h"
 
namespace Digikam
{
 
class DIGIKAM_EXPORT FaceDetector
{
 
public:
 
    FaceDetector();
    FaceDetector(const FaceDetector& other);
    ~FaceDetector();
 
    QString backendIdentifier()                                     const;
 
    FaceDetector& operator=(const FaceDetector& other);
 
    QList<QRectF> detectFaces(const QImage& image, const QSize& originalSize = QSize());
 
    QList<QRectF> detectFaces(const DImg& image, const QSize& originalSize = QSize());
 
    QList<QRectF> detectFaces(const QString& imagePath);
 
    void        setParameter(const QString& parameter, const QVariant& value);
    void        setParameters(const QVariantMap& parameters);
    QVariantMap parameters()                                        const;
 
    int recommendedImageSize(const QSize& availableSize = QSize())  const;
 
    static QRectF        toRelativeRect(const QRect& absoluteRect, const QSize& size);
    static QRect         toAbsoluteRect(const QRectF& relativeRect, const QSize& size);
    static QList<QRectF> toRelativeRects(const QList<QRect>& absoluteRects, const QSize& size);
    static QList<QRect>  toAbsoluteRects(const QList<QRectF>& relativeRects, const QSize& size);
 
private:
 
    class Private;
    QExplicitlySharedDataPointer<Private> d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_FACESENGINE_FACEDETECTOR_H