When preparing documentation for a new release, keep in mind that this page contains the production version of the online help. Each release should also have a folder named after the release, for example, NBIA 6.4, that contains the individual includes. The NBIA application links to those includes by anchor, for example, #NBIAHelpTopics-RegisteringaNewUser. Do not change those anchors. The topic names below can change and you can also add new topics. Assign a new anchor to the new topic and provide it to the NBIA development team.

Registering a New User

Logging into NBIA

Using the NBIA Home Page

Using NBIA Online Help

Performing a Simple Search

Performing a Text Search

Performing an Advanced Search

Creating Saved Queries

Working with Saved Queries

Editing Saved Queries

Viewing Query History

Search Results Studies for Subject

Creating a Shared List

Searching a Shared List

Editing a Shared List

Managing a Shared List

Managing the Data Basket

Download Manager

Downloading TCIA Images

Click one of the following links to download the TCIA Downloader for that operating system.

  • Windows
  • Mac
  • RPM (tested on CentOS)
    To run this file, type the following at the command prompt:
    sudo yum install TCIADownloader-2.0-1.x86_64.rpm
  • DEB (tested on Ubuntu)
    To run this file, type the following at the command prompt:
    sudo dpkg -i tciadownloader_2.0-2_amd64.deb

After you search for images of interest and add them to your data basket, you can download them.

The most convenient method of downloading is by using the TCIA Downloader. You must install the TCIA Downloader before you begin downloading. You only have to install it once to use it in future downloading sessions.

If you cannot install the TCIA Downloader for any reason, you can run the Temporary TCIA Downloader (JNLP) instead.

Installing the TCIA Downloader App

To install the TCIA Downloader app on Windows or Mac

  1. Download the installer package for Windows or Mac using the links above.
  2. Save the installer package file to your computer.
  3. Install the app by double-clicking the installer package file.
  4. Agree to the terms in the License Agreement and click Install.
  5. When the Setup Wizard ends, click Finish.

To install the TCIA Downloader app on Linux (centOS or Ubuntu)

You must have the sudu privilege on your computer and a sudu password to install the TCIA Downloader app on CentOS and Ubuntu.

  1. Download the installer package for centOS or Ubuntu using the links above.
  2. Save the installer package file to your computer.
  3. Open a command window and go to the location where you saved the installer.

Downloading Images Using the TCIA Downloader App

When you download images you have added to your data basket, TCIA provides a list of these images in a manifest file (manifest-xxx.tcia). You must have already installed the TCIA Downloader app to open this manifest file and download the images.

You can share the manifest file with collaborators, so that they can download the same images that you have added to your data basket. Collaborators must also install the TCIA Downloader app to open the manifest file.

If you want to share a manifest file that includes links to private image collections, you must first manually install the latest TCIA Downloader app. The latest version of the TCIA Downloader app controls access to private collections. In addition, your collaborators must have the same access to those private collections as you do. Otherwise, your collaborators will not be able to download images from those collections.

  1. Search for images of interest.
  2. Add those images to your data basket.
  3. Open the My Data Basket page and click Start Download.

  4. Open the manifest-xxx.tcia file.
    The TCIA Downloader appears, with the items you added to your data basket in the Downloads table.
    TCIA Downloader

    The TCIA Downloader app lists all items you selected in the data basket. You can hover your mouse over the Patient ID, Study Instance, and Series Instance columns to reveal the complete corresponding IDs. You can also resize a column by selecting and dragging the column border.

    If you do not want to download any of those items, select them in the Downloads table and then click Delete. When you remove an item from the Downloads table, it stays in your data basket.

  5. Click Browse to navigate to the destination where you want the images/annotations to be downloaded.
  6. Click Start to begin the download. You can monitor the download in the Progress column. The Status column indicates when the download for each item is complete.

    At any point in the process, you can click the Pause and Resume buttons to temporarily stop and restart the process.

    Note that files downloaded this way are not compressed. The downloaded files are stored in a child folder under the destination folder such as Collection name/patient id/study instance UID/series instance UID/image SOP instance UID.

    If you are not authorized to download a collection, the status of that item in the Downloads table is "Not Authorized."
    TCIA Downloader App, selected collections not authorized

       

    If network errors occur during large downloads, Download Manager retries the files the number of times that your administrator has configured.

Viewing Submission Reports

Accrual Report

Image Submission Report

Annotation Submission Report

Using the Quality Control Tool

Generating a QC Status Report

Approving Image Deletions

Manually Deleting Image Series

Editing a Collection Description

Managing Workflow Items 

Creating Workflow items

Managing Saved Queries

Managing Users

Managing Protection Groups

Adding Protection Groups and Assigning Roles