SuperAPI AI 工具集

omero-integration

数据与分析

查看项目

更新于 10-21 16:18

技能介绍

OMERO Integration 是一个面向 OMERO.server 显微成像数据的安全检查与自动化技能,主要使用 omero-py、BlitzGateway、OMERO CLI 以及 OMERO.web 的稳定公开 API 来访问和操作数据。

用途 该技能用于在明确、最小的数据范围内检查 OMERO 中的图像、注释、ROI、表格和渲染信息,并在获得明确批准后执行受控的写入或导入导出操作。它强调 OMERO 数据可能包含未发表图像、标识符、注释、原始文件和衍生测量结果,因此默认采取保守、可审计的操作方式。

主要能力

  • 通过 BlitzGateway(omero-py)进行对象遍历、像素访问、注释、ROI、渲染和服务调用。
  • 通过 OMERO CLI 管理会话、扫描/导入、OME-TIFF 或 XML 导出、脚本和行政插件。
  • 使用 OMERO.web api 和 webgateway 这两个官方文档称为稳定公开 API 的接口;文档化的 JSON API 支持版本发现且对象覆盖有限。
  • 使用 OMERO.server 脚本(上传的插件,由服务器基础设施执行),区别于 scripts/ 中捆绑的本地客户端辅助工具。
  • 提供本地安全辅助脚本:validate_config.py(仅本地校验命名端点/认证变量)、inventory.py(有界只读对象清单,分页 JSON 输出)、export_image_metadata.py(指定图像的注释/ROI JSON 导出,默认脱敏并限制每类数量,不下载文件字节或像素)、plan_transfer.py(仅本地导入扫描或逐图像导出计划,不调用 OMERO,不输出凭据标志)。

使用方式

  • 安装可复现客户端:创建 Python 3.12 环境(uv venv --python 3.12 .venv),安装与解释器、操作系统、架构和 wheel 标签匹配的 IcePy 3.6.5 wheel,再安装 omero-py==5.22.1。不要用 Ice 3.7,OMERO 5.6 支持矩阵将 Ice 3.6 标为推荐、3.7 标为不支持。
  • 凭据与连接:从调用环境或密钥管理器中的命名 OMERO_* 变量读取凭据,不要把密码放在 omero CLI 命令中。默认 secure=True。示例代码使用 BlitzGateway 连接,设置 limit、offset、order_by,并在 finally 中关闭连接。
  • 远程辅助脚本默认 dry-run,需 --execute 才执行;--help 在未安装 OMERO 时也可用。
  • 操作前需确认服务器版本及其测试过的 OMERO.py 配对、目标主机、SSL 路由端口、用户/会话和单一组、精确对象 ID/类型和硬限制,以及名称、注释值、文件名、ROI 标签、所有者名称、像素或原始文件是否可离开服务器。

适用场景 适用于需要安全访问 OMERO.server 显微成像数据的科研或数据管理场景,包括只读清单、元数据导出、导入/导出计划、注释与 ROI 处理、表格操作和渲染相关任务。

限制

  • 该技能是 2026-07-23 刷新的快照,固定 omero-py==5.22.1,不保证每个 OMERO.server 版本都接受该客户端;其他服务器版本应查阅其发布条目并使用与其测试过的 OMERO.py 版本。
  • omero-py==5.22.1 要求 Python 3.10 或更新;支持矩阵支持 3.10 和 3.11,推荐 3.12,3.13/3.14 仍标为“即将支持”。
  • 仅导入/管理命令需要 OMERODIR 指向兼容的解压 OMERO.server 目录;普通远程 BlitzGateway 客户端不需要该服务器树。
  • 不得在命令参数、源代码、输出 JSON、日志、回溯或聊天中放置密码或会话密钥;会话密钥是持有者凭据。
  • 不得将对象请求变成组范围或跨组导出,除非明确批准。
  • 写入操作(注释/链接创建、渲染默认保存、图像创建、导入、脚本上传、表格写入、所有权或组变更、删除)需要精确审查的目标。
  • 不得仅为“测试”示例而连接真实服务器。
  • 上游包为 GPL-2.0-or-later;该技能自身文件为 MIT。
  • 资料未提供具体收费、价格或平台支持范围等信息。