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.

Files for tciaclient, version 0.0.3
Filename, size File type Python version Upload date Hashes
Filename, size tciaclient-0.0.3-py3-none-any.whl (8.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size tciaclient-0.0.3.tar.gz (9.9 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page