Metadata-Version: 2.4
Name: py4d-browser-h5oina
Version: 0.1.0
Summary: py4d-browser plugin for loading Oxford Instruments h5oina EBSD pattern files
Author-email: Yu-Tsun Shao <yutsunsh@usc.edu>
License-Expression: MIT
Project-URL: Homepage, https://github.com/ys755/py4d-browser-h5oina
Project-URL: Bug Tracker, https://github.com/ys755/py4d-browser-h5oina/issues
Keywords: EBSD,Oxford Instruments,h5oina,py4d-browser,electron microscopy
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: py4d-browser
Requires-Dist: h5py
Provides-Extra: lzf
Requires-Dist: hdf5plugin; extra == "lzf"
Dynamic: license-file

# py4d-browser-h5oina

A [py4d-browser](https://github.com/py4dstem/py4d-browser) plugin for loading
Oxford Instruments h5oina EBSD pattern files (`.h5oina`).

## Installation

```bash
pip install py4d-browser-h5oina
```

For files saved with AZtec < 6.3 (h5oina format < v8.0), patterns are
LZF-compressed. Install the optional filter plugin to read those files:

```bash
pip install py4d-browser-h5oina[lzf]
```

## Usage

Launch py4d-browser as usual:

```bash
py4DGUI
```

A new **"Oxford h5oina..."** entry appears in the **Plugins** menu.
Click it, select your `.h5oina` file, and the dataset loads into the browser.

### File format support

| Feature | Support |
|---------|---------|
| Single scan group | ✓ — automatic |
| Multiple scan groups | ✓ — prompts to select one |
| Unprocessed patterns (int16, raw) | ✓ — preferred by default |
| Processed patterns (uint8, background-subtracted) | ✓ — selectable |
| Scan step size (µm) from header | ✓ — set as R-space calibration |
| LZF-compressed patterns (format < v8.0) | ✓ — with `hdf5plugin` installed |

## Development

```bash
git clone https://github.com/ys755/py4d-browser-h5oina
cd py4d-browser-h5oina
pip install -e ".[lzf]"
```

## License

MIT © Yu-Tsun Shao
