Metadata-Version: 2.1
Name: uff-reader
Version: 0.0.2
Summary: Python interface for the Ultrasound File Format (UFF)
Author-email: Walter Simson <walter.simson@tum.de>
License-Expression: MIT
License-File: LICENSE
Requires-Dist: h5py>=3.5.0
Requires-Dist: numpy>=1.20
Requires-Dist: pytest>=6.2.4
Requires-Dist: requests>=2.26.0
Requires-Dist: scipy>=1.7.0
Description-Content-Type: text/markdown

# uff-reader 

Python Reader for the Ultrasound File Format

This python package is based on the standard defined in v0.3.0 of
the [Ultrasound File Format](https://bitbucket.org/ultrasound_file_format/uff/wiki/Home).

## Instalation

to install run:

```pip install uff-reader```

## Getting Started

``` python3
from uff import UFF

# load uff object from uff file <file-name>
uff_object = UFF.load('<file-name>')

# print uff summary
uff_object.summary
```
## Cite
```bibtex
@inproceedings{bernard2018ultrasound,
  title={The ultrasound file format (UFF)-first draft},
  author={Bernard, Olivier and Bradway, David and Hansen, Hendrik HG and Kruizinga, Pieter and Nair, Arun and Perdios, Dimitris and Ricci, Stefano and Rindal, Ole Marius Hoel and Rodriguez-Molares, Alfonso and Stuart, Matthias Bo and others},
  booktitle={2018 IEEE International Ultrasonics Symposium (IUS)},
  pages={1--4},
  year={2018},
  organization={IEEE}
}
```
