Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel

Table of Contents

The NBIA Data Retriever is a software product you can download and install so that you can download radiology images from from the TCIA Radiology Portal. This guide documents the command-line interface (CLI) of the NBIA Data Retriever. See the Cancer Imaging Archive User's Guide to learn how to use the Graphical User Interface (GUI) of the TCIA Radiology Portal.

Installing the NBIA Data Retriever on Linux

...

If you use the NBIA Data Retriever CLI with the -v, -f, or -q options, and want to access restricted collection(s), put these options after the user credential parameters.

OptionDescription
-c, -C, --cli, --CLIIndicates running as a CLI app
-d, -D <download directory>Required. The user must have write permission for the directory specified with this option.
-f, -FSkip the series the user does not have access to. Force the user to download the series if the user has access. Default is false.
-l <credential file>

Required when the manifest file has series from restricted collections.

Optional when the manifest file has series from public collections only.

-m, -M, --md5, –MD5 Enable validation of the checksums of the downloaded files. Default is that checksums will not be validated.
-p, -P <password>Optional
-q, -QQuiet. Default is false.
-u, -U <user name>Optional
-v, -VVerbose. Default is false.

Resuming an Interrupted Download Using the CLI

...