.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "auto_examples/02_add_visual_interface/0_add_ui.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

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

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

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

.. _sphx_glr_auto_examples_02_add_visual_interface_0_add_ui.py:


=========================================
Part 0: What is a Visual Interface?
=========================================

A **Visual Interface** is a graphical user interface (GUI) that allows us to perform experiments, visualize data, and interact with the models trained in MyoGestic.

Further it is the main way we can communicate to participants what they should do during the experiment and what they can control.

For example, the :ref:`virtual_hand_interface` is a Visual Interface that allows users to visualize their hand movements in real-time despite neural lesions or amputations.
It is designed to have as little visual clutter as possible to avoid overwhelming the user with information. Two virtual hands are displayed on the screen, one that represents the user's hand and another that represents the target hand.

Technical Considerations (Probably why you are here):
------------------------------------------------------
.. important::
   A Visual Interface is generally intended to be a standalone program that can communicate (both receiving and sending) through information exchange protocols (e.g., UDP).
   This way the interface is a standalone process that will not be hindered by MyoGestic's runtime.

   **If you have not already, please create your standalone visual interface before proceeding.**


To integrate a new Visual Interface in MyoGestic you must add three components:

1. **Setup Interface**: Configures the parameters and initializes the system (e.g. hardware, data pipeline).
2. **Recording Interface**: Manages runtime interactions and data visualization.
3. **Output Interface**: Defines how results are presented (e.g., virtual hands, plots).


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

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

**Estimated memory usage:**  570 MB


.. _sphx_glr_download_auto_examples_02_add_visual_interface_0_add_ui.py:

.. only:: html

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

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

      :download:`Download Jupyter notebook: 0_add_ui.ipynb <0_add_ui.ipynb>`

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

      :download:`Download Python source code: 0_add_ui.py <0_add_ui.py>`

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

      :download:`Download zipped: 0_add_ui.zip <0_add_ui.zip>`


.. only:: html

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

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