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.
If you are using Linux, you can alternatively access NBIA Data Retriever's command-line interface, which does not require the desktop environment.
To run the NBIA Data Retriever on CentOS, run the following sample command.
/opt/NBIADataRetriever/NBIADataRetriever --cli <location>/<manifest file name>.tcia -d <parent location>/<download directory> -l <location>/<credential file> -v –f |
The -l <credential file> option is required when the manifest file contains series from restricted collections but unnecessary if the manifest file only contains public data. |
To run the NBIA Data Retriever on Ubuntu, run the following sample command.
/opt/nbia-data-retriever/nbia-data-retriever --cli <location>/<manifest file name>.tcia -d <parent location>/<download directory> -l <location>/<credential file> -v –f |
The -l <credential file> option is required when the manifest file contains series from restricted collections, and is unnecessary when the manifest file contains series from public collections only. |
A credential file is a text file that passes the user's credentials in the following format:
The parameters "userName" and "passWord" are case-sensitive. |
The options available for the command line interface are described in the following table.
If you use the Data Retriever CLI with option -v, -f, or -q, and want to access private collection(s), put these options after the user credential parameters. |
| Option | Description |
|---|---|
| -c, -C, --cli, --CLI | Indicates running as a CLI app |
| -d, -D < download directory> | Optional. Default is the current directory. |
| -f, -F | Skip 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, -Q | Quiet. Default is false |
| -u, -U <user name> | Optional |
| -v, -V | Verbose. Default is false. |