Skip to main content

TCIA (The Cancer Imaging Archive) Download Client for Python

Project description

TCIA (The Cancer Imaging Archive) Download Client for Python

This Python package uses the official TCIA REST API to enable downloads from www.cancerimagingarchive.net from within Python scripts and Jupyter Notebooks.

The documentation can be found at https://moritzschwyzer.github.io/tciaclient/. This PyPI/Conda package is based on source code of the TCIA-API-SDK https://github.com/TCIA-Community/TCIA-API-SDK.

Install

pip install tciaclient

How to use

Step 1: Import the TCIAClient from the tciaclient.core package.

from tciaclient.core import TCIAClient

Step 2: Create an instance of the TCIAClient.

tc = TCIAClient()

Step 3: Specify the collection you want to download (find the name on https://wiki.cancerimagingarchive.net/display/Public/Collections).

collection_name = "NSCLC-Radiomics"

Step 4: Get the series information of the chosen collection. In this example, we specify that we only want series that are CT scans.

series = tc.get_series(collection=collection_name, modality="CT")

Step 5: Download the dataset to the specified path.

download_path = "./tcia-downloads"
for i, s in enumerate(series):
    print(i)
    tc.get_image(seriesInstanceUid = s["SeriesInstanceUID"],
        downloadPath = download_path, zipFileName = str(i).zfill(3)+"-"+collection_name+".zip")

TCIA Data Usage Policies and Restrictions

Information regarding data usage policies and restrictions can be found on https://wiki.cancerimagingarchive.net/display/Public/Data+Usage+Policies+and+Restrictions

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

tciaclient-0.0.3.tar.gz (9.9 kB view details)

Uploaded Source

Built Distribution

tciaclient-0.0.3-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file tciaclient-0.0.3.tar.gz.

File metadata

  • Download URL: tciaclient-0.0.3.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.5.0.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for tciaclient-0.0.3.tar.gz
Algorithm Hash digest
SHA256 f3ae2c583f0f130fba1931f39eb0c59d6b822f46eda353185035563072c6f6a4
MD5 e08473da7a76dbd20d2b22b09e2474a4
BLAKE2b-256 28b91096b790bfaa0cb2511601f19d8bce7529ea61f92151fc2d2739035786da

See more details on using hashes here.

File details

Details for the file tciaclient-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: tciaclient-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 8.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.5.0.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for tciaclient-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 99a275ec596eeea38b0e9bd7fa18988a27b0eaf861eacbe425747584766f7cb6
MD5 f41b1885f38a73a997ff3091b6981d83
BLAKE2b-256 606a714a60d25ad848535e9829d99bc9f0f14ebe4f5bf32e51fe2c33aec412dc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page