ecvHistogramWindow.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// -                        CloudViewer: www.cloudViewer.org                  -
// ----------------------------------------------------------------------------
// Copyright (c) 2018-2024 www.cloudViewer.org
// SPDX-License-Identifier: MIT
// ----------------------------------------------------------------------------
 
#pragma once
 
// Qt
#include <QDialog>
 
// CV_DB_LIB
#include <ecvScalarField.h>
 
// QCustomPlot
#include <qcustomplot.h>
 
class QCPArrow;
class QCPBarsWithText;
class QCPColoredBars;
class QCPHiddenArea;
class QCPTextElement;
 
class Ui_HistogramDialog;
 
class ccHistogramWindow : public QCustomPlot {
    Q_OBJECT
 
public:
    explicit ccHistogramWindow(QWidget* parent = 0);
 
    virtual ~ccHistogramWindow();
 
    void setTitle(const QString& str);
    void setAxisLabels(const QString& xLabel, const QString& yLabel);
 
 
    void fromSF(ccScalarField* sf,
                unsigned initialNumberOfClasses = 0,
                bool numberOfClassesCanBeChanged = true,
                bool showNaNValuesInGrey = true);
 
 
    void fromBinArray(const std::vector<unsigned>& histoValues,
                      double minVal,
                      double maxVal);
 
 
    void setCurveValues(const std::vector<double>& curveValues);
 
    enum HISTOGRAM_COLOR_SCHEME {
        USE_SOLID_COLOR,
        USE_CUSTOM_COLOR_SCALE,
        USE_SF_SCALE
    };
    void setColorScheme(HISTOGRAM_COLOR_SCHEME scheme) {
        m_colorScheme = scheme;
    }
 
 
    void setSolidColor(QColor color) { m_solidColor = color; }
 
    void setColorScale(ccColorScale::Shared scale) { m_colorScale = scale; }
 
    void clear();
    void refresh();
 
    void refreshBars();
 
    inline const std::vector<unsigned>& histoValues() const {
        return m_histoValues;
    }
    inline double minVal() const { return m_minVal; }
    inline double maxVal() const { return m_maxVal; }
 
public:  // Axis label display Options
    enum class AxisDisplayOption {
        None = 0x0,
        XAxis = 0x01,
        YAxis = 0x02,
        All = XAxis | YAxis
    };
    Q_DECLARE_FLAGS(AxisDisplayOptions, AxisDisplayOption)
 
    // SF interactor mode
    enum class SFInteractionMode {
        None = 0x0,
        DisplayRange = 0x01,
        SaturationRange = 0x02,
        All = DisplayRange | SaturationRange
    };
    Q_DECLARE_FLAGS(SFInteractionModes, SFInteractionMode)
 
    
    void setSFInteractionMode(SFInteractionModes modes);
    void setAxisDisplayOption(AxisDisplayOptions axisOptions);
    // Used to disable automatic refresh after resize event
    // Must refresh manually from client code if this is set to false
    void setRefreshAfterResize(bool refreshAfterResize);
 
    void setMinDispValue(double);
    void setMaxDispValue(double);
    void setMinSatValue(double);
    void setMaxSatValue(double);
 
signals:
 
    void sfMinDispValChanged(double);
    void sfMaxDispValChanged(double);
    void sfMinSatValChanged(double);
    void sfMaxSatValChanged(double);
 
protected:  // methods
 
    void setNumberOfClasses(size_t n);
 
    // mouse events handling
    void mousePressEvent(QMouseEvent* event);
    void mouseMoveEvent(QMouseEvent* event);
    void wheelEvent(QWheelEvent* event);
    void resizeEvent(QResizeEvent* event);
 
    unsigned getMaxHistoVal();
 
    void clearInternal();
 
    bool computeBinArrayFromSF(size_t binCount);
 
    void updateOverlayCurveWidth(int w, int h);
 
protected:  // attributes
    // Title
    QString m_titleStr;
    QCPTextElement* m_titlePlot;
 
    HISTOGRAM_COLOR_SCHEME m_colorScheme;
    QColor m_solidColor;
    ccColorScale::Shared m_colorScale;
 
    ccScalarField* m_associatedSF;
    // Whether the number of classes can be changed or not
    bool m_numberOfClassesCanBeChanged;
 
    bool m_refreshAfterResize;
 
    // histogram data
    QCPColoredBars* m_histogram;
    std::vector<unsigned> m_histoValues;
    double m_minVal;
    double m_maxVal;
    unsigned m_maxHistoVal;
 
    QCPGraph* m_overlayCurve;
    std::vector<double> m_curveValues;
 
    // vertical indicator
    QCPBarsWithText* m_vertBar;
    bool m_drawVerticalIndicator;
    double m_verticalIndicatorPositionPercent;
 
    QFont m_renderingFont;
 
    AxisDisplayOptions m_axisDisplayOptions;
 
protected:  // SF interactor mode
    SFInteractionModes m_sfInteractionModes;
 
    enum SELECTABLE_ITEMS {
        NONE,
        LEFT_AREA,
        RIGHT_AREA,
        BOTH_AREAS,
        LEFT_ARROW,
        RIGHT_ARROW,
        BOTH_ARROWS
    };
    SELECTABLE_ITEMS m_selectedItem;
 
    QCPHiddenArea* m_areaLeft;
    double m_areaLeftlastValue;
    QCPHiddenArea* m_areaRight;
    double m_areaRightlastValue;
 
    QCPArrow* m_arrowLeft;
    double m_arrowLeftlastValue;
    QCPArrow* m_arrowRight;
    double m_arrowRightlastValue;
 
    QPoint m_lastMouseClick;
};
 
class ccHistogramWindowDlg : public QDialog {
    Q_OBJECT
 
public:
    explicit ccHistogramWindowDlg(QWidget* parent = 0);
    virtual ~ccHistogramWindowDlg();
 
    inline ccHistogramWindow* window() { return m_win; }
 
    bool exportToCSV(QString filename) const;
 
protected:
    void onExportToCSV();
 
    void onExportToImage();
 
protected:
    // Associated histogram window
    ccHistogramWindow* m_win;
 
    Ui_HistogramDialog* m_gui;
};