nwb-video-widgets 0.1.0__py3-none-any.whl → 0.1.2__py3-none-any.whl

nwb_video_widgets/dandi_video_widget.py

@@ -32,9 +32,19 @@ class NWBDANDIVideoPlayer(anywidget.AnyWidget):
     nwbfile : pynwb.NWBFile, optional
         Pre-loaded NWB file to avoid re-loading. If not provided, the widget
         will load the NWB file via streaming.
+    video_grid : list[list[str]], optional
+        A 2D grid layout specifying which videos to display and where.
+        Each inner list represents a row of videos. When provided, bypasses
+        the interactive settings panel and displays videos in the specified
+        grid arrangement. Video names that don't exist are silently skipped.
+    video_labels : dict[str, str], optional
+        Mapping of video names to custom display labels. If a video name is
+        not in the dictionary, the original video name is displayed.
 
     Example
     -------
+    Interactive mode (default):
+
     >>> from dandi.dandiapi import DandiAPIClient
     >>> client = DandiAPIClient()
     >>> dandiset = client.get_dandiset("000409", "draft")
@@ -48,6 +58,23 @@ class NWBDANDIVideoPlayer(anywidget.AnyWidget):
     ...     asset=asset,
     ...     nwbfile=already_loaded_nwbfile,
     ... )
