Skip to main content

A simple plugin to use DINOSim in napari

Project description

DINOSim

License: MIT biorxiv PyPI Python Version tests napari hub

DINOSim-simple

A napari plugin for zero-shot image segmentation using DINOv2 vision transformers.


Overview

napari-DINOSim enables zero-shot image segmentation by selecting reference points on an image. The plugin leverages DINOv2's powerful feature extraction capabilities to compute similarity maps and generate segmentation masks.

For detailed information about the widget's functionality, UI elements, and usage instructions, please refer to the Plugin Documentation. A simple example notebook demonstrating how to use DINOSim programmatically is also available.

Installation

You can install napari-DINOSim via pip:

pip install napari-dinosim

or from source using conda:

# Clone the repository
git clone https://github.com/AAitorG/napari-DINOSim.git
cd napari-DINOSim

# Create and activate the conda environment
conda env create -f environment.yml
conda activate napari-dinosim

Usage

To launch napari, run the following command in your terminal:

napari

Within the napari interface, locate and click the DINOSim segmentation plugin in the Plugins section of the top bar. You can then:

  1. Drag and drop your image into the napari viewer
  2. Select points on the objects you want to segment
  3. The plugin will automatically generate segmentation masks based on your selections

For more detailed instructions and examples, please refer to our Plugin Documentation.

License

Distributed under the terms of the MIT license, "napari-DINOSim" is free and open source software.

Citation

Please note that DINOSim is based on a publication. If you use DINOSim in your research, please be so kind to cite our work:

@article {Gonzalez-Marfil2025dinosim,
    title = {DINOSim: Zero-Shot Object Detection and Semantic Segmentation on Electron Microscopy Images},
    author = {Gonz{\'a}lez-Marfil, Aitor and G{\'o}mez-de-Mariscal, Estibaliz and Arganda-Carreras, Ignacio},
    journal = {bioRxiv},
    publisher = {Cold Spring Harbor Laboratory},
    url = {https://www.biorxiv.org/content/early/2025/03/13/2025.03.09.642092},
    doi = {10.1101/2025.03.09.642092},
    year = {2025}
}

Contributing

Contributions are very welcome! Tests can be run with tox. Please ensure the test coverage at least stays the same before submitting a pull request.

Issues

If you encounter any problems, please file an issue along with a detailed description.

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

napari_dinosim-0.1.3.tar.gz (40.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

napari_dinosim-0.1.3-py3-none-any.whl (40.5 kB view details)

Uploaded Python 3

File details

Details for the file napari_dinosim-0.1.3.tar.gz.

File metadata

  • Download URL: napari_dinosim-0.1.3.tar.gz
  • Upload date:
  • Size: 40.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.13

File hashes

Hashes for napari_dinosim-0.1.3.tar.gz
Algorithm Hash digest
SHA256 c1c9cb117022f226489c04b3f49a6a226df29829d1740cb3e255d05108ffe617
MD5 b90c095841038776dd84deba0600f5e0
BLAKE2b-256 01677db118bdb59b0cdbd414b7bd9f642efe91944ff3efcb95196f3e5acbbd56

See more details on using hashes here.

File details

Details for the file napari_dinosim-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: napari_dinosim-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 40.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.13

File hashes

Hashes for napari_dinosim-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d2c8b33e090678c64ccf8d9e0b2f6217473db925c04d61274db8bd51faae13c9
MD5 7cc4b73738300e7448214a75a6c3c14d
BLAKE2b-256 655e92877809fa0acf9d31d94973e0a5c1b47bd182bd485e128d100dd41678f5

See more details on using hashes here.

Supported by

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