Metadata-Version: 2.4
Name: pyPhasesRecordloaderDomino
Version: 0.2.0
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



## Usage

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

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

```yaml
name: DominoProject
plugins:
  - pyPhasesML
  - pyPhasesRecordloaderDomino
  - pyPhasesRecordloader

phases:
  - name: MyPhase

config:
  domino-path: C:/datasets/recordings

```

In a phase (`phases/MyPhase.py`) you can access the records using 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`.


The RecordLoader requires EDF files (using the EDF export), annotations (using the annotation export) and ERG files from the raw Domino data. An example of our setup can be found at https://gitlab.com/sleep-is-all-you-need/dominodatasetcreator.
