.. _XML_Converter:

================================
Convert Annotations from XML
================================

Description
-----------------

Convert Compumedics (ProFusion) XML annotation files into Snooz '.tsv' annotation files.

The converter looks for the following fields:

    - **EpochLength** (optional)
    - **ScoredEvents**

      - Name
      - Start
      - Duration
      - Input
      - EventName (optional)
    - **SleepStages**

An example of an XML file is shown below : 

.. code-block:: XML

    <CMPStudyConfig>
        <EpochLength>30</EpochLength>
    <ScoredEvents>
        <ScoredEvent>
            <Name>SpO2 artifact</Name>
            <Start>0</Start>
            <Duration>10</Duration>
            <Input>SaO2</Input>
            <EventName>Art</EventName>
        </ScoredEvent>
    </ScoredEvents>
    <SleepStages>
        <SleepStage>0</SleepStage>
        <SleepStage>0</SleepStage>
    </SleepStages>


.. note::

    XML files generated by the 'Convertisseur d'enregistrements polysomnographiques' from the foundational version of the CEAMS library are supported.

Steps
-----------------

**1 - Input Files**

Add the .xml annotation files to convert to Snooz .tsv annotation file.  (No edf file needed, only the xml file is mandatory).


Version History
-----------------

* v2.0.0 : Distributed with CEAMS package version 7.2.0 — Snooz beta 2.0.1
    - Initial release of the tool.

* v2.2.0 : Distributed with CEAMS package version 7.3.0 — Snooz beta 3.0.0 
    - Supports the new optional time elapsed column.