napari-roi

Select regions of interest (ROIs) using napari

https://github.com/bodenmillergroup/napari-roi

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.8%) to scientific vocabulary
Last synced: 7 months ago · JSON representation ·

Repository

Select regions of interest (ROIs) using napari

Basic Info
  • Host: GitHub
  • Owner: BodenmillerGroup
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 50.8 KB
Statistics
  • Stars: 5
  • Watchers: 4
  • Forks: 2
  • Open Issues: 4
  • Releases: 0
Created over 4 years ago · Last pushed 8 months ago
Metadata Files
Readme Changelog Contributing License Citation

README.md

napari-roi

napari hub PyPI License Python Version Issues Pull requests

Select regions of interest (ROIs) using napari

Installation

You can install napari-roi via pip:

pip install napari-roi

Alternatively, you can install napari-roi via conda:

conda install -c conda-forge napari-roi

Usage

The napari-roi plugin can be opened from within napari (napari -> napari-roi: regions of interest) and operates on napari Shapes layers.

ROIs can be added to any napari Shapes layer, either by drawing a standard napari shape (e.g. rectangle), or by adding a rectangular ROI of specified size using the Add ROI functionality in the napari-roi widget. Each ROI is associated with a name, a position (X/Y origin), and a size (width/height). The location of the X/Y origin of all ROIs can be chosen in the napari-roi widget. Note that any shape supported by napari (e.g. ellipse, rectangle, polygon, line, path) can serve as an ROI; for non-rectangular shapes, napari-roi computes rectangular bounding boxes aligned with the napari coordinate system to determine their positions and sizes. ROIs can be edited or deleted by modifying the corresponding shapes in napari, or by editing the corresponding row in the napari-roi widget.

All ROIs in the current Shapes layer can be saved to a comma-separated values (CSV) file using the Save functionality in the napari-roi widget. When the Autosave option is checked, the file is automatically updated on every ROI change. Note that the selected file is specific to the current Shapes layer; ROIs from different Shapes layers cannot be saved to the same file. ROIs can be loaded from a previously saved file and added to the current Shapes layer by opening the file in the napari-roi widget.

CSV files saved using napari-roi adhere to the following format:

| Columns | Description | | --- | --- | | Name | ROI name | | X, Y | Position (X/Y origin) | | W, H | Size (width/height) |

Authors

Created and maintained by Jonas Windhager until February 2023.

Maintained by Milad Adibi from February 2023.

Contributing

Contributing

Changelog

Changelog

License

MIT

Owner

  • Name: BodenmillerGroup
  • Login: BodenmillerGroup
  • Kind: organization

Citation (CITATION.cff)

cff-version: 1.2.0
message: If you use this plugin, please cite it using these metadata
title: 'napari-roi: Select regions of interest (ROIs) using napari'
url: https://github.com/BodenmillerGroup/napari-roi
authors:
- given-names: Jonas
  family-names: Windhager

GitHub Events

Total
  • Watch event: 1
  • Push event: 11
  • Fork event: 1
Last Year
  • Watch event: 1
  • Push event: 11
  • Fork event: 1

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 37
  • Total Committers: 2
  • Avg Commits per committer: 18.5
  • Development Distribution Score (DDS): 0.081
Past Year
  • Commits: 18
  • Committers: 2
  • Avg Commits per committer: 9.0
  • Development Distribution Score (DDS): 0.167
Top Committers
Name Email Commits
Jonas Windhager j****r@u****h 34
Sean Martin s****m@h****m 3
Committer Domains (Top 20 + Academic)
uzh.ch: 1

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 7
  • Total pull requests: 6
  • Average time to close issues: 1 day
  • Average time to close pull requests: 3 months
  • Total issue authors: 6
  • Total pull request authors: 3
  • Average comments per issue: 2.43
  • Average comments per pull request: 0.0
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 3
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • jwindhager (2)
  • HouPB (1)
  • biswajitSM (1)
  • haesleinhuepf (1)
  • DennisDannecker (1)
  • seankmartin (1)
Pull Request Authors
  • pre-commit-ci[bot] (3)
  • jwindhager (2)
  • seankmartin (1)
Top Labels
Issue Labels
documentation (2) bug (1)
Pull Request Labels

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 124 last-month
  • Total dependent packages: 2
    (may contain duplicates)
  • Total dependent repositories: 1
    (may contain duplicates)
  • Total versions: 16
  • Total maintainers: 3
pypi.org: napari-roi

Select regions of interest (ROIs) using napari

  • Versions: 9
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 124 Last month
Rankings
Dependent packages count: 4.8%
Downloads: 12.6%
Average: 18.7%
Dependent repos count: 21.5%
Forks count: 22.6%
Stargazers count: 31.9%
Maintainers (3)
Last synced: 7 months ago
conda-forge.org: napari-roi
  • Versions: 7
  • Dependent Packages: 1
  • Dependent Repositories: 0
Rankings
Dependent packages count: 28.8%
Dependent repos count: 34.0%
Average: 46.0%
Stargazers count: 60.1%
Forks count: 61.1%
Last synced: 7 months ago

Dependencies

.github/workflows/deploy.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
pyproject.toml pypi