roifile 2025.12.12__py3-none-any.whl

roifile-2025.12.12.dist-info/METADATA

@@ -0,0 +1,229 @@
+Metadata-Version: 2.4
+Name: roifile
+Version: 2025.12.12
+Summary: Read and write ImageJ ROI format
+Home-page: https://www.cgohlke.com
+Author: Christoph Gohlke
+Author-email: cgohlke@cgohlke.com
+License: BSD-3-Clause
+Project-URL: Bug Tracker, https://github.com/cgohlke/roifile/issues
+Project-URL: Source Code, https://github.com/cgohlke/roifile
+Platform: any
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: numpy
+Provides-Extra: all
+Requires-Dist: matplotlib; extra == "all"
+Requires-Dist: tifffile; extra == "all"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: platform
+Dynamic: project-url
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+Read and write ImageJ ROI format
+================================
+
+Roifile is a Python library to read, write, create, and plot `ImageJ`_ ROIs,
+an undocumented and ImageJ application specific format to store regions of
+interest, geometric shapes, paths, text, and whatnot for image overlays.
+
+.. _ImageJ: https://imagej.net
+
+:Author: `Christoph Gohlke <https://www.cgohlke.com>`_
+:License: BSD-3-Clause
+:Version: 2025.12.12
+:DOI: `10.5281/zenodo.6941603 <https://doi.org/10.5281/zenodo.6941603>`_
+
+Quickstart
+----------
+
+Install the roifile package and all dependencies from the
+`Python Package Index <https://pypi.org/project/roifile/>`_::
+
+    python -m pip install -U "roifile[all]"
+
+View overlays stored in a ROI, ZIP, or TIFF file::
+
+    python -m roifile file.roi
+
+See `Examples`_ for using the programming interface.
+
+Source code, examples, and support are available on
+`GitHub <https://github.com/cgohlke/roifile>`_.
+
+Requirements
+------------
+
+This revision was tested with the following requirements and dependencies
+(other versions may work):
+
+- `CPython <https://www.python.org>`_ 3.11.9, 3.12.10, 3.13.11 3.14.2 64-bit
+- `NumPy <https://pypi.org/project/numpy>`_ 2.3.5
+- `Tifffile <https://pypi.org/project/tifffile/>`_ 2025.10.16 (optional)
+- `Matplotlib <https://pypi.org/project/matplotlib/>`_ 3.10.7 (optional)
+
+Revisions
+---------
+
+2025.12.12
+
+- Move tests to separate module.
+
+2025.5.10
+
+- Support Python 3.14.
+
+2025.2.20
+
+- Drop support for Python 3.9.
+
+2024.9.15
+
+- Improve typing.
+- Deprecate Python 3.9, support Python 3.13.
+
+2024.5.24
+
+- Fix docstring examples not correctly rendered on GitHub.
+
+2024.3.20
+
+- Fix writing generator of ROIs (#9).
+
+2024.1.10
+
+- Support text rotation.
+- Improve text rendering.
+- Avoid array copies.
+- Limit size read from files.
+
+2023.8.30
+
+- Fix linting issues.
+- Add py.typed marker.
+
+2023.5.12
+
+- Improve object repr and type hints.
+- Drop support for Python 3.8 and numpy < 1.21 (NEP29).
+
+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).
+- Add subpixel_coordinates in frompoints for out-of-range integer coordinates.
+
+2022.7.29
+
+- …
+
+Refer to the CHANGES file for older revisions.
+
+Notes
+-----
+
+The ImageJ ROI format cannot store integer coordinate values outside the
+range of -5000..60536.
+
+Refer to the ImageJ `RoiDecoder.java
+<https://github.com/imagej/ImageJ/blob/master/ij/io/RoiDecoder.java>`_
+source code for a reference implementation.
+
+Other Python packages handling ImageJ ROIs:
+
+- `ijpython_roi <https://github.com/dwaithe/ijpython_roi>`_
+- `read-roi <https://github.com/hadim/read-roi/>`_
+- `napari_jroitools <https://github.com/jayunruh/napari_jroitools>`_
+
+Examples
+--------
+
+Create a new ImagejRoi instance from an array of x, y coordinates:
+
+>>> roi = ImagejRoi.frompoints([[1.1, 2.2], [3.3, 4.4], [5.5, 6.6]])
+>>> roi.roitype = ROI_TYPE.POINT
+>>> roi.options |= ROI_OPTIONS.SHOW_LABELS
+
+Export the instance to an ImageJ ROI formatted byte string or file:
+
+>>> out = roi.tobytes()
+>>> out[:4]
+b'Iout'
+>>> roi.tofile('_test.roi')
+
+Read the ImageJ ROI from the file and verify the content:
+
+>>> roi2 = ImagejRoi.fromfile('_test.roi')
+>>> roi2 == roi
+True
+>>> roi.roitype == ROI_TYPE.POINT
+True
+>>> roi.subpixelresolution
+True
+>>> roi.coordinates()
+array([[1.1, 2.2],
+       [3.3, 4.4],
+       [5.5, 6.6]], dtype=float32)
+>>> roi.left, roi.top, roi.right, roi.bottom
+(1, 2, 7, 8)
+>>> roi2.name = 'test'
+
+Plot the ROI using matplotlib:
+
+>>> roi.plot()
+
+Write the ROIs to a ZIP file:
+
+>>> roiwrite('_test.zip', [roi, roi2], mode='w')
+
+Read the ROIs from the ZIP file:
+
+>>> rois = roiread('_test.zip')
+>>> assert len(rois) == 2 and rois[0] == roi and rois[1].name == 'test'
+
+Write the ROIs to an ImageJ formatted TIFF file:
+
+>>> import numpy
+>>> import tifffile
+>>> tifffile.imwrite(
+...     '_test.tif',
+...     numpy.zeros((9, 9), 'u1'),
+...     imagej=True,
+...     metadata={'Overlays': [roi.tobytes(), roi2.tobytes()]},
+... )
+
+Read the ROIs embedded in an ImageJ formatted TIFF file:
+
+>>> rois = roiread('_test.tif')
+>>> assert len(rois) == 2 and rois[0] == roi and rois[1].name == 'test'
+
+View the overlays stored in a ROI, ZIP, or TIFF file from a command line::
+
+    python -m roifile _test.roi
+
+For an advanced example, see `roifile_demo.py` in the source distribution.

