:orphan:

.. _examples-index:

==================
Examples
==================



.. raw:: html

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

.. thumbnail-parent-div-open

.. thumbnail-parent-div-close

.. raw:: html

    </div>


-----------------------
Extend MyoGestic
-----------------------

Tutorials for adding new components to MyoGestic through the
:class:`~myogestic.utils.config.Registry`.



.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to create and register a new real-time post-prediction filter in MyoGestic, allowing you to smooth or transform model outputs in real time after predictions are made.">

.. only:: html

  .. image:: /auto_examples/01_add_functionality/images/thumb/sphx_glr_1_add_post_prediction_filter_thumb.png
    :alt:

  :doc:`/auto_examples/01_add_functionality/1_add_post_prediction_filter`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Add a Post-Prediction Filter</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to register a new model (classifier or regressor) in MyoGestic.  Every model needs four functions -- train, predict, save, and load -- plus some metadata describing its parameters and capabilities.">

.. only:: html

  .. image:: /auto_examples/01_add_functionality/images/thumb/sphx_glr_2_add_model_thumb.png
    :alt:

  :doc:`/auto_examples/01_add_functionality/2_add_model`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Add a Model</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to create and register a new feature-extraction transform in MyoGestic.  Features are applied to raw EMG data during dataset creation and real-time prediction to produce the input that models consume.">

.. only:: html

  .. image:: /auto_examples/01_add_functionality/images/thumb/sphx_glr_3_add_biosignal_feature_thumb.png
    :alt:

  :doc:`/auto_examples/01_add_functionality/3_add_biosignal_feature`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Add a Biosignal Feature</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to build and register a new output system in MyoGestic.  An output system receives model predictions and routes them to an external destination -- a visual interface, prosthetic hardware, game engine, or anything else that consumes EMG-decoded outputs.">

.. only:: html

  .. image:: /auto_examples/01_add_functionality/images/thumb/sphx_glr_4_add_output_system_thumb.png
    :alt:

  :doc:`/auto_examples/01_add_functionality/4_add_output_system`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Add an Output System</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


-------------------------------
Add a New Visual Interface
-------------------------------

Step-by-step guide to integrating a new Visual Interface (VI) into
MyoGestic -- from UI setup to output system.



.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A Visual Interface (VI) is an external graphical application that provides visual feedback to experiment participants (e.g., a virtual hand, a cursor, or a game).  MyoGestic communicates with VIs over UDP to stream predictions and receive kinematics.">

.. only:: html

  .. image:: /auto_examples/02_add_visual_interface/images/thumb/sphx_glr_0_add_ui_thumb.png
    :alt:

  :doc:`/auto_examples/02_add_visual_interface/0_add_ui`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Part 0: Overview and UI Setup</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The setup interface is the first component of a visual interface in MyoGestic.  It is responsible for:">

.. only:: html

  .. image:: /auto_examples/02_add_visual_interface/images/thumb/sphx_glr_1_setup_interface_thumb.png
    :alt:

  :doc:`/auto_examples/02_add_visual_interface/1_setup_interface`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Part 1: Setup Interface</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The recording interface is the second component of a visual interface in MyoGestic.  It manages per-VI recording settings and ground truth data collection.">

.. only:: html

  .. image:: /auto_examples/02_add_visual_interface/images/thumb/sphx_glr_2_recording_interface_thumb.png
    :alt:

  :doc:`/auto_examples/02_add_visual_interface/2_recording_interface`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Part 2: Recording Interface</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The output system is the third component of a visual interface.  It processes model predictions (classification or regression) and sends them to the external VI application.">

.. only:: html

  .. image:: /auto_examples/02_add_visual_interface/images/thumb/sphx_glr_3_output_system_thumb.png
    :alt:

  :doc:`/auto_examples/02_add_visual_interface/3_output_system`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Part 3: Output System</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:
   :includehidden:


   /auto_examples/01_add_functionality/index.rst
   /auto_examples/02_add_visual_interface/index.rst



.. only:: html

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

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