:orphan:

.. _examples:

Examples
========

Examples that show how to work with mobgap.



.. raw:: html

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


.. raw:: html

    </div>


Data Loading and Handling
-------------------------



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to use the loader functions to load example data.">

.. only:: html

  .. image:: /auto_examples/data/images/thumb/sphx_glr__01_loading_example_data_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_data__01_loading_example_data.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Loading example data</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Often you want to test an algorithmic step in isolation or validate the output of an algorithm....">

.. only:: html

  .. image:: /auto_examples/data/images/thumb/sphx_glr__02_working_with_ref_data_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_data__02_working_with_ref_data.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Working with reference data</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Besides raw data, mobgap also has utilities to load pre-calculated DMO data in the format publi...">

.. only:: html

  .. image:: /auto_examples/data/images/thumb/sphx_glr__03_dmo_data_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_data__03_dmo_data.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Loading Digital Mobility Outcome (DMO) data</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="As part of the Mobilise-D technical validation study an extensive dataset containing 115 partic...">

.. only:: html

  .. image:: /auto_examples/data/images/thumb/sphx_glr__04_tvs_data_no_exc_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_data__04_tvs_data_no_exc.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Mobilise-D TVS Dataset</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="While it is nice to have the example data and access to the TVS and some other datasets right t...">

.. only:: html

  .. image:: /auto_examples/data/images/thumb/sphx_glr__05_custom_datasets_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_data__05_custom_datasets.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Custom Data and Datasets</div>
    </div>


.. raw:: html

    </div>


Full Pipelines and Pipeline Helper
----------------------------------



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="As part of most pipelines, we need to iterate over the gait sequences to apply all further algo...">

.. only:: html

  .. image:: /auto_examples/pipeline/images/thumb/sphx_glr__01_gs_iterator_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_pipeline__01_gs_iterator.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Gait Sequence Iterator</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to build a full gait analysis pipeline using the mobgap package. Note, t...">

.. only:: html

  .. image:: /auto_examples/pipeline/images/thumb/sphx_glr__02_step_by_step_mobilised_pipeline_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_pipeline__02_step_by_step_mobilised_pipeline.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">The Mobilise-D pipeline: Step-by-Step Breakdown</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to evaluate the performance of parameters on a walking bout (WB) level b...">

.. only:: html

  .. image:: /auto_examples/pipeline/images/thumb/sphx_glr__03_dmo_evaluation_on_wb_level_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_pipeline__03_dmo_evaluation_on_wb_level.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Evaluation of final walking bout level DMOs</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="As part of the Mobilise-D project two separate pipelines have been developed depending on the p...">

.. only:: html

  .. image:: /auto_examples/pipeline/images/thumb/sphx_glr__03_preconfigured_mobilised_pipelines_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_pipeline__03_preconfigured_mobilised_pipelines.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Preconfigured Mobilised Pipelines</div>
    </div>


.. raw:: html

    </div>


Gait Sequence Detection
-----------------------



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="We start by defining some helpers for plotting and loading the data. You can skip them for now ...">

.. only:: html

  .. image:: /auto_examples/gait_sequences/images/thumb/sphx_glr__01_gsd_iluz_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_gait_sequences__01_gsd_iluz.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">This example shows how to use the GSD Iluz algorithm and some examples on how the results compare to the original</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to use the two variants of the Gait Sequence Detection (GSD) algorithm b...">

.. only:: html

  .. image:: /auto_examples/gait_sequences/images/thumb/sphx_glr__02_gsd_ionescu_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_gait_sequences__02_gsd_ionescu.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">GSD Paraschiv-Ionescu</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to apply evaluation algorithms to GSD and thus how to rate the performan...">

.. only:: html

  .. image:: /auto_examples/gait_sequences/images/thumb/sphx_glr__03_gsd_evaluation_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_gait_sequences__03_gsd_evaluation.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">GSD Evaluation</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="With that you could set up a custom evaluation pipeline to run and then score the output of a G...">

.. only:: html

  .. image:: /auto_examples/gait_sequences/images/thumb/sphx_glr__04_gsd_evaluation_challenges_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_gait_sequences__04_gsd_evaluation_challenges.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">GSD Evaluation Challenges</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="GSD TVS Evaluation">

.. only:: html

  .. image:: /auto_examples/gait_sequences/images/thumb/sphx_glr__05_tvs_evaluation_no_exc_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_gait_sequences__05_tvs_evaluation_no_exc.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">GSD TVS Evaluation</div>
    </div>


.. raw:: html

    </div>


Initial Contact Detection
-------------------------



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to use the initial_contacts Ionescu algorithm and how its results compar...">

.. only:: html

  .. image:: /auto_examples/initial_contacts/images/thumb/sphx_glr__01_icd_ionescu_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_initial_contacts__01_icd_ionescu.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">ICD Ionescu</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to use the improved Shin algorithm and some examples on how the results ...">

.. only:: html

  .. image:: /auto_examples/initial_contacts/images/thumb/sphx_glr__02_shin_algo_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_initial_contacts__02_shin_algo.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Shin Algo</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to use the improved HKLee algorithm and some examples on how the results...">

.. only:: html

  .. image:: /auto_examples/initial_contacts/images/thumb/sphx_glr__03_hklee_algo_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_initial_contacts__03_hklee_algo.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">HKLee algo</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to apply evaluation algorithms to ICD and thus how to rate the performan...">

.. only:: html

  .. image:: /auto_examples/initial_contacts/images/thumb/sphx_glr__04_icd_evaluation_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_initial_contacts__04_icd_evaluation.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">ICD Evaluation</div>
    </div>


.. raw:: html

    </div>


Left/Right Classification
-------------------------



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The McCamley L/R classifier is a simple algorithm to detect the laterality of initial contacts ...">

.. only:: html

  .. image:: /auto_examples/laterality/images/thumb/sphx_glr__01_lrc_mccamley_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_laterality__01_lrc_mccamley.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">McCamley L/R Classifier</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The Ullrich L/R classifier is a general approach of differentiating left from right foot contac...">

.. only:: html

  .. image:: /auto_examples/laterality/images/thumb/sphx_glr__02_lrc_ullrich_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_laterality__02_lrc_ullrich.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Ullrich L/R Classifier</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to evaluate an LRC algorithm. As left-right classification, is a ...">

.. only:: html

  .. image:: /auto_examples/laterality/images/thumb/sphx_glr__99_lrc_evaluation_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_laterality__99_lrc_evaluation.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">LRC Evaluation</div>
    </div>


.. raw:: html

    </div>


Cadence Estimation
------------------



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The most obvious way to calculate cadence is to use the detected initial contacts. However, ini...">

.. only:: html

  .. image:: /auto_examples/cadence/images/thumb/sphx_glr__01_cad_from_ic_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_cadence__01_cad_from_ic.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Cadence from Initial Contacts</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to apply evaluation algorithms to cadence results and thus how to rate t...">

.. only:: html

  .. image:: /auto_examples/cadence/images/thumb/sphx_glr__02_cad_evaluation_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_cadence__02_cad_evaluation.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Cadence Evaluation</div>
    </div>


.. raw:: html

    </div>


Stride Length Calculation
-------------------------



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to use the Zijlstra algorithm for calculating stride length and how its ...">

.. only:: html

  .. image:: /auto_examples/stride_length/images/thumb/sphx_glr__01_sl_zijlstra_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_stride_length__01_sl_zijlstra.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">SL Zijlstra</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to apply evaluation algorithms to stride length results and thus how to ...">

.. only:: html

  .. image:: /auto_examples/stride_length/images/thumb/sphx_glr__02_sl_evaluation_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_stride_length__02_sl_evaluation.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Stride Length Evaluation</div>
    </div>


.. raw:: html

    </div>


Detecting Turns
---------------



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to use the ElGohary turning algorithm. It uses the angular velocity arou...">

.. only:: html

  .. image:: /auto_examples/turning/images/thumb/sphx_glr__01_td_elgohary_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_turning__01_td_elgohary.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">ElGohary Turning Algo</div>
    </div>


.. raw:: html

    </div>


Creating final Walking Bouts
----------------------------



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="An important part of the Mobilise-D pipeline is that we output WBs based on a fixed set of defi...">

