channeldataview.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef CHANNELDATAVIEW_H
#define CHANNELDATAVIEW_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "../disp_global.h"
#include "abstractview.h"
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QMap>
#include <QRect>
#include <QSharedPointer>
#include <QStringList>
#include <QVector>
 
#include "helpers/channelrhiview.h"
#include "helpers/overviewbarwidget.h"
#include "helpers/timerulerwidget.h"
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
#include <Eigen/Core>
 
//=============================================================================================================
// FORWARD DECLARATIONS
//=============================================================================================================
 
class QScrollBar;
class QSplitter;
class QToolButton;
 
namespace FIFFLIB {
    class FiffInfo;
}
 
//=============================================================================================================
// DEFINE NAMESPACE DISPLIB
//=============================================================================================================
 
namespace DISPLIB
{
 
//=============================================================================================================
// DISPLIB FORWARD DECLARATIONS
//=============================================================================================================
 
enum class DetrendMode;
class ChannelDataModel;
class ChannelLabelPanel;
class TimeRulerWidget;
 
//=============================================================================================================
class DISPSHARED_EXPORT ChannelDataView : public AbstractView
{
    Q_OBJECT
 
public:
    typedef QSharedPointer<ChannelDataView>       SPtr;
    typedef QSharedPointer<const ChannelDataView> ConstSPtr;
 
    //=========================================================================================================
    explicit ChannelDataView(const QString &sSettingsPath = QString(),
                             QWidget *parent = nullptr,
                             Qt::WindowFlags f = Qt::Widget);
 
    ~ChannelDataView() override;
 
    // ── Initialisation ────────────────────────────────────────────────
 
    //=========================================================================================================
    void init(QSharedPointer<FIFFLIB::FiffInfo> pInfo);
 
    // ── Data management ───────────────────────────────────────────────
 
    //=========================================================================================================
    void setData(const Eigen::MatrixXd &data, int firstSample = 0);
 
    //=========================================================================================================
    void addData(const Eigen::MatrixXd &data);
 
    // ── Scroll / zoom API ─────────────────────────────────────────────
 
    //=========================================================================================================
    void scrollToSample(int sample, bool animate = true);
 
    //=========================================================================================================
    void setWindowSize(float seconds);
 
    //=========================================================================================================
    float windowSize() const;
 
    //=========================================================================================================
    void setZoom(double factor);
 
    //=========================================================================================================
    double zoom() const;
 
    // ── Visual properties ─────────────────────────────────────────────
 
    //=========================================================================================================
    void setBackgroundColor(const QColor &color);
    QColor backgroundColor() const;
 
    //=========================================================================================================
    void setSignalColor(const QColor &color);
    QColor signalColor() const;
 
    //=========================================================================================================
    void setScalingMap(const QMap<qint32, float> &scaleMap);
    QMap<qint32, float> scalingMap() const;
 
    //=========================================================================================================
    void hideBadChannels(bool hide);
    bool badChannelsHidden() const;
 
    //=========================================================================================================
    void setChannelFilter(const QStringList &names);
 
    //=========================================================================================================
    void setRemoveDC(bool dc);
 
    //=========================================================================================================
    void setDetrendMode(DetrendMode mode);
    DetrendMode detrendMode() const;
 
    //=========================================================================================================
    void setFileBounds(int first, int last);
 
    //=========================================================================================================
    void setEvents(const QVector<ChannelRhiView::EventMarker> &events);
 
    void setEpochMarkers(const QVector<int> &triggerSamples);
    void setEpochMarkersVisible(bool visible);
    bool epochMarkersVisible() const;
 
    void setClippingVisible(bool visible);
    bool clippingVisible() const;
 
    void setZScoreMode(bool enabled);
    bool zScoreMode() const;
 
    //=========================================================================================================
    void setReferenceMarkers(const QVector<TimeRulerReferenceMark> &markers);
 
    //=========================================================================================================
    void setAnnotations(const QVector<ChannelRhiView::AnnotationSpan> &annotations);
 
    //=========================================================================================================
    void setAnnotationSelectionEnabled(bool enabled);
 
    void setEventsVisible(bool visible);
    bool eventsVisible() const;
 
    void setAnnotationsVisible(bool visible);
    bool annotationsVisible() const;
 
    void setOverviewBarVisible(bool visible);
    bool overviewBarVisible() const;
 
    void setScrollSpeedFactor(float factor);
    float scrollSpeedFactor() const;
 
