Composite real-time multi-channel raw scroller assembling label panel, table view, time ruler and scrollbars.
More...
#include <channeldataview.h>
Composite real-time multi-channel raw scroller assembling label panel, table view, time ruler and scrollbars.
Acts as the user-facing host of the ChannelDataModel and RtFiffRawViewDelegate pair, exposing playback / zoom / channel-selection signals consumed by the surrounding plugin GUI.
Definition at line 88 of file channeldataview.h.
◆ ConstSPtr
◆ SPtr
◆ ChannelDataView()
| ChannelDataView::ChannelDataView |
( |
const QString & | sSettingsPath = QString(), |
|
|
QWidget * | parent = nullptr, |
|
|
Qt::WindowFlags | f = Qt::Widget ) |
|
explicit |
Constructs a ChannelDataView.
- Parameters
-
| [in] | sSettingsPath | QSettings prefix for persistent GUI settings. |
| [in] | parent | Parent widget. |
| [in] | f | Window flags. |
Definition at line 132 of file channeldataview.cpp.
◆ ~ChannelDataView()
| ChannelDataView::~ChannelDataView |
( |
| ) |
|
|
override |
◆ addData()
| void ChannelDataView::addData |
( |
const Eigen::MatrixXd & | data | ) |
|
Append new samples (real-time streaming use-case).
- Parameters
-
| [in] | data | Channels × new-samples matrix. |
Definition at line 433 of file channeldataview.cpp.
◆ annotationBoundaryMoved
| void DISPLIB::ChannelDataView::annotationBoundaryMoved |
( |
int | annotationIndex, |
|
|
bool | isStartBoundary, |
|
|
int | newSample ) |
|
signal |
Emitted when the user drags an annotation boundary to a new position.
◆ annotationsVisible()
| bool ChannelDataView::annotationsVisible |
( |
| ) |
const |
◆ annotationsVisibleToggled
| void DISPLIB::ChannelDataView::annotationsVisibleToggled |
( |
bool | on | ) |
|
|
signal |
◆ backgroundColor()
| QColor ChannelDataView::backgroundColor |
( |
| ) |
const |
◆ badChannelsHidden()
| bool ChannelDataView::badChannelsHidden |
( |
| ) |
const |
◆ butterflyMode()
| bool ChannelDataView::butterflyMode |
( |
| ) |
const |
◆ butterflyToggled
| void DISPLIB::ChannelDataView::butterflyToggled |
( |
bool | on | ) |
|
|
signal |
◆ clearView()
| void ChannelDataView::clearView |
( |
| ) |
|
|
overridevirtual |
◆ clippingToggled
| void DISPLIB::ChannelDataView::clippingToggled |
( |
bool | on | ) |
|
|
signal |
◆ clippingVisible()
| bool ChannelDataView::clippingVisible |
( |
| ) |
const |
◆ clockTimeFormat()
| bool ChannelDataView::clockTimeFormat |
( |
| ) |
const |
◆ crosshairEnabled()
| bool ChannelDataView::crosshairEnabled |
( |
| ) |
const |
◆ crosshairToggled
| void DISPLIB::ChannelDataView::crosshairToggled |
( |
bool | on | ) |
|
|
signal |
◆ cursorDataChanged
| void DISPLIB::ChannelDataView::cursorDataChanged |
( |
float | timeSec, |
|
|
float | amplitude, |
|
|
const QString & | channelName, |
|
|
const QString & | unitLabel ) |
|
signal |
Forwarded from the underlying ChannelRhiView when the crosshair is active.
◆ detrendMode()
◆ epochMarkersToggled
| void DISPLIB::ChannelDataView::epochMarkersToggled |
( |
bool | on | ) |
|
|
signal |
◆ epochMarkersVisible()
| bool ChannelDataView::epochMarkersVisible |
( |
| ) |
const |
◆ eventsVisible()
| bool ChannelDataView::eventsVisible |
( |
| ) |
const |
◆ eventsVisibleToggled
| void DISPLIB::ChannelDataView::eventsVisibleToggled |
( |
bool | on | ) |
|
|
signal |
◆ firstVisibleSample()
| int ChannelDataView::firstVisibleSample |
( |
| ) |
const |
◆ hideBadChannels()
| void ChannelDataView::hideBadChannels |
( |
bool | hide | ) |
|
Show or hide channels marked bad.
- Parameters
-
| [in] | hide | If true, bad channels are collapsed to zero height. |
Definition at line 528 of file channeldataview.cpp.
◆ init()
Initialise the view from a FiffInfo (channel names, types, sampling rate).
- Parameters
-
| [in] | pInfo | Shared pointer to FiffInfo. |
Definition at line 375 of file channeldataview.cpp.
◆ keyPressEvent()
| void ChannelDataView::keyPressEvent |
( |
QKeyEvent * | event | ) |
|
|
overrideprotected |
◆ loadSettings()
| void ChannelDataView::loadSettings |
( |
| ) |
|
|
overridevirtual |
◆ model()
Returns the underlying data model (non-owning pointer). Use for advanced configuration such as setMaxStoredSamples().
Definition at line 391 of file channeldataview.h.
◆ overviewBarToggled
| void DISPLIB::ChannelDataView::overviewBarToggled |
( |
bool | on | ) |
|
|
signal |
◆ overviewBarVisible()
| bool ChannelDataView::overviewBarVisible |
( |
| ) |
const |
◆ referenceMarkerAddRequested
| void DISPLIB::ChannelDataView::referenceMarkerAddRequested |
( |
int | sample | ) |
|
|
signal |
Emitted when the ruler context menu requests a new sample marker.
◆ referenceMarkerRemoveRequested
| void DISPLIB::ChannelDataView::referenceMarkerRemoveRequested |
( |
int | sample | ) |
|
|
signal |
Emitted when the ruler context menu requests removal of a nearby sample marker.
◆ referenceMarkersClearRequested
| void DISPLIB::ChannelDataView::referenceMarkersClearRequested |
( |
| ) |
|
|
signal |
Emitted when the ruler context menu requests clearing all sample markers.
◆ resetChannelOrder()
| void ChannelDataView::resetChannelOrder |
( |
| ) |
|
◆ resizeEvent()
| void ChannelDataView::resizeEvent |
( |
QResizeEvent * | event | ) |
|
|
overrideprotected |
◆ sampleClicked
| void DISPLIB::ChannelDataView::sampleClicked |
( |
int | sample | ) |
|
|
signal |
Emitted when the user clicks on a sample position.
- Parameters
-
| [in] | sample | Absolute sample index under the cursor. |
◆ sampleRangeSelected
| void DISPLIB::ChannelDataView::sampleRangeSelected |
( |
int | startSample, |
|
|
int | endSample ) |
|
signal |
Emitted when the user selected a sample range for annotation creation.
◆ sampleToViewportX()
| int ChannelDataView::sampleToViewportX |
( |
int | sample | ) |
const |
Maps an absolute sample index to an x coordinate inside the signal viewport.
- Parameters
-
| [in] | sample | Absolute sample index. |
- Returns
- x position in ChannelDataView-local coordinates.
Definition at line 859 of file channeldataview.cpp.
◆ saveSettings()
| void ChannelDataView::saveSettings |
( |
| ) |
|
|
overridevirtual |
◆ scalebarsToggled
| void DISPLIB::ChannelDataView::scalebarsToggled |
( |
bool | on | ) |
|
|
signal |
◆ scalebarsVisible()
| bool ChannelDataView::scalebarsVisible |
( |
| ) |
const |
◆ scalingMap()
| QMap< qint32, float > ChannelDataView::scalingMap |
( |
| ) |
const |
◆ scrollPositionChanged
| void DISPLIB::ChannelDataView::scrollPositionChanged |
( |
int | sample | ) |
|
|
signal |
Emitted whenever the scroll position changes.
- Parameters
-
| [in] | sample | Current left-edge sample index. |
◆ scrollSpeedChanged
| void DISPLIB::ChannelDataView::scrollSpeedChanged |
( |
float | factor | ) |
|
|
signal |
◆ scrollSpeedFactor()
| float ChannelDataView::scrollSpeedFactor |
( |
| ) |
const |
◆ scrollToSample()
| void ChannelDataView::scrollToSample |
( |
int | sample, |
|
|
bool | animate = true ) |
Scroll to the given absolute sample index.
- Parameters
-
| [in] | sample | Target left-edge sample. |
| [in] | animate | If true, animate with a smooth cubic ease-out. |
Definition at line 441 of file channeldataview.cpp.
◆ setAnnotations()
Set the list of annotation spans to display as translucent overlays.
- Parameters
-
| [in] | annotations | List of AnnotationSpan objects. |
Definition at line 659 of file channeldataview.cpp.
◆ setAnnotationSelectionEnabled()
| void ChannelDataView::setAnnotationSelectionEnabled |
( |
bool | enabled | ) |
|
Enable or disable annotation span selection in the raw browser.
Definition at line 669 of file channeldataview.cpp.
◆ setAnnotationsVisible()
| void ChannelDataView::setAnnotationsVisible |
( |
bool | visible | ) |
|
◆ setBackgroundColor()
| void ChannelDataView::setBackgroundColor |
( |
const QColor & | color | ) |
|
Set the background colour of the rendering surface.
- Parameters
-
| [in] | color | New background colour. |
Definition at line 480 of file channeldataview.cpp.
◆ setButterflyMode()
| void ChannelDataView::setButterflyMode |
( |
bool | enabled | ) |
|
◆ setChannelFilter()
| void ChannelDataView::setChannelFilter |
( |
const QStringList & | names | ) |
|
Restrict the view to a named subset of channels. Channels not in names are hidden immediately. Pass an empty list to restore all channels.
- Parameters
-
| [in] | names | List of channel names to show (case-sensitive). |
Definition at line 547 of file channeldataview.cpp.
◆ setClippingVisible()
| void ChannelDataView::setClippingVisible |
( |
bool | visible | ) |
|
◆ setClockTimeFormat()
| void ChannelDataView::setClockTimeFormat |
( |
bool | useClock | ) |
|
◆ setCrosshairEnabled()
| void ChannelDataView::setCrosshairEnabled |
( |
bool | enabled | ) |
|
Enable or disable the crosshair cursor with coordinate readout.
Definition at line 769 of file channeldataview.cpp.
◆ setData()
| void ChannelDataView::setData |
( |
const Eigen::MatrixXd & | data, |
|
|
int | firstSample = 0 ) |
Replace all buffered data.
- Parameters
-
| [in] | data | Channels × samples matrix. |
| [in] | firstSample | Absolute sample index of column 0. |
Definition at line 425 of file channeldataview.cpp.
◆ setDetrendMode()
| void ChannelDataView::setDetrendMode |
( |
DetrendMode | mode | ) |
|
Set the detrending mode for on-the-fly trend removal during rendering. None = raw, Mean = DC offset, Linear = least-squares linear fit.
- Parameters
-
Definition at line 577 of file channeldataview.cpp.
◆ setEpochMarkers()
| void ChannelDataView::setEpochMarkers |
( |
const QVector< int > & | triggerSamples | ) |
|
◆ setEpochMarkersVisible()
| void ChannelDataView::setEpochMarkersVisible |
( |
bool | visible | ) |
|
◆ setEvents()
Set the list of event / stimulus markers to display as coloured vertical lines. Pass an empty vector to clear all markers.
- Parameters
-
| [in] | events | List of EventMarker objects. |
Definition at line 591 of file channeldataview.cpp.
◆ setEventsVisible()
| void ChannelDataView::setEventsVisible |
( |
bool | visible | ) |
|
◆ setFileBounds()
| void ChannelDataView::setFileBounds |
( |
int | first, |
|
|
int | last ) |
Set the absolute sample indices of the file's first and last samples. The scrollbar range and mouse-pan clamp use these to prevent scrolling outside the actual file boundaries regardless of the ring-buffer state.
- Parameters
-
| [in] | first | Absolute sample index of the file's first sample. |
| [in] | last | Absolute sample index of the file's last sample. |
Definition at line 406 of file channeldataview.cpp.
◆ setOverviewBarVisible()
| void ChannelDataView::setOverviewBarVisible |
( |
bool | visible | ) |
|
◆ setReferenceMarkers()
Set the list of persistent sample/reference markers shown in the time ruler.
- Parameters
-
| [in] | markers | Reference markers to display in the ruler. |
Definition at line 651 of file channeldataview.cpp.
◆ setRemoveDC()
| void ChannelDataView::setRemoveDC |
( |
bool | dc | ) |
|
Enable or disable DC (mean) removal applied at render time. Takes effect immediately — the view redraws with the current data.
- Parameters
-
| [in] | dc | true = subtract per-channel mean from each rendered window. |
Definition at line 570 of file channeldataview.cpp.
◆ setScalebarsVisible()
| void ChannelDataView::setScalebarsVisible |
( |
bool | visible | ) |
|
◆ setScalingMap()
| void ChannelDataView::setScalingMap |
( |
const QMap< qint32, float > & | scaleMap | ) |
|
Set the per-channel-type amplitude scale map. Keys should be FIFF channel kind constants (FIFFV_MEG_CH, FIFFV_EEG_CH, …).
- Parameters
-
| [in] | scaleMap | Map from FIFF kind to physical amplitude (e.g. 1.2e-12 for MEG). |
Definition at line 513 of file channeldataview.cpp.
◆ setScrollSpeedFactor()
| void ChannelDataView::setScrollSpeedFactor |
( |
float | factor | ) |
|
◆ setSignalColor()
| void ChannelDataView::setSignalColor |
( |
const QColor & | color | ) |
|
Set the default signal line colour (used for channel types without a type-specific colour).
- Parameters
-
| [in] | color | New signal colour. |
Definition at line 497 of file channeldataview.cpp.
◆ setWindowSize()
| void ChannelDataView::setWindowSize |
( |
float | seconds | ) |
|
Set the visible time window (in seconds). This adjusts samplesPerPixel to fit the requested duration.
- Parameters
-
| [in] | seconds | Duration of the visible window. |
Definition at line 448 of file channeldataview.cpp.
◆ setZoom()
| void ChannelDataView::setZoom |
( |
double | factor | ) |
|
Set the zoom factor (> 1 = zoom in, < 1 = zoom out relative to default).
- Parameters
-
| [in] | factor | Zoom multiplier applied to the default samples-per-pixel. |
Definition at line 464 of file channeldataview.cpp.
◆ setZScoreMode()
| void ChannelDataView::setZScoreMode |
( |
bool | enabled | ) |
|
◆ signalColor()
| QColor ChannelDataView::signalColor |
( |
| ) |
const |
◆ signalViewportRect()
| QRect ChannelDataView::signalViewportRect |
( |
| ) |
const |
Returns the geometry of the actual QRHI signal viewport in ChannelDataView-local coordinates.
Definition at line 852 of file channeldataview.cpp.
◆ sortChannelsByType()
| void ChannelDataView::sortChannelsByType |
( |
| ) |
|
◆ toggleTimeFormat()
| void ChannelDataView::toggleTimeFormat |
( |
| ) |
|
Toggle time format between float seconds and HH:MM:SS clock time.
Definition at line 810 of file channeldataview.cpp.
◆ updateGuiMode()
| void ChannelDataView::updateGuiMode |
( |
GuiMode | mode | ) |
|
|
overrideprotectedvirtual |
◆ updateProcessingMode()
◆ viewportXToSample()
| int ChannelDataView::viewportXToSample |
( |
int | x | ) |
const |
Maps a ChannelDataView-local x coordinate inside the signal viewport to an absolute sample index.
- Parameters
-
| [in] | x | ChannelDataView-local x coordinate. |
- Returns
- Absolute sample index at the requested x position.
Definition at line 878 of file channeldataview.cpp.
◆ visibleSampleCount()
| int ChannelDataView::visibleSampleCount |
( |
| ) |
const |
◆ windowSize()
| float ChannelDataView::windowSize |
( |
| ) |
const |
◆ zoom()
| double ChannelDataView::zoom |
( |
| ) |
const |
◆ zScoreMode()
| bool ChannelDataView::zScoreMode |
( |
| ) |
const |
◆ zScoreModeToggled
| void DISPLIB::ChannelDataView::zScoreModeToggled |
( |
bool | on | ) |
|
|
signal |
The documentation for this class was generated from the following files: