.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "examples_gallery/mkh5/apparatus_map.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

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

        Click :ref:`here <sphx_glr_download_examples_gallery_mkh5_apparatus_map.py>`
        to download the full example code

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

.. _sphx_glr_examples_gallery_mkh5_apparatus_map.py:


Electrode location YAML format
==============================

.. GENERATED FROM PYTHON SOURCE LINES 7-66

Electrode locations and fiducial landmarks (optional)
-----------------------------------------------------

Electrode locations, fiducial landmarks (nasion, left and right
preauricular points), and head shape data points can be baked into the
mkpy .h5 data header by including a ``name: apparatus`` YAML document
in the ``.yhdr`` so that the location information travels with the EEG

The mkh5 standard apparatus specifies a 3D <x, y, z> cartesian
coordinate space, <right, anterior, superior> (RAS) orientation, with
measurement units of centimeters.

A minimal apparatus map has the following keys, additional keys may be
added ad lib.

Addition fields may be added to the maps.

.. code-block:: yaml

   ---
   # mandatory keys and values
   name: apparatus
   space:
     coordinates: cartesian
     distance_unit: cm
     orientation: ras

   # mandatory keys. RAS x, y, z values may vary
   fiducials:
     lpa:
       x: <float>
       y: <float>
       z: <float>
     nasion:
       x: <float>
       y: <float>
       z: <float>
     rpa:
       x: <float>
       y: <float>
       z: <float>

   # EEG data straems ("channels")
   streams:
     label:
       pos: <sensor_label>
       neg: <sensor(s) label>

   # ... as needed ...

   # The nmber of electrodes, labels, and x, y, z  values are as needed
   sensors:
     label:
       x: <float>
       y: <float>
       z: <float>

   # ... as needed ...


.. GENERATED FROM PYTHON SOURCE LINES 69-70

For the current format see :ref:`sample_yhdr`


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

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


.. _sphx_glr_download_examples_gallery_mkh5_apparatus_map.py:


.. only :: html

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



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

     :download:`Download Python source code: apparatus_map.py <apparatus_map.py>`



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

     :download:`Download Jupyter notebook: apparatus_map.ipynb <apparatus_map.ipynb>`


.. only:: html

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

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