    void sortChannelsByType();
    void resetChannelOrder();
 
    // ── Interactive inspection features ───────────────────────────────
 
    //=========================================================================================================
    void setCrosshairEnabled(bool enabled);
    bool crosshairEnabled() const;
 
    //=========================================================================================================
    void setScalebarsVisible(bool visible);
    bool scalebarsVisible() const;
 
    //=========================================================================================================
    void setButterflyMode(bool enabled);
    bool butterflyMode() const;
 
    //=========================================================================================================
    void toggleTimeFormat();
 
    //=========================================================================================================
    void setClockTimeFormat(bool useClock);
    bool clockTimeFormat() const;
 
    // ── AbstractView overrides ────────────────────────────────────────
    void saveSettings() override;
    void loadSettings() override;
    void clearView()    override;
 
    //=========================================================================================================
    int firstVisibleSample() const;
    int visibleSampleCount() const;
 
    //=========================================================================================================
    QRect signalViewportRect() const;
 
    //=========================================================================================================
    int sampleToViewportX(int sample) const;
 
    //=========================================================================================================
    int viewportXToSample(int x) const;
 
    //=========================================================================================================
    ChannelDataModel* model() const { return m_pModel.data(); }
 
signals:
    //=========================================================================================================
    void sampleClicked(int sample);
 
    //=========================================================================================================
    void scrollPositionChanged(int sample);
 
    //=========================================================================================================
    void sampleRangeSelected(int startSample, int endSample);
 
    //=========================================================================================================
    void annotationBoundaryMoved(int annotationIndex, bool isStartBoundary, int newSample);
 
    //=========================================================================================================
    void referenceMarkerAddRequested(int sample);
 
    //=========================================================================================================
    void referenceMarkerRemoveRequested(int sample);
 
    //=========================================================================================================
    void referenceMarkersClearRequested();
 
    void crosshairToggled(bool on);
    void butterflyToggled(bool on);
    void scalebarsToggled(bool on);
    void eventsVisibleToggled(bool on);
    void annotationsVisibleToggled(bool on);
    void overviewBarToggled(bool on);
    void scrollSpeedChanged(float factor);
    void epochMarkersToggled(bool on);
    void clippingToggled(bool on);
    void zScoreModeToggled(bool on);
 
    //=========================================================================================================
    void cursorDataChanged(float timeSec, float amplitude,
                           const QString &channelName, const QString &unitLabel);
 
protected:
    void updateGuiMode(GuiMode mode) override;
    void updateProcessingMode(ProcessingMode mode) override;
    void keyPressEvent(QKeyEvent *event) override;
    void resizeEvent(QResizeEvent *event) override;
 
private slots:
    void onScrollBarMoved(int value);
    void onRhiScrollChanged(float sample);
    void updateScrollBarRange();
    void onChannelScrollBarMoved(int value);
    void onChannelOffsetChanged(int firstChannel);
    void updateChannelScrollBarRange();
 
private:
    void setupLayout();
    void updateSamplesPerPixel();
 
    QString                          m_sSettingsPath;
    QSharedPointer<ChannelDataModel> m_pModel;
    ChannelLabelPanel*               m_pLabelPanel          = nullptr;
    ChannelRhiView*                  m_pRhiView             = nullptr;
    TimeRulerWidget*                 m_pTimeRuler           = nullptr;
    OverviewBarWidget*               m_pOverviewBar         = nullptr;
    QWidget*                         m_pRulerHeader         = nullptr;
    QScrollBar*                      m_pScrollBar           = nullptr;
    QScrollBar*                      m_pChannelScrollBar    = nullptr;
    QToolButton*                     m_pScrollModeButton    = nullptr;
 
    bool m_channelScrollBarUpdating = false;
 
    QSharedPointer<FIFFLIB::FiffInfo> m_pFiffInfo;
    QMap<qint32, float>               m_scaleMap;
    QColor                            m_signalColor { Qt::darkGreen };
    QColor                            m_bgColor     { 250, 250, 250 };
 
    float  m_windowSizeSeconds  = 10.f;
    double m_zoomFactor         = 1.0;
    bool   m_hideBadChannels    = false;
    bool   m_scrollBarUpdating  = false; // re-entrance guard
 
    int    m_firstFileSample    = -1;    // -1 = not yet set (fall back to model)
    int    m_lastFileSample     = -1;    // -1 = not yet set
};
 
} // namespace DISPLIB
 
#endif // CHANNELDATAVIEW_H