跳转到主要内容

napari/OMERO互操作性

项目描述

napari-omero

License PyPI Python Version CI codecov conda-forge

此包提供了OMERO图像管理平台(OMERO)和napari(一个快速的多维图像查看器,用于Python)之间的互操作性。

它为从napari中浏览OMERO实例提供了GUI界面,并为OMERO和napari CLIs提供了命令行界面扩展。

demo

功能

  • 具有缩略图预览的GUI界面,用于浏览远程OMERO数据。
  • 将远程nD图像从OMERO服务器加载到napari中
  • 在滑块移动时按需加载面(“懒加载”)。
  • 会话管理(登录记忆)
  • 在napari中应用OMERO渲染设置(对比度限制、颜色图、活动通道、当前Z/T位置)

作为napari停靠小部件

要启动包含OMERO浏览器的napari,请安装此软件包并运行

napari-omero

您还可以手动将OMERO浏览器小部件添加到napari查看器中

import napari

viewer = napari.Viewer()
viewer.window.add_plugin_dock_widget('napari-omero')

napari.run()

作为napari插件

此软件包提供了一个napari读取器插件,它接受OMERO资源作为“代理字符串”(例如 omero://Image:<ID>)或作为OMERO webclient URLS

viewer = napari.Viewer()

# omero object identifier string
viewer.open("omero://Image:1")

# or URLS: https://help.openmicroscopy.org/urls-to-data.html
viewer.open("http://yourdomain.example.org/omero/webclient/?show=image-314")

这些在napari命令行界面中也将正常工作,例如

napari omero://Image:1
# or
napari http://yourdomain.example.org/omero/webclient/?show=image-314

作为OMERO CLI插件

此软件包还充当OMERO CLI的插件

omero napari view Image:1
  • 在napari中创建的ROIs可以通过“保存ROIs”按钮保存回OMERO。
  • napari查看器控制台具有BlitzGateway的'conn'和'omero_image'上下文。

安装

需要Python 3.7 - 3.10。

从conda

从conda安装omero-py是最简单的方法,因此建议的步骤是从conda安装所有内容,使用conda-forge频道

conda install -c conda-forge napari-omero

从pip

可以从pip安装napari-omero,但您仍然需要omero-py

conda create -n omero -c conda-forge python=3.9 omero-py
conda activate omero
pip install napari-omero[all]  # the [all] here is the same as `napari[all]`

问题

这是alpha软件,有些功能可能无法正常工作或性能不佳!欢迎提交错误报告
  • 实验性的,肯定还有bug! 错误报告欢迎!
  • 远程加载仍然可能非常慢... 虽然这并不是此插件的问题。数据集被包装为延迟的dask堆栈,远程数据获取时间可能很长。关于napari中的异步渲染从OMERO的瓦片加载的计划可能会最终提高主观性能... 但远程数据加载可能始终是限制因素。要尝试异步加载,请以NAPARI_ASYNC=1 napari-omero启动程序。

贡献

欢迎贡献!要设置开发环境

# clone this repo:
git clone https://github.com/tlambert03/napari-omero.git
# change into the new directory
cd napari-omero
# create conda environment
conda env create -f environment.yml
# activate the new env
conda activate napari-omero

# install in editable mode
pip install -e .

为了保持代码质量良好,此仓库使用flake8mypyblack。要强制在提交代码时执行代码质量检查,您可以使用pre-commit

# install pre-commit which will run code checks prior to commits
pre-commit install

原始OMERO数据加载器和CLI扩展由Will Moore创建。

napari读取器插件和GUI浏览器由Talley Lambert创建。

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解有关安装软件包的更多信息。

源分发

napari_omero-0.2.1.tar.gz (10.2 MB 查看散列)

上传时间

构建分发

napari_omero-0.2.1-py3-none-any.whl (26.5 kB 查看散列)

上传于 Python 3

由以下支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误日志 StatusPage StatusPage 状态页面