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.2.tar.gz (40.0 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.2-py3-none-any.whl (40.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for napari_dinosim-0.1.2.tar.gz
Algorithm Hash digest
SHA256 33c10ee5ec907759234938a63ab0ca93902c00613bbd4adec6d5bb85259b027a
MD5 57f67d1a4c7f9cdc8d618b53efb5af26
BLAKE2b-256 500c879aee722a25929ed51ca388a1d8383fb2de9134b98d1746a7756ccd6c7f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: napari_dinosim-0.1.2-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.12

File hashes

Hashes for napari_dinosim-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 64e4797f6473a19147813d4366ce6e351597914e0572e22acd1ae25340a5e219
MD5 fe4113c7387dcfe600830725c49f3185
BLAKE2b-256 d59b9851a21b0244edaa46b28661aee4d93788de03a0ec0a847309051b32701f

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