.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "_gallery/image_widget/image_widget_single_video.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download__gallery_image_widget_image_widget_single_video.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr__gallery_image_widget_image_widget_single_video.py:


Image widget Video
==================

Example showing how to scroll through one or more videos using the ImageWidget

.. GENERATED FROM PYTHON SOURCE LINES 7-47



.. image-sg:: /_gallery/image_widget/images/sphx_glr_image_widget_single_video_001.webp
   :alt: image widget single video
   :srcset: /_gallery/image_widget/images/sphx_glr_image_widget_single_video_001.webp
   :class: sphx-glr-single-img


.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    /home/runner/work/fastplotlib/fastplotlib/fastplotlib/graphics/_features/_base.py:18: UserWarning: casting float64 array to float32
      warn(f"casting {array.dtype} array to float32")







|

.. code-block:: Python


    # test_example = true

    import fastplotlib as fpl
    import imageio.v3 as iio
    import numpy as np


    movie = iio.imread("imageio:cockatoo.mp4")

    # Ignore and do not use the next 2 lines
    # for the purposes of docs gallery generation we subsample and only use 15 frames
    movie_sub = movie[:15, ::12, ::12].copy()
    del movie

    iw = fpl.ImageWidget(movie_sub, rgb=[True], figure_kwargs={"size": (700, 560)})

    # ImageWidget supports setting window functions the `time` "t" or `volume` "z" dimension
    # These can also be given as kwargs to `ImageWidget` during instantiation
    # to set a window function, give a dict in the form of {dim: (func, window_size)}
    iw.window_funcs = {"t": (np.mean, 13)}

    # change the window size
    iw.window_funcs["t"].window_size = 33

    # change the function
    iw.window_funcs["t"].func = np.max

    # or reset it
    iw.window_funcs = None

    iw.show()

    figure = iw.figure

    # NOTE: `if __name__ == "__main__"` is NOT how to use fastplotlib interactively
    # please see our docs for using fastplotlib interactively in ipython and jupyter
    if __name__ == "__main__":
        print(__doc__)
        fpl.run()


.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 12.359 seconds)


.. _sphx_glr_download__gallery_image_widget_image_widget_single_video.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: image_widget_single_video.ipynb <image_widget_single_video.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: image_widget_single_video.py <image_widget_single_video.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: image_widget_single_video.zip <image_widget_single_video.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_