跳转到主要内容

用于从ImagingDataCommons索引查询和下载数据的软件包

项目描述

idc-index

Actions Status Documentation Status

PyPI version PyPI platforms

Discourse Forum

[!WARNING]

此软件包处于早期开发阶段。其功能API将发生变化。

请关注更新和文档,并通过在此存储库中打开问题或在 IDC 用户论坛 中发起讨论来分享您的反馈。

关于

idc-index 是一个 Python 包,它使您能够进行基本操作,用于处理 NCI 图像数据共享 (IDC)

  • 使用所选元数据属性对 IDC 数据进行子集化
  • 下载与选择对应的文件
  • 生成所选数据的查看器 URL

入门

安装最新版本的包。

$ pip install --upgrade idc-index

实例化 IDCClient,它提供了主要操作的接口。

from idc_index import IDCClient

client = IDCClient.client()

您可以使用 IDC 门户 浏览集合、病例、研究和系列,复制它们的标识符,并使用 idc-index 辅助函数下载相应的文件。

您可以尝试使用 rider_pilot 集合,该集合大小仅为 10.5 GB

client.download_from_selection(collection_id="rider_pilot", downloadDir=".")

... 或者针对图像数据共享的 "mini" 索引运行查询,并下载符合您选择标准的图像!以下将选择所有磁共振 (MR) 系列,并将下载前 10 个。

from idc_index import index

client = index.IDCClient()

query = """
SELECT
  SeriesInstanceUID
FROM
  index
WHERE
  Modality = 'MR'
"""

selection_df = client.sql_query(query)

client.download_from_selection(
    seriesInstanceUID=list(selection_df["SeriesInstanceUID"].values[:10]),
    downloadDir=".",
)

教程

请查看 此教程笔记本 了解如何使用 idc-index

资源

  • 图像数据共享门户 可以用于从网页浏览器中探索 IDC 的内容
  • s5cmd 是一个高效、开源、多平台的 S3 客户端,我们将其用于下载托管在公共 AWS 和 GCS 存储桶中的 IDC 数据。作为 s5cmd 在 PyPI 上分发。
  • SlicerIDCBrowser 是一个 3D Slicer 扩展,它依赖于 idc-index 进行 IDC 数据的搜索和下载

致谢

此软件由 IDC 团队维护,该团队部分或全部由 NCI、NIH 资助,任务订单号 HHSN26110071,合同号 HHSN261201500003l。

如果此包有助于您的研发,我们将感激您引用以下 IDC 论文。

Fedorov, A.,Longabaugh, W. J. R.,Pot, D.,Clunie, D. A.,Pieper, S. D.,Gibbs, D. L.,Bridge, C.,Herrmann, M. D.,Homeyer, A.,Lewis, R.,Aerts, H. J. W.,Krishnaswamy, D.,Thiriveedhi, V. K.,Ciausu, C.,Schacherer, D. P.,Bontempi, D.,Pihl, T.,Wagner, U.,Farahani, K.,Kim, E. & Kikinis, R. 《国家癌症研究所图像数据共享:迈向图像人工智能的透明度、可重复性和可扩展性》。RadioGraphics(2023)。https://doi.org/10.1148/rg.230180

项目详情


下载文件

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

源代码分布

idc_index-0.7.0.tar.gz (35.6 kB 查看哈希值)

上传于 源代码

构建分布

idc_index-0.7.0-py3-none-any.whl (23.4 kB 查看哈希值)

上传于 Python 3

由以下支持