Metadata-Version: 2.4
Name: pyPhasesRecordloaderMrOS
Version: 0.8.1
Summary: Adds a record loaders to the pyPhases package
Home-page: https://gitlab.com/tud.ibmt.public/pyphases/pyphasesrecordloader/
Author: Franz Ehrlich
Author-email: fehrlichd@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.5
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyPhases
Requires-Dist: pyPhasesRecordloader
Requires-Dist: pyedflib
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# Extension for pyPhasesRecordloader

Extension to load data records from the MrOS Sleep Study (MrOS) database.

The extensions requires a downloaded version of the mros dataset. The location can be set through the config value `mros-path`.

## Usage

In a phase you can acess the data through the `RecordLoader`:

Add the plugins and config values to your `project.yaml`:

```yaml
name: MrOSProject
plugins:
  - pyPhasesML
  - pyPhasesRecordloaderMrOS
  - pyPhasesRecordloader

phases:
  - name: MyPhase

config:
  mros-path: C:/datasets/mros

```

In a phase (`phases/MyPhase.py`) you can acess the records through the `RecordLoader`:

```python
from pyPhasesRecordloader import RecordLoader
from pyPhases import Phase

class MyPhase(Phase):
    def run(self):
      recordIds = recordLoader.getRecordList()
      for recordId in recordIds:
        record = recordLoader.getRecord(recordId)
```

Run Your project with `python -m phases run MyPhase`


# Annotations


|   Count | EventConcept                                                 |
| ------: | :----------------------------------------------------------- |
| 1452282 | SpO2 desaturation\|SpO2 desaturation                         |
|  684753 | Periodic leg movement - right\|PLM (Right)                   |
|  663100 | Periodic leg movement - left\|PLM (Left)                     |
|  624159 | ASDA arousal\|Arousal (ASDA)                                 |
|  411225 | Limb movement - right\|Limb Movement (Right)                 |
|  399403 | Limb movement - left\|Limb Movement (Left)                   |
|  296939 | Unsure\|Unsure                                               |
|  283691 | Hypopnea\|Hypopnea                                           |
|  207671 | SpO2 artifact\|SpO2 artifact                                 |
|  187852 | Stage 2 sleep\|2                                             |
|  173961 | Wake\|0                                                      |
|  120933 | Obstructive apnea\|Obstructive Apnea                         |
|  111248 | Stage 1 sleep\|1                                             |
|   83140 | Stage 3 sleep\|3                                             |
|   43650 | REM sleep\|5                                                 |
|   32577 | Central apnea\|Central Apnea                                 |
|    4745 | Stage 4 sleep\|4                                             |
|    3930 | Recording Start Time                                         |
|    3754 | Arousal\|Arousal ()                                          |
|    1095 | Arousal\|Arousal (ARO Limb)                                  |
|     193 | Periodic breathing\|Periodic Breathing                       |
|     133 | Arousal\|Arousal (Asda)                                      |
|      80 | Mixed apnea\|Mixed Apnea                                     |
|      58 | Tachycardia\|Tachycardia                                     |
|      27 | Arousal resulting from respiratory effort\|Arousal (ARO RES) |
|      26 | Respiratory effort related arousal\|RERA                     |
|       8 | Respiratory artifact\|Respiratory artifact                   |
|       2 | Unscored\|9                                                  |
|       2 | Narrow complex tachycardia\|Narrow Complex Tachycardia       |
|       2 | Blood pressure artifact\|Blood pressure artifact             |
|       1 | Spontaneous arousal\|Arousal (ARO SPONT)                     |
