Skip to main content

Roimarker

Annotates region of interest (ROI) using matplotlib and Python.

  • Draw rectangular ROIs with your mouse
  • Quickly change to the next image by pressing N
  • Adjust brightness/contrast with keys Z,X,C,V
  • Undo with Ctrl+Z

Installing

pip install roimarker

Usage

A) Standalone tool

python -m roimarker DIRECTORY

Here, replace DIRECTORY with the folder containing all the image files to be annotated.

When finished, a markings.json file is created to the current working directory with the following structure:

{fn1: [ROI_1, ROI_2, ROI_3, ..], fn2: [ROI_1, ...], ...}

where
	ROI_i = [x,y,w,h]

B) In your programs

import matplotlib.pyplot as plt
from roimarker import Marker

# Create matplotlib figure and ax
fig, ax = plt.subplots()

# List of images to annotate
image_fns = ['image1.tif', 'image2.tif', 'image3.tif']

marker = Marker(fig, ax, image_fns, 'markings.json')
marker.run()

Metadata

Release files for roimarker 0.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for roimarker 0.2.1
File Size Uploaded Provenance Actions
roimarker-0.2.1.tar.gz 19.2 kB Without provenance Details for roimarker-0.2.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for roimarker 0.2.1
File Interpreter ABI Platform Actions
roimarker-0.2.1-py3-none-any.whl Python 3 none any Details for roimarker-0.2.1-py3-none-any.whl

Total release size: 38.1 kB

Release files / roimarker-0.2.1.tar.gz

Download URL roimarker-0.2.1.tar.gz
Size 19.2 kB
Tags Source
SHA-256 checksum
How to use checksums
8b4029d1920ed172ef743756cf845d8d517c5ab691912cb6f4d682a374a9178b
BLAKE2b-256 checksum
How to use checksums
b66ae86a3c989b0b51f22704550796068bc01c83ab7a8126f9ae29ac523eeef7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.10

Release files / roimarker-0.2.1-py3-none-any.whl

Download URL roimarker-0.2.1-py3-none-any.whl
Size 19.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ec196a3d94504fdad9d600addbf700a97b6e4408cabae1c8db044f493c51d651
BLAKE2b-256 checksum
How to use checksums
695898c232c8593ff7e1d99dd71c4ee318692bce887d9b17050eb6719c869f56
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.10

Security for roimarker 0.2.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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