+
+    Fixed grid mode (single row):
+
+    >>> widget = NWBDANDIVideoPlayer(
+    ...     asset=asset,
+    ...     video_grid=[["VideoLeftCamera", "VideoBodyCamera", "VideoRightCamera"]]
+    ... )
+
+    Fixed grid mode (2x2 grid):
+
+    >>> widget = NWBDANDIVideoPlayer(
+    ...     asset=asset,
+    ...     video_grid=[
+    ...         ["VideoLeftCamera", "VideoRightCamera"],
+    ...         ["VideoBodyCamera"],
+    ...     ]
+    ... )
     """
 
     video_urls = traitlets.Dict({}).tag(sync=True)
@@ -56,6 +83,8 @@ class NWBDANDIVideoPlayer(anywidget.AnyWidget):
     selected_videos = traitlets.List([]).tag(sync=True)
     layout_mode = traitlets.Unicode("row").tag(sync=True)
     settings_open = traitlets.Bool(False).tag(sync=True)
+    grid_layout = traitlets.List([]).tag(sync=True)
+    video_labels = traitlets.Dict({}).tag(sync=True)
 
     _esm = pathlib.Path(__file__).parent / "video_widget.js"
     _css = pathlib.Path(__file__).parent / "video_widget.css"
@@ -64,6 +93,8 @@ class NWBDANDIVideoPlayer(anywidget.AnyWidget):
         self,
         asset: RemoteAsset,
         nwbfile: Optional[NWBFile] = None,
+        video_grid: Optional[list[list[str]]] = None,
+        video_labels: Optional[dict[str, str]] = None,
         **kwargs,
     ):
         # Load NWB file if not provided
@@ -73,17 +104,43 @@ class NWBDANDIVideoPlayer(anywidget.AnyWidget):
         video_urls = self.get_video_urls_from_dandi(nwbfile, asset)
         video_timestamps = get_video_timestamps(nwbfile)
         available_videos = get_video_info(nwbfile)
-
-        # Start with no videos selected to avoid initial buffering
-        super().__init__(
-            video_urls=video_urls,
-            video_timestamps=video_timestamps,
-            available_videos=available_videos,
-            selected_videos=[],
-            layout_mode="grid",
-            settings_open=True,
-            **kwargs,
-        )
+        video_labels = video_labels or {}
+
+        if video_grid is not None and len(video_grid) > 0:
+            # Fixed grid mode - bypass settings panel
+            # Filter to only include videos that exist in video_urls
+            filtered_grid = [
+                [v for v in row if v in video_urls]
+                for row in video_grid
+            ]
+            # Remove empty rows
+            filtered_grid = [row for row in filtered_grid if row]
+            # Flatten grid to get selected videos (preserving order)
+            selected = [v for row in filtered_grid for v in row]
+            super().__init__(
+                video_urls=video_urls,
+                video_timestamps=video_timestamps,
+                available_videos=available_videos,
+                selected_videos=selected,
+                layout_mode="grid",
+                settings_open=False,
+                grid_layout=filtered_grid,
+                video_labels=video_labels,
+                **kwargs,
+            )
+        else:
+            # Interactive mode (current behavior)
+            super().__init__(
+                video_urls=video_urls,
+                video_timestamps=video_timestamps,
+                available_videos=available_videos,
+                selected_videos=[],
+                layout_mode="grid",
+                settings_open=True,
+                grid_layout=[],
+                video_labels=video_labels,
+                **kwargs,
+            )
 
     @staticmethod
     def _load_nwbfile_from_dandi(asset: RemoteAsset) -> NWBFile:

nwb_video_widgets/local_video_widget.py

@@ -1,7 +1,10 @@
 """Local NWB video player widget."""
 
+from __future__ import annotations
+
 import pathlib
 from pathlib import Path
+from typing import Optional
 
 import anywidget
 import traitlets
@@ -28,15 +31,42 @@ class NWBLocalVideoPlayer(anywidget.AnyWidget):
     nwbfile : pynwb.NWBFile
         NWB file containing video ImageSeries in acquisition. Must have been
         loaded from disk (i.e., nwbfile.read_io must not be None).
+    video_grid : list[list[str]], optional
+        A 2D grid layout specifying which videos to display and where.
+        Each inner list represents a row of videos. When provided, bypasses
+        the interactive settings panel and displays videos in the specified
+        grid arrangement. Video names that don't exist are silently skipped.
+    video_labels : dict[str, str], optional
+        Mapping of video names to custom display labels. If a video name is
+        not in the dictionary, the original video name is displayed.
 
     Example
     -------
+    Interactive mode (default):
+
     >>> from pynwb import NWBHDF5IO
     >>> with NWBHDF5IO("experiment.nwb", "r") as io:
     ...     nwbfile = io.read()
     ...     widget = NWBLocalVideoPlayer(nwbfile)
     ...     display(widget)
 
+    Fixed grid mode (single row):
+
+    >>> widget = NWBLocalVideoPlayer(
+    ...     nwbfile,
+    ...     video_grid=[["VideoLeftCamera", "VideoBodyCamera", "VideoRightCamera"]]
+    ... )
+
+    Fixed grid mode (2x2 grid):
+
+    >>> widget = NWBLocalVideoPlayer(
+    ...     nwbfile,
+    ...     video_grid=[
+    ...         ["VideoLeftCamera", "VideoRightCamera"],
+    ...         ["VideoBodyCamera"],
+    ...     ]
+    ... )
+
     Raises
     ------
     ValueError
@@ -49,6 +79,8 @@ class NWBLocalVideoPlayer(anywidget.AnyWidget):
     selected_videos = traitlets.List([]).tag(sync=True)
     layout_mode = traitlets.Unicode("row").tag(sync=True)
     settings_open = traitlets.Bool(False).tag(sync=True)
+    grid_layout = traitlets.List([]).tag(sync=True)
+    video_labels = traitlets.Dict({}).tag(sync=True)
 
     _esm = pathlib.Path(__file__).parent / "video_widget.js"
     _css = pathlib.Path(__file__).parent / "video_widget.css"
@@ -56,22 +88,50 @@ class NWBLocalVideoPlayer(anywidget.AnyWidget):
     def __init__(
         self,
         nwbfile: NWBFile,
+        video_grid: Optional[list[list[str]]] = None,
+        video_labels: Optional[dict[str, str]] = None,
         **kwargs,
     ):
         video_urls = self.get_video_urls_from_local(nwbfile)
         video_timestamps = get_video_timestamps(nwbfile)
         available_videos = get_video_info(nwbfile)
-
-        # Start with no videos selected to avoid initial buffering
-        super().__init__(
-            video_urls=video_urls,
-            video_timestamps=video_timestamps,
-            available_videos=available_videos,
-            selected_videos=[],
-            layout_mode="grid",
-            settings_open=True,
-            **kwargs,
-        )
+        video_labels = video_labels or {}
+
+        if video_grid is not None and len(video_grid) > 0:
+            # Fixed grid mode - bypass settings panel
+            # Filter to only include videos that exist in video_urls
+            filtered_grid = [
+                [v for v in row if v in video_urls]
+                for row in video_grid
+            ]
+            # Remove empty rows
+            filtered_grid = [row for row in filtered_grid if row]
+            # Flatten grid to get selected videos (preserving order)
+            selected = [v for row in filtered_grid for v in row]
+            super().__init__(
+                video_urls=video_urls,
+                video_timestamps=video_timestamps,
+                available_videos=available_videos,
+                selected_videos=selected,
+                layout_mode="grid",
+                settings_open=False,
+                grid_layout=filtered_grid,
+                video_labels=video_labels,
+                **kwargs,
+            )
+        else:
+            # Interactive mode (current behavior)
+            super().__init__(
+                video_urls=video_urls,
+                video_timestamps=video_timestamps,
+                available_videos=available_videos,
+                selected_videos=[],
+                layout_mode="grid",
+                settings_open=True,
+                grid_layout=[],
+                video_labels=video_labels,
+                **kwargs,
+            )
 
     @staticmethod
     def get_video_urls_from_local(nwbfile: NWBFile) -> dict[str, str]:

nwb_video_widgets/video_widget.js

@@ -394,6 +394,17 @@ function render({ model, el }) {
     const urls = model.get("video_urls");
     const selectedVideos = model.get("selected_videos") || [];
     const layoutMode = model.get("layout_mode") || "row";
+    const gridLayout = model.get("grid_layout") || [];
+
+    // Check if we're in fixed grid mode (grid_layout is non-empty)
+    const isFixedGridMode = gridLayout.length > 0;
+
+    // Hide/show settings button based on mode
+    if (isFixedGridMode) {
+      settingsBtn.style.display = "none";
+    } else {
+      settingsBtn.style.display = "";
+    }
 
     // Filter to only selected videos that have URLs
     const videosToShow = selectedVideos.filter((name) => urls[name]);
@@ -406,25 +417,47 @@ function render({ model, el }) {
       return;
     }
 
-    // Calculate grid dimensions based on layout mode
-    const { rows: numRows, cols: numCols } = calculateGridDimensions(
-      layoutMode,
-      videosToShow.length
-    );
+    let numRows, numCols;
+    let videoPositions = []; // Array of {name, rowIdx, colIdx}
+
+    if (isFixedGridMode) {
+      // Fixed grid mode - use 2D layout directly
+      numRows = gridLayout.length;
+      numCols = Math.max(...gridLayout.map((row) => row.length));
+
+      // Build positions from grid_layout
+      gridLayout.forEach((row, rowIdx) => {
+        row.forEach((name, colIdx) => {
+          if (urls[name]) {
+            videoPositions.push({ name, rowIdx, colIdx });
+          }
+        });
+      });
+    } else {
+      // Interactive mode - use selected_videos + layout_mode
+      const dims = calculateGridDimensions(layoutMode, videosToShow.length);
+      numRows = dims.rows;
+      numCols = dims.cols;
+
+      // Build positions from selected_videos order
+      videosToShow.forEach((name, index) => {
+        const rowIdx = Math.floor(index / numCols);
+        const colIdx = index % numCols;
+        videoPositions.push({ name, rowIdx, colIdx });
+      });
+    }
 
     gridContainer.style.gridTemplateColumns = "repeat(" + numCols + ", auto)";
     gridContainer.style.gridTemplateRows = "repeat(" + numRows + ", auto)";
 
-    // Place videos in grid cells based on layout mode
-    videosToShow.forEach((name, index) => {
+    // Place videos in grid cells
+    videoPositions.forEach(({ name, rowIdx, colIdx }) => {
       const url = urls[name];
-      const rowIdx = Math.floor(index / numCols);
-      const colIdx = index % numCols;
 
       const videoCell = document.createElement("div");
       videoCell.classList.add("video-widget__video-cell");
-      videoCell.style.gridRow = rowIdx + 1;
-      videoCell.style.gridColumn = colIdx + 1;
+      videoCell.style.gridRow = String(rowIdx + 1);
+      videoCell.style.gridColumn = String(colIdx + 1);
 
       const videoContainer = document.createElement("div");
       videoContainer.classList.add("video-widget__video-container");
@@ -463,8 +496,9 @@ function render({ model, el }) {
       videoContainer.appendChild(video);
       videoContainer.appendChild(loadingDiv);
 
+      const videoLabels = model.get("video_labels") || {};
       const label = document.createElement("p");
-      label.textContent = name.replace("Video", "").replace("Camera", "");
+      label.textContent = videoLabels[name] || name;
       label.classList.add("video-widget__video-label");
 
       videoCell.appendChild(videoContainer);
@@ -544,6 +578,7 @@ function render({ model, el }) {
     updateSettingsPanel();
   });
   model.on("change:layout_mode", updateVideos);
+  model.on("change:grid_layout", updateVideos);
   model.on("change:settings_open", updateSettingsPanel);
   model.on("change:available_videos", updateSettingsPanel);
 

{nwb_video_widgets-0.1.0.dist-info → nwb_video_widgets-0.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nwb-video-widgets
-Version: 0.1.0
+Version: 0.1.2
 Summary: Interactive Jupyter widgets for NWB video and pose visualization
 Project-URL: Homepage, https://github.com/catalystneuro/nwb-video-widgets
 Project-URL: Repository, https://github.com/catalystneuro/nwb-video-widgets
@@ -12,11 +12,12 @@ Classifier: Development Status :: 4 - Beta
 Classifier: Framework :: Jupyter
 Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: JavaScript
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.10
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: <3.14,>=3.10
 Requires-Dist: anywidget>=0.9.0
 Requires-Dist: matplotlib
 Requires-Dist: numpy
@@ -25,10 +26,6 @@ Provides-Extra: dandi
 Requires-Dist: dandi>=0.60.0; extra == 'dandi'
 Requires-Dist: h5py; extra == 'dandi'
 Requires-Dist: remfile>=0.1.13; extra == 'dandi'
-Provides-Extra: test
-Requires-Dist: opencv-python-headless; extra == 'test'
-Requires-Dist: pytest-cov; extra == 'test'
-Requires-Dist: pytest>=7.0; extra == 'test'
 Description-Content-Type: text/markdown
 
 # nwb-video-widgets
@@ -100,6 +97,70 @@ widget = NWBLocalVideoPlayer(nwbfile)
 widget
 ```
 
+### Fixed Grid Layout
+
+When you know exactly which videos you want to display and how to arrange them, use the `video_grid` parameter to bypass the interactive settings panel. This is useful for:
+
+- Reproducible notebooks where you want consistent output
+- Presentations or demos with predetermined layouts
+- Embedding widgets in dashboards or reports
+
+The `video_grid` parameter accepts a 2D list where each inner list represents a row of videos:
+
+```python
+# Single row of three cameras
+widget = NWBLocalVideoPlayer(
+    nwbfile,
+    video_grid=[["VideoLeftCamera", "VideoBodyCamera", "VideoRightCamera"]]
+)
+
+# 2x2 grid layout
+widget = NWBLocalVideoPlayer(
+    nwbfile,
+    video_grid=[
+        ["VideoLeftCamera", "VideoRightCamera"],
+        ["VideoBodyCamera", "VideoTopCamera"],
+    ]
+)
+
+# Asymmetric grid (2 videos on top, 1 on bottom)
+widget = NWBLocalVideoPlayer(
+    nwbfile,
+    video_grid=[
+        ["VideoLeftCamera", "VideoRightCamera"],
+        ["VideoBodyCamera"],
+    ]
+)
+```
+
+The same parameter works with `NWBDANDIVideoPlayer`:
+
+```python
+widget = NWBDANDIVideoPlayer(
+    asset=asset,
+    video_grid=[["VideoLeftCamera", "VideoRightCamera"]]
+)
+```
+
+Video names that don't exist in the NWB file are silently skipped.
+
+### Custom Video Labels
+
+By default, the video name from the NWB file is displayed under each video. Use the `video_labels` parameter to provide custom display names:
+
+```python
+widget = NWBLocalVideoPlayer(
+    nwbfile,
+    video_grid=[["VideoLeftCamera", "VideoRightCamera"]],
+    video_labels={
+        "VideoLeftCamera": "Left",
+        "VideoRightCamera": "Right",
+    }
+)
+```
+
+Videos not in the dictionary will display their original name.
+
 ---
 
 ## Pose Estimation Widgets

{nwb_video_widgets-0.1.0.dist-info → nwb_video_widgets-0.1.2.dist-info}/RECORD

@@ -1,15 +1,15 @@
 nwb_video_widgets/__init__.py,sha256=4m-AlratOMO31jFrnWQSRqU2duXHMs7ZI3Iogs-hbAs,616
 nwb_video_widgets/_utils.py,sha256=kXcgjbq8mdgR0P4drPRy_Wrag3F5Od_7Ysikrr_VQMk,10566
 nwb_video_widgets/dandi_pose_widget.py,sha256=Tk_ZnqZIRIJzIAghuc1OEh0tmP9tMDP8UVDzZ4CoySg,13511
-nwb_video_widgets/dandi_video_widget.py,sha256=OaaJrNe0IoQ8X-fkDddIa6GfpCjsYZoso3-OAJEruTA,5020
+nwb_video_widgets/dandi_video_widget.py,sha256=Jnn1-AXjZMNwVf9oL-0pZREjqdO6IS3YT5X_F2-4_Us,7342
 nwb_video_widgets/local_pose_widget.py,sha256=6yrm3qoRf0C1s2CFQXTv9xCUG9NrDm4_mEv2Z8_QYww,12774
-nwb_video_widgets/local_video_widget.py,sha256=c1RRTGkOdbtEBFHUw8FzHbpezWCdRPGauhXW72sTozM,4325
+nwb_video_widgets/local_video_widget.py,sha256=V0JK9C04DLfa1fLFWxrikNML5Xs7vFNP1BC-VKqPeNs,6703
 nwb_video_widgets/pose_widget.css,sha256=nTaPfxr-6TC2IlcjNf0jVHDEqG3dx0i5jF1mtf1tzPo,15172
 nwb_video_widgets/pose_widget.js,sha256=zoXoLI1j63BOvngQ-Riufy7ae297VUidXW1KA7Z2TjI,26888
 nwb_video_widgets/video_widget.css,sha256=h6G67yoRNaVR9obRZWJ8xgo6KBKbzuRfUgDPKCYlBFo,11893
-nwb_video_widgets/video_widget.js,sha256=chqvXBD4p_9GEOvakVZHQqEz7WZwlzfNo0-toI_ix2Y,20235
+nwb_video_widgets/video_widget.js,sha256=BV0lNXCvA_zIGtgWgL9rEbAJOfS7HCthJmjUl9cB6b0,21401
 nwb_video_widgets/video_widget.py,sha256=glRQOBquOHDFeKC_aW_fMvJGqqh90AsMRWzMGSokonA,6252
-nwb_video_widgets-0.1.0.dist-info/METADATA,sha256=wh2Hie2ItnAEnHc31M0Uf8KRL3g7KsjMGUGecd9Xll4,5177
-nwb_video_widgets-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-nwb_video_widgets-0.1.0.dist-info/licenses/LICENSE,sha256=9Xuwwu2OWDAyD-b0_T2W-E13CysuHPPHYu7aNSOtIMI,1070
-nwb_video_widgets-0.1.0.dist-info/RECORD,,
+nwb_video_widgets-0.1.2.dist-info/METADATA,sha256=gtwuUaCbKUTbmdbMCg2paqui5KnQseX480wgRXhFgKc,6751
+nwb_video_widgets-0.1.2.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+nwb_video_widgets-0.1.2.dist-info/licenses/LICENSE,sha256=9Xuwwu2OWDAyD-b0_T2W-E13CysuHPPHYu7aNSOtIMI,1070
+nwb_video_widgets-0.1.2.dist-info/RECORD,,