From 5d6634388f171f12b7206c986b5eeacd07aa59c2 Mon Sep 17 00:00:00 2001 From: Christoph Gohlke Date: Mon, 13 Feb 2023 00:09:12 +0000 Subject: [PATCH] Release v2023.2.12 --- README.rst | 46 ++++++++++++++++++++++++++++++++-------------- 1 file changed, 32 insertions(+), 14 deletions(-) diff --git a/README.rst b/README.rst index 1d6206a..a1505ff 100644 --- a/README.rst +++ b/README.rst @@ -9,31 +9,45 @@ interest, geometric shapes, paths, text, and whatnot for image overlays. :Author: `Christoph Gohlke `_ :License: BSD 3-Clause -:Version: 2022.9.19 -:DOI: 10.5281/zenodo.6941603 +:Version: 2023.2.12 +:DOI: `10.5281/zenodo.6941603 `_ -Installation ------------- +Quickstart +---------- + +Install the roifile package and all dependencies from the +`Python Package Index `_:: + + python -m pip install -U roifile[all] + +View overlays stored in a ROI, ZIP, or TIFF file:: -Install the roifile package and common dependencies from the -Python Package Index:: + python -m roifile file.roi - python -m pip install -U roifile tifffile matplotlib +See `Examples`_ for using the programming interface. + +Source code, examples, and support are available on +`GitHub `_. Requirements ------------ -This release has been tested with the following requirements and dependencies +This revision was tested with the following requirements and dependencies (other versions may work): -- `CPython 3.8.10, 3.9.13, 3.10.7, 3.11.0rc2 `_ -- `Numpy 1.22.4 `_ -- `Tifffile 2022.8.12 `_ (optional) -- `Matplotlib 3.5.3 `_ (optional) +- `CPython 3.8.10, 3.9.13, 3.10.10, 3.11.2 `_ +- `Numpy 1.23.5 `_ +- `Tifffile 2023.2.3 `_ (optional) +- `Matplotlib 3.6.3 `_ (optional) Revisions --------- +2023.2.12 + +- Delay import of zipfile. +- Verify shape of coordinates on write. + 2022.9.19 - Fix integer coordinates to -5000..60536 conforming with ImageJ (breaking). @@ -87,7 +101,11 @@ Notes ----- The ImageJ ROI format cannot store integer coordinate values outside the -range of -32768 to 32767 (16-bit signed). +range of -5000..60536. + +Refer to the ImageJ `RoiDecoder.java +`_ +source code for a reference implementation. Other Python packages handling ImageJ ROIs: @@ -133,4 +151,4 @@ Plot the ROI using matplotlib: View the overlays stored in a ROI, ZIP, or TIFF file from a command line:: - $ python -m roifile _test.roi + python -m roifile _test.roi