:orphan:

.. _target-examples:

Examples
--------

Below is a gallery of examples showcasing the core functionality and concepts
of ``movement``.



.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Load and explore an example dataset of pose tracks.">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_load_and_explore_poses_thumb.png
    :alt:

  :ref:`sphx_glr_examples_load_and_explore_poses.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Load and explore pose tracks</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Filter out points with low confidence scores and interpolate over missing values.">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_filter_and_interpolate_thumb.png
    :alt:

  :ref:`sphx_glr_examples_filter_and_interpolate.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Drop outliers and interpolate</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Load pose tracks from one file format, modify them, and save them to another file format.">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_convert_file_formats_thumb.png
    :alt:

  :ref:`sphx_glr_examples_convert_file_formats.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Convert pose tracks between file formats</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Smooth pose tracks using the rolling median and Savitzky-Golay filters.">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_smooth_thumb.png
    :alt:

  :ref:`sphx_glr_examples_smooth.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Smooth pose tracks</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Look at eye movements and pupil diameter.">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_mouse_eye_movements_thumb.png
    :alt:

  :ref:`sphx_glr_examples_mouse_eye_movements.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Pupil tracking</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Compute the head direction vector and angle using different methods.">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_compute_head_direction_thumb.png
    :alt:

  :ref:`sphx_glr_examples_compute_head_direction.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Compute head direction</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Compute displacement, velocity and acceleration, and visualise the results.">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_compute_kinematics_thumb.png
    :alt:

  :ref:`sphx_glr_examples_compute_kinematics.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Compute and visualise kinematics.</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Compute distances, approach vectors, and both egocentric and allocentric boundary angles relative to regions of interest (RoIs).">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_boundary_angles_thumb.png
    :alt:

  :ref:`sphx_glr_examples_boundary_angles.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Compute distances and angles to regions of interest</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Load bounding box tracks and upsample them to match the video frame rate.">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_load_and_upsample_bboxes_thumb.png
    :alt:

  :ref:`sphx_glr_examples_load_and_upsample_bboxes.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Load and upsample bounding box tracks</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /examples/load_and_explore_poses
   /examples/filter_and_interpolate
   /examples/convert_file_formats
   /examples/smooth
   /examples/mouse_eye_movements
   /examples/compute_head_direction
   /examples/compute_kinematics
   /examples/boundary_angles
   /examples/load_and_upsample_bboxes

.. target-examples-advanced:

Advanced
~~~~~~~~

These examples are intended for experienced users who want to leverage the
full power of ``movement``.



.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Use the make_broadcastable decorator to efficiently apply functions across any data dimension.">

.. only:: html

  .. image:: /examples/advanced/images/thumb/sphx_glr_broadcasting_your_own_methods_thumb.png
    :alt:

  :ref:`sphx_glr_examples_advanced_broadcasting_your_own_methods.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Broadcast functions across multi-dimensional data</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:
   :includehidden:


   /examples/advanced/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: examples_python.zip </examples/examples_python.zip>`

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

      :download:`Download all examples in Jupyter notebooks: examples_jupyter.zip </examples/examples_jupyter.zip>`


.. only:: html

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

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