Skip to main content
# read-roi

[![PyPI version](https://img.shields.io/pypi/v/read-roi.svg?maxAge=2591000)](https://pypi.org/project/read-roi/)

Read ROI files .zip or .roi generated with ImageJ. Code is largely inspired from : http://rsb.info.nih.gov/ij/developer/source/ij/io/RoiDecoder.java.html

## Functions

```python
from read_roi import read_roi_file
from read_roi import read_roi_zip

roi = read_roi_file(roi_file_path)

# or

rois = read_roi_zip(roi_zip_path)
```

## Note

- Some format specifications are not implemented. See RoiDecoder.java for details.
- Most of "normal" ROI file should work.
- Feel free to hack it and send me modifications.

## Requirements

- Python 3.4 and above

## Install

`pip install read-roi`

Or you can use Anaconda and `conda-forge` :

```
conda config --add channels conda-forge
conda install read-roi
```

## License

Under BSD license. See [LICENSE](LICENSE).

## Authors

- Hadrien Mary <hadrien.mary@gmail.com>

## How to release a new version

- Run `python release.py`
- Create and upload packages : `python setup.py sdist bdist_wheel && twine upload dist/*`
- Update `conda-forge` recipe.



Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

read-roi-1.4.0.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

read_roi-1.4.0-py2.py3-none-any.whl (6.4 kB view details)

Uploaded Python 2Python 3

File details

Details for the file read-roi-1.4.0.tar.gz.

File metadata

  • Download URL: read-roi-1.4.0.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for read-roi-1.4.0.tar.gz
Algorithm Hash digest
SHA256 323fe5e1deb253afbc42f0d0eabe3f05d9b16639efd96a7e2188b1ccc72d9ed8
MD5 d884fc212246fd37e34fb50cc07e829a
BLAKE2b-256 b32cf9967c31d318497fad21df72f1a5050fbed93f9ee48337d8678b870a512d

See more details on using hashes here.

File details

Details for the file read_roi-1.4.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for read_roi-1.4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5144202ec1f446d90a47da16841eb6c0dd2f53c5003b262e087a429e5e401f9d
MD5 27cbe01ca183c280697bf908e82703e4
BLAKE2b-256 e19473aca2bfc5b3abcc8a6d152b075c58b836a69ffd720baef81d3909c6ab63

See more details on using hashes here.

Release history Release notifications | RSS feed

1.6.0

1 file

1.5.2

1 file

1.5.1

1 file

1.5.0

1 file

1.4.6

1 file

1.4.5

1 file

1.4.4

1 file

1.4.3

1 file

1.4.2

2 files

This release

1.4.0 This release

2 files

1.3.2

2 files

1.3.0

2 files

1.2.0

2 files

1.1.0

2 files

1.0.1

1 file

1.0.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page