mne_videobrowser.browse_raw_with_video#

mne_videobrowser.browse_raw_with_video(raw_browser: MNEQtBrowser, raw: Raw, videos: list[VideoFile], video_aligners: list[TimestampAligner], secondary_raw_browsers: list[MNEQtBrowser] | None = None, secondary_raws: list[Raw] | None = None, raw_aligners: list[TimestampAligner] | None = None, video_splitter_orientation: Literal['horizontal', 'vertical'] = 'horizontal', show: bool = True, max_sync_fps: int = 10, parent: QObject | None = None, block: bool = True) → SyncedRawMediaBrowser[source]#

Synchronize MNE raw data browser(s) with a video browser.

Parameters:

  • raw_browser (mne_qt_browser.figure.MNEQtBrowser) – The primary MNE raw data browser object to be synchronized with the video browser. This can be created with ‘plot’ method of MNE raw data object when using qt backend. This will act as the master browser controlling the synchronization.

  • raw (mne.io.Raw) – The MNE raw data object that was used to create the raw_browser.

  • videos (list[VideoFile]) – The video file object(s) to be displayed in the video browser.

  • video_aligners (list[TimestampAligner]) – A list of TimestampAligner instances, one for each video file. Each aligner provides the mapping between raw data time points and video frames for the corresponding video file. The order of the aligners must match the order of the video files in the videos parameter.

  • secondary_raw_browsers (list[mne_qt_browser.figure.MNEQtBrowser] | None, optional) – Optional list of secondary MNE raw data browsers to be synchronized with the primary raw data browser and video browser. If provided, secondary_raws and raw_aligners must also be provided.

  • secondary_raws (list[mne.io.Raw] | None, optional) – The MNE raw data objects that were used to create the secondary_raw_browsers. Must have the same length as secondary_raw_browsers if provided.

  • raw_aligners (list[TimestampAligner] | None, optional) – A list of TimestampAligner instances, one for each secondary raw data browser. Each aligner provides the mapping between primary raw data time points and secondary raw data time points for the corresponding secondary raw browser. Must have the same length as secondary_raw_browsers if provided.

  • video_splitter_orientation (Literal["horizontal", "vertical"], optional) – Whether to show multiple videos in a horizontal or vertical layout. This has no effect if only one video is provided.

  • max_sync_fps (int, optional) – The maximum frames per second for synchronizing the raw data browser and video browser. This determines how often the synchronization updates can happen and has an effect on the performance.

  • show (bool, optional) – Whether to show the raw data browser immediately upon instantiation, by default True.

  • parent (QObject, optional) – The parent QObject for this synchronized browser, by default None.

  • block (bool, optional) – Whether to automatically start the Qt event loop and block until the application is closed, by default True. If False, the caller is responsible for managing the QApplication event loop.

Returns:

An instance of SyncedRawMediaBrowser, a Qt controller object that handles synchronization between the raw data browser(s) and the video browser.

Return type:

SyncedRawMediaBrowser

On this page

This Page