.. only:: html

  .. image:: /auto_examples/wba/images/thumb/sphx_glr__01_assembling_wbs_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_wba__01_assembling_wbs.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Assembling WBs</div>
    </div>


.. raw:: html

    </div>


DMO Aggregation
---------------



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to use the .MobilisedAggregator class to aggregate DMOs over multiple wa...">

.. only:: html

  .. image:: /auto_examples/aggregation/images/thumb/sphx_glr__01_mobilised_aggregator_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_aggregation__01_mobilised_aggregator.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Mobilised Aggregator</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to use the functions apply_thresholds to check if a DMO falls within the...">

.. only:: html

  .. image:: /auto_examples/aggregation/images/thumb/sphx_glr__02_threshold_check_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_aggregation__02_threshold_check.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Threshold Checker</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how the raw CVS per walking bout results are combined with the weartime repo...">

.. only:: html

  .. image:: /auto_examples/aggregation/images/thumb/sphx_glr__99_cvs_agg_pipeline_no_exc_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_aggregation__99_cvs_agg_pipeline_no_exc.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">CVS Official Aggregation Script</div>
    </div>


.. raw:: html

    </div>


Data Transformations and Filtering
----------------------------------



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Besides explicit gait specific algorithms, we also provide a set of generic data transforms, wh...">

.. only:: html

  .. image:: /auto_examples/data_transform/images/thumb/sphx_glr__01_generic_data_transforms_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_data_transform__01_generic_data_transforms.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Generic Data Transforms</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="One of the most common data transformations is filtering. In mobgap various types of filters ar...">

.. only:: html

  .. image:: /auto_examples/data_transform/images/thumb/sphx_glr__02_filter_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_data_transform__02_filter.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">General Filter Introduction</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Sometimes you may want to resample your data to a different sampling rate. We provide a utility...">

.. only:: html

  .. image:: /auto_examples/data_transform/images/thumb/sphx_glr__03_resample_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_data_transform__03_resample.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Resampling data</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Continuous wavelet transform (CWT) is a time-frequency analysis method that can provide frequen...">

.. only:: html

  .. image:: /auto_examples/data_transform/images/thumb/sphx_glr__04_cwt_filter_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_data_transform__04_cwt_filter.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Continuous Wavelet Transform (CWT) - Filter</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Gaussian Smoothing">

.. only:: html

  .. image:: /auto_examples/data_transform/images/thumb/sphx_glr__05_gaussian_smoothing_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_data_transform__05_gaussian_smoothing.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Gaussian Smoothing</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="We provide a class based implementation of the Savitzky-Golay filter in the SavgolFilter class....">

.. only:: html

  .. image:: /auto_examples/data_transform/images/thumb/sphx_glr__06_savgol_filter_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_data_transform__06_savgol_filter.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Savitzky-Golay Filter Example</div>
    </div>


.. raw:: html

    </div>


Development Guides
------------------

Some recipies that should help during development of mobgap and might also be helpful, if you want to extend mobgap
using new algorithms.


.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="All mobgap algorithms are implemented as tpcp classes (see tpcp.Algorithm). Hence, all there co...">

.. only:: html

  .. image:: /auto_examples/dev_guides/images/thumb/sphx_glr__01_pretrained_models_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_dev_guides__01_pretrained_models.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Pretrained models and predefined Parameters</div>
    </div>


.. raw:: html

    </div>


.. toctree::
   :hidden:
   :includehidden:


   /./auto_examples/data/index.rst
   /./auto_examples/pipeline/index.rst
   /./auto_examples/gait_sequences/index.rst
   /./auto_examples/initial_contacts/index.rst
   /./auto_examples/laterality/index.rst
   /./auto_examples/cadence/index.rst
   /./auto_examples/stride_length/index.rst
   /./auto_examples/turning/index.rst
   /./auto_examples/wba/index.rst
   /./auto_examples/aggregation/index.rst
   /./auto_examples/data_transform/index.rst
   /./auto_examples/dev_guides/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: auto_examples_python.zip </auto_examples/auto_examples_python.zip>`

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

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


.. only:: html

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

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