组织、可视化和分析组织学图像。
项目描述
组织、可视化和分析组织学图像。
HistomicsUI 使用 Girder 组织和管理全切片图像 (WSI) 文件。它提供了一个专用界面来选择WSI、手动添加注释,以及在对所有或部分图像运行分析和算法。
Girder提供身份验证、访问控制和多种存储选项,包括使用本地文件系统和Amazon S3。WSI图像通过 large_image 模块读取和显示。算法使用 Docker 容器化,并通过 slicer_cli_web Girder插件运行。这些可以在多个工作机器上通过 Girder Worker 和 celery 运行。
HistomicsTK 提供了一套常用算法。
许可证
HistomicsUI 在 Apache License,Version 2.0 下提供。有关更多详细信息,请参阅 LICENSE
社区
安装
Linux
在Linux操作系统上使用Python 3.8或更高版本
先决条件
必须安装并运行MongoDB。
必须安装适当的Python版本。
HistomicsUI使用large_image库来读取不同的图像文件格式。您需要安装用于将要使用的文件的正确源。
# install all sources from the main repo
pip install large-image[sources] --find-links https://girder.github.io/large_image_wheels
或者
# install openslide and tiff sources
pip install large-image-source-tiff large-image-source-openslide --find-links https://girder.github.io/large_image_wheels
现在安装histomicsui包,让Girder构建其UI,并启动Girder服务器。注意,Girder可能仍需要一个旧版本的node(14.x)来正确构建 - 可以使用nvm来管理多个版本的node。
pip install histomicsui[analysis]
girder build
girder serve
使用Girder Worker
pip install girder_slicer_cli_web[worker]
GW_DIRECT_PATHS=true girder-worker -l info -Ofair --prefetch-multiplier=1
Girder Worker需要rabbitmq消息服务运行以与Girder通信。Girder和Girder Worker都应该以属于docker组的用户身份运行。
首次启动HistomicsUI时,您还需要配置Girder至少一个用户和一个assetstore(请参阅Girder文档)。此外,建议您安装HistomicsTK算法。这可以通过访问管理员控制台,插件,Slicer CLI Web设置来完成。设置默认任务上传文件夹,然后导入dsarchive/histomicstk:latest docker镜像。
参考部署
HistomicsUI的标准部署是Digital Slide Archive。相关的仓库有工具,可以通过Docker,VirtualBox或Ubuntu上的shell脚本轻松安装。
开发
在HistomicsUI上进行开发的便捷方法是使用Digital Slide Archive的devops脚本。
如果您正在修改HistomicsUI前端,可以使用girder build的--watch-plugin参数让Girder监视源代码,并在更改时执行热重载。有关更多信息,请参阅Girder文档。
作业中的注释和元数据
这处理上传的注释和元数据的摄取,并将它们与Girder数据库中现有的大图像项相关联。这些注释和元数据通常通过作业生成,例如HistomicsTK任务,但也可以手动添加。
如果上传到Girder系统的文件包含一个reference记录,并且该reference记录包含一个identifier字段和至少一个fileId和itemId字段,可以使用特定的标识符来摄取结果。如果reference记录中指定了userId,则与该用户关联的注释或元数据的添加权限。
元数据
以ItemMetadata结尾的标识符被加载并设置为包含指定文件的关联项的元数据。从概念上讲,这等同于调用PUT item/{id}/metadata端点。
注释
以AnnotationFile结尾的标识符被加载为注释,与包含指定文件的项相关联。从概念上讲,这等同于通过与指定fileId或itemId关联的项的注释端点上传文件。
如果注释文件包含任何包含 girderId 值的元素注释,则 girderId 值可以是带有匹配 uuid 字段的参考记录的文件上传的文件的 identifier 值。此操作需要 uuid 字段,但将其视为任意字符串。
资金
本项工作部分由NIH资助,资助项目编号为U24-CA194362-01。
项目详情
下载文件
下载适合您平台的文件。如果您不确定该选择哪个,请了解有关安装包的更多信息。