Skip to main content

A simple plugin to use DinoSim in napari

Project description

DINOSim

License MIT biorxiv PyPI Python Version tests codecov 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.1.tar.gz (39.2 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.1-py3-none-any.whl (39.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: napari_dinosim-0.1.1.tar.gz
  • Upload date:
  • Size: 39.2 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.1.tar.gz
Algorithm Hash digest
SHA256 dcd8bc7e222e1129723d80b6c97d70b7fdaf5b1dd583fb1dd5f58d3c1d06d9d6
MD5 8a5f9eb877237e41ca42742f3ac17ff5
BLAKE2b-256 69de3c26988874a4366776e319e737816fa8969d45c0a842ee4077e9e16f2b5f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: napari_dinosim-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 39.8 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5e94a78dbd1031af4a45e1c12253adf5064639d864f580c00b15e5079cc79cb2
MD5 566e729e38d053c5ae85667af231e4be
BLAKE2b-256 e8684c28a3c1e76eb7436503180c794e62799da5b971c8ce74b728f22ccaa2ca

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