imagehistogram.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2004-07-21
 * Description : image histogram manipulation methods.
 *
 * Copyright (C) 2004-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_IMAGE_HISTOGRAM_H
#define DIGIKAM_IMAGE_HISTOGRAM_H
 
// Qt includes
 
#include <QObject>
#include <QEvent>
#include <QThread>
 
// Local includes
 
#include "digikam_export.h"
#include "dynamicthread.h"
 
namespace Digikam
{
 
class DImg;
 
class DIGIKAM_EXPORT ImageHistogram : public DynamicThread
{
    Q_OBJECT
 
public:
 
    explicit ImageHistogram(const DImg& img, QObject* const parent = nullptr);
    ~ImageHistogram() override;
 
    void calculate();
    void calculateInThread();
 
    void stopCalculation();
    bool isCalculating()                               const;
 
    bool   isSixteenBit()                              const;
    bool   isValid()                                   const;
 
    double getCount(int channel, int start, int end)   const;
    double getMean(int channel, int start, int end)    const;
    double getPixels()                                 const;
    double getStdDev(int channel, int start, int end)  const;
    double getValue(int channel, int bin)              const;
    double getMaximum(int channel, int start, int end) const;
 
    int    getHistogramSegments()                      const;
    int    getMaxSegmentIndex()                        const;
    int    getMedian(int channel, int start, int end)  const;
 
Q_SIGNALS:
 
    void calculationFinished(bool success);
 
    void calculationAboutToStart();
 
    void calculationStarted();
 
protected:
 
    void run() override;
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_IMAGE_HISTOGRAM_H