Metadata-Version: 2.4
Name: isdreader
Version: 0.0.3
Summary: Isd Reader Library for parsing ISD folder and loading binary images
Author-email: ikk Maintainer <maintainer@insightkk.net>
License-Expression: MIT
Project-URL: Homepage, https://insightkk.net/isdreader/
Project-URL: Documentation, https://insightkk.net/isdreader/
Project-URL: Issues, https://github.com/Insight-kk/isdreader/issues
Project-URL: Source, https://github.com/Insight-kk/isdreader
Keywords: isd,ultrasound,inspection,imaging,numpy
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 :: Only
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: numpy>=1.20.0
Dynamic: license-file

<p align="center">
	<img src="Images/logo/isdreader-full.svg" alt="isdreader" width="480">
</p>

# isdreader

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
<!--
[![PyPI version](https://img.shields.io/pypi/v/isdreader.svg)](https://pypi.org/project/isdreader/)
![Python Versions](https://img.shields.io/pypi/pyversions/isdreader)
![Wheel](https://img.shields.io/pypi/wheel/isdreader)
![Python Version](https://img.shields.io/pypi/pyversions/isdreader)
-->

`isdreader` is a Python library for parsing ISD folders and loading binary inspection image data as NumPy arrays.

## Installation

```sh
pip install isdreader
```

## Quick Start

```python
from isdreader import IsdReader

# Load ISD folder
isd = IsdReader(isd_path="/path/to/your.isd")

# Get channel and data gate
ch = isd.GetCh(1)
gate = ch.GetDataGate(2)

# Load image
img = gate.GetImage("AP", slice_no=2)
arr = img.load_image()

# Access metadata
print(f"Size: {img.WidthPixel}x{img.HeightPixel}")
print(f"Material Velocity: {img.MaterialVelocity}")
```

`arr` is returned as a 2D NumPy array with a dtype derived from the source image data.

## Documentation

Full API documentation:
<https://insightkk.net/isdreader/>

## License

MIT License - see LICENSE file for details
