| Panel | |
|---|---|
|
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
...
| Code Block | ||
|---|---|---|
| ||
mkdir /usr/share/desktop-directories/ wget -P ~/NBIA-Data-Retriever https://cbiit-download.nci.nih.gov/nbia/releases/ForTCIA/NBIADataRetriever_4.24/nbia-data-retriever-4.4.2.deb dpkg -i ~/NBIA-Data-Retriever/nbia-data-retriever-4.4.2.deb |
Note that an RPM package is also available for operating systems that don't support *.deb packages.
...
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.
| Option | Description |
|---|---|
| -c, -C, --cli, --CLI | Indicates running as a CLI app |
| -cd, -CD, --CD or –cd | Run with classic directory naming, which organizes files in a child folder under the destination folder as follows: Collection Name > Patient ID > Study Instance UID > Series Instance UID |
| -d, -D <download directory> | Required. The user must have write permission for the directory specified with this option. |
| -dd, -DD, --DD or –dd | Run with descriptive directory naming, which is the default. A descriptive directory name organizes the files in a child folder under the destination folder as follows: Collection Name > Patient ID > Study Date + Study ID + Study Description (54 char max) + last 5 digits of Study Instance UID > Series Number + Series Description (54 char max) + last 5 digits of Series Instance UID |
| -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. |
Resuming an Interrupted Download Using the CLI
...