Skip to main content

Read ROI files .zip or .roi generated with ImageJ.

Project description

# read-roi

[![PyPI version](https://img.shields.io/pypi/v/read-roi.svg?maxAge=2591000)](https://pypi-hypernode.com/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 > 2.7 and > 3.4

## 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

- Modify version number in `read_roi/__init__.py`
- Commit and push changes
- Make Github release
- Create packages : `python setup.py sdist bdist_wheel`
- Upload packages : `twine upload dist/*`
- Update `conda-forge` recipe.

Project details


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.0.1.tar.gz (5.4 kB view details)

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for read-roi-1.0.1.tar.gz
Algorithm Hash digest
SHA256 4a1d41c3268f6c231cccb9c67d96c6a7bf6783a9c94362a2c14327240a5ef25f
MD5 6fae935ca4d9e3f9730ea848d51d8e17
BLAKE2b-256 520f15c4d51523f034256d4997e76cdbacd49e35477b8f9420a28c9a82aa0c1f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page