:orphan:

Example Gallery
================



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. thumbnail-parent-div-close

.. raw:: html

    </div>

Using `ripplemapper.io`
=======================

Examples showing how to load data into ripplemapper.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Ripplemapper can store a series of RippleImages in a RippleImageSeries object.">

.. only:: html

  .. image:: /generated/gallery/io/images/thumb/sphx_glr_creating_rippleimageseries_thumb.png
    :alt:

  :ref:`sphx_glr_generated_gallery_io_creating_rippleimageseries.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Creating a RippleImageSeries object</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to load a tiff file into a numpy array.">

.. only:: html

  .. image:: /generated/gallery/io/images/thumb/sphx_glr_loading_tiff_thumb.png
    :alt:

  :ref:`sphx_glr_generated_gallery_io_loading_tiff.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Loading a Tiff Image</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Ripplemapper is capable of loading a directory of images into a list of RippleImage objects.">

.. only:: html

  .. image:: /generated/gallery/io/images/thumb/sphx_glr_loading_a_directory_thumb.png
    :alt:

  :ref:`sphx_glr_generated_gallery_io_loading_a_directory.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Loading a directory of images into RippleImage objects</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="One of the foundational classes of Ripplemapper is its image class, this example shows how to load an image file into a RippleImage object.">

.. only:: html

  .. image:: /generated/gallery/io/images/thumb/sphx_glr_creating_rippleimage_thumb.png
    :alt:

  :ref:`sphx_glr_generated_gallery_io_creating_rippleimage.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Loading an image into a RippleImage object</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>

Using `ripplemapper.contour`
==============================

Examples showing how to use the `ripplemapper.contour` module.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Ripplemapper has a variety of ways to define the water-air interface, the most simple of which is to use the boundary contours of the image. This example shows how to add boundary contours to an image.">

.. only:: html

  .. image:: /generated/gallery/contours/images/thumb/sphx_glr_boundary_contours_thumb.png
    :alt:

  :ref:`sphx_glr_generated_gallery_contours_boundary_contours.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Adding "Boundary" Contours to an Image</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to add a contour based on the chan-vese segmentation of the image.">

.. only:: html

  .. image:: /generated/gallery/contours/images/thumb/sphx_glr_boundary_chan_vese_thumb.png
    :alt:

  :ref:`sphx_glr_generated_gallery_contours_boundary_chan_vese.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Adding Chan-Vese Contours to an Image</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to add a contour based on an A-star traversal of the image in an area between two existing contours.">

.. only:: html

  .. image:: /generated/gallery/contours/images/thumb/sphx_glr_boundary_a_star_thumb.png
    :alt:

  :ref:`sphx_glr_generated_gallery_contours_boundary_a_star.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Adding Chan-Vese Contours to an Image</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Since many of the methods for computing boundaries rely on contouring data, it is possible that the contours may have small &quot;bumps&quot; in them.">

.. only:: html

  .. image:: /generated/gallery/contours/images/thumb/sphx_glr_removing_small_bumps_thumb.png
    :alt:

  :ref:`sphx_glr_generated_gallery_contours_removing_small_bumps.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Removing "bumps" from a computed boundary</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>

Visualising data
==================

Examples showing visualisation of various data in `ripplemapper`.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="How to plot a RippleContour using inbuilt plotting methods.">

.. only:: html

  .. image:: /generated/gallery/visualisation/images/thumb/sphx_glr_plotting_ripple_contour_thumb.png
    :alt:

  :ref:`sphx_glr_generated_gallery_visualisation_plotting_ripple_contour.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Plotting a RippleContour</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="How to plot a ripple image using inbuilt plotting methods.">

.. only:: html

  .. image:: /generated/gallery/visualisation/images/thumb/sphx_glr_plotting_ripple_image_thumb.png
    :alt:

  :ref:`sphx_glr_generated_gallery_visualisation_plotting_ripple_image.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Plotting a RippleImage</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A RippleImageSeries is simply a container class for a list of RippleImages.">

.. only:: html

  .. image:: /generated/gallery/visualisation/images/thumb/sphx_glr_plotting_ripple_image_series_thumb.png
    :alt:

  :ref:`sphx_glr_generated_gallery_visualisation_plotting_ripple_image_series.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Plotting a RippleImageSeries</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A RippleImageSeries is simply a container class for a list of RippleImages.">

.. only:: html

  .. image:: /generated/gallery/visualisation/images/thumb/sphx_glr_plotting_a_timeseries_thumb.png
    :alt:

  :ref:`sphx_glr_generated_gallery_visualisation_plotting_a_timeseries.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Plotting a timeseries of a contour</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:
   :includehidden:


   /generated/gallery/io/index.rst
   /generated/gallery/contours/index.rst
   /generated/gallery/visualisation/index.rst


.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-gallery

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

      :download:`Download all examples in Python source code: gallery_python.zip </generated/gallery/gallery_python.zip>`

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

      :download:`Download all examples in Jupyter notebooks: gallery_jupyter.zip </generated/gallery/gallery_jupyter.zip>`


.. only:: html

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

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