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

.. only:: html

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

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

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

.. _sphx_glr_generated_gallery_io_creating_rippleimageseries.py:


===================================
Creating a RippleImageSeries object
===================================

Ripplemapper can store a series of RippleImages in a RippleImageSeries object.

.. GENERATED FROM PYTHON SOURCE LINES 8-18

.. code-block:: Python


    from ripplemapper.classes import RippleImageSeries
    from ripplemapper.data.example import example_dir
    from ripplemapper.io import load_dir_to_obj

    imgs = load_dir_to_obj(example_dir)
    image_series = RippleImageSeries(imgs)

    print(image_series)




.. image-sg:: /generated/gallery/io/images/sphx_glr_creating_rippleimageseries_001.png
   :alt: creating rippleimageseries
   :srcset: /generated/gallery/io/images/sphx_glr_creating_rippleimageseries_001.png
   :class: sphx-glr-single-img


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

 .. code-block:: none

    RippleImageSeries: 4 images




.. GENERATED FROM PYTHON SOURCE LINES 19-20

Just like with RippleImages we can select a Region of Interest when loading the image files.

.. GENERATED FROM PYTHON SOURCE LINES 21-24

.. code-block:: Python


    imgs_with_roi = load_dir_to_obj(example_dir, roi_x=[0, 100], roi_y=[0, 100])
    print(imgs[0].image.shape, imgs_with_roi[0].image.shape)




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

 .. code-block:: none

    (125, 504) (100, 100)





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

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


.. _sphx_glr_download_generated_gallery_io_creating_rippleimageseries.py:

.. only:: html

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

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

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

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

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

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

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


.. only:: html

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

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