Metadata-Version: 2.4
Name: brighteyes-mcs-reader
Version: 0.1.0
Summary: Reader utilities for BrightEyes MCS HDF5 files.
Author-email: Mattia Donato <mattia.donato@iit.it>
License-Expression: BSD-3-Clause
Project-URL: Homepage, https://github.com/VicidominiLab/BrightEyes-MCS-Reader
Project-URL: Repository, https://github.com/VicidominiLab/BrightEyes-MCS-Reader
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Image Processing
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: h5py
Requires-Dist: numpy
Provides-Extra: dev
Requires-Dist: build; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: twine; extra == "dev"
Dynamic: license-file

# BrightEyes-MCS-Reader

Reader-only utilities for BrightEyes MCS HDF5 files.

This package contains the current schema reader in
- `brighteyes_mcs_reader.reader` for the h5 scheme > 0.0.6
- the legacy compatibility helpers in `brighteyes_mcs_reader.reader_legacy` for the pure raw output of BrightEyes-MCS (h5 scheme == 0.0.2). 

## Install

```bash
pip install brighteyes-mcs-reader
```

## Usage

```python
from brighteyes_mcs_reader import list_datasets, read_signal

for info in list_datasets("measurement.h5"):
    print(info.path, info.kind, info.shape)

signal = read_signal("measurement.h5", time=0, depth=0, channel="sum")
print(signal.data.shape, signal.dims)
```

Legacy files can be loaded with:

```python
from brighteyes_mcs_reader import reader_legacy

data, metadata = reader_legacy.load("legacy_measurement.h5")
```

Calibration, output building, conversion, alignment, and plotting helpers have
moved to `BrightEyes-MCS-DataPrep`.