roifile-2025.12.12.dist-info/RECORD

@@ -0,0 +1,10 @@
+roifile/__init__.py,sha256=AsK--1p3Z33qFLqChDMKTCqey-LDT_vGCf92RGl9Pe0,207
+roifile/__main__.py,sha256=Mfn3wm-4cRRChIRonbEcZZT7eRX6RFlS31S8wS1JAVM,132
+roifile/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+roifile/roifile.py,sha256=3UBvkfSGu5RzsbjbJni4L_fMQD6uDJgw9kXDtUnnPsw,44918
+roifile-2025.12.12.dist-info/licenses/LICENSE,sha256=1yXweb-z6uE6JaIRMz2UpNOF-sYNbqTyHYhmRHWjyEI,1559
+roifile-2025.12.12.dist-info/METADATA,sha256=LSbdXby1cHiZf9GnFDyUkWPFqfU5_hxQjz8lEePWcjE,5955
+roifile-2025.12.12.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+roifile-2025.12.12.dist-info/entry_points.txt,sha256=xP8cwEUbAUeROLXNRanJnAIl13tagbjSSDGfVWf2vh0,49
+roifile-2025.12.12.dist-info/top_level.txt,sha256=QlfLomxPxuYNU0TTR7MXoVBAEAXCj2WJyKvoCJxNwek,8
+roifile-2025.12.12.dist-info/RECORD,,

roifile-2025.12.12.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

roifile-2025.12.12.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+roifile = roifile.roifile:main

roifile-2025.12.12.dist-info/licenses/LICENSE

@@ -0,0 +1,30 @@
+BSD-3-Clause license
+
+Copyright (c) 2020-2025, Christoph Gohlke
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+   this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

roifile-2025.12.12.dist-info/top_level.txt

@@ -0,0 +1 @@
+roifile