Include frame interaction as a script

Author: ruancomelli

boiling_learning/scripts/interact_frames.py

@@ -0,0 +1,106 @@
+import warnings
+from typing import Any, Callable, Iterable, Tuple
+
+import numpy as np
+from ipywidgets import interact, widgets
+from skimage.transform import downscale_local_mean as downscale
+
+from boiling_learning.preprocessing import Case
+
+
+def _make_show_frame_function(
+    imshow: Callable[[np.ndarray], Any],
+    downscale_factor: Iterable[int] = (8, 8, 1),
+) -> Callable[[np.ndarray], None]:
+    def _imshow(image: np.ndarray) -> None:
+        imshow(downscale(image, downscale_factor))
+
+    return _imshow
+
+
+def _interact_boiling_frames(
+    cases: Tuple[Case, ...], imshow: Callable[[np.ndarray], Any]
+) -> None:
+    cases_options = [(case.name, case) for case in cases]
+    default_case = cases_options[0][1]
+    cases_widget = widgets.Dropdown(
+        options=cases_options, description='Case name:', value=default_case
+    )
+
+    experiment_videos_options = [
+        (experiment_video.name, experiment_video)
+        for experiment_video in cases_widget.value.values()
+    ]
+    experiment_videos_widget = widgets.Dropdown(
+        options=experiment_videos_options,
+        description='Experiment video:',
+        value=experiment_videos_options[0][1],
+    )
+
+    def update_videos_list(changes):
+        experiment_videos_widget.options = [
+            (experiment_video.name, experiment_video)
+            for experiment_video in changes['new'].values()
+        ]
+
+    cases_widget.observe(update_videos_list, 'value')
+
+    with experiment_videos_widget.value.frames() as f:
+        index_widget = widgets.IntSlider(
+            value=0, min=0, max=len(f), description='Frame:'
+        )
+
+    def update_max_index(changes):
+        with changes['new'].frames() as f:
+            index_widget.max = len(f)
+
+    experiment_videos_widget.observe(update_max_index, 'value')
+
+    def show_frames(case, ev, idx):
+        imshow(ev.frame(idx))
+
+    interact(
+        show_frames,
+        case=cases_widget,
+        ev=experiment_videos_widget,
+        idx=index_widget,
+    )
+
+
+def main(
+    cases: Iterable[Case],
+    colab_backend: bool = False,
+    physics: str = 'boiling',
+) -> None:
+    cases = tuple(cases)
+
+    if physics not in {'boiling', 'condensation'}:
+        raise ValueError(
+            '*physics* must be either "boiling" or "condensation"'
+        )
+
+    imshow_imported: bool = False
+    if colab_backend:
+        try:
+            from google.colab.patches import cv2_imshow
+
+            imshow_imported = True
+        except (ImportError, ModuleNotFoundError):
+            pass
+
+    if not imshow_imported:
+        from cv2 import imshow as cv2_imshow
+
+    imshow = _make_show_frame_function(cv2_imshow)
+
+    with warnings.catch_warnings():
+        if physics == 'boiling':
+            _interact_boiling_frames(cases, imshow)
+        else:
+            raise ValueError(f'physics=="{physics}" is not supported yet.')
+
+
+if __name__ == '__main__':
+    raise RuntimeError(
+        '*interact_frames* cannot be executed as a standalone script yet.'
+    )