Metadata-Version: 2.4
Name: pyPhasesRecordloader
Version: 0.12.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: numpy
Requires-Dist: tqdm
Requires-Dist: pandas
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

# pyPhasesRecordloader

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Unified biomedical signal loading base for pyPhases — EDF, H5, MAT, WFDB. Required by all dataset loaders.


## Install

```bash
pip install pyPhasesRecordloader
```

```

→ [Loading Data](https://sleepyphases.readthedocs.io/en/latest/tutorial/load-data.html)  
→ [Creating new Record Loaders](https://sleepyphases.readthedocs.io/en/latest/guides/recordloader.html)  
→ [Create new Vendor Config](https://sleepyphases.readthedocs.io/en/latest/guides/vendor-config.html)

## 🎯 Overview

pyPhasesRecordloader is designed for researchers and developers working with biomedical signals (EEG, ECG, EMG, PPG, etc.). It provides:

- **Unified Signal Interface**: Standardized classes for handling raw signals and multi-channel recordings
- **Multiple Format Support**: Built-in loaders for EDF, H5, MAT, WFDB, and XML annotation files
- **Flexible Data Sources**: Download capabilities from local folders, web directories, and S3-compatible storage
- **Signal Processing**: Channel combination, normalization, resampling, and preprocessing
- **Event Management**: Annotation and event handling with frequency adjustment

## 📦 Installation

```bash
pip install pyPhasesRecordloader
```

add to project.yaml:
```yaml
plugins:
- pyPhasesRecordloader
```


### Dependencies

- pyPhases
- numpy
- tqdm
- pandas

Optional dependencies for specific loaders:
- `pyedflib` - for EDF file support
- `h5py` - for H5 file support
- `scipy` - for MAT file support
- `wfdb` - for WFDB format support
- `boto3` - for S3 downloader support
