NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

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

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.

...

5, 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.

...

If the new topic should be mapped to a Help link in the application, assign a new anchor to the new topic and provide it to the NBIA development team.

Note

This page contains the online help topics for the NBIA Classic interface, which is not the current release of NBIA. The user's guide for the new NBIA Data Portal interface is also available.

Panel

Table of Contents

Registering a New User

Include Page
Registering a New User 6.45
Registering a New User 6.45

Return to top of page

Logging into NBIA

Include Page
Logging into NBIA 6.45
Logging into NBIA 6.45

Return to top of page

Using the NBIA Home Page

Include Page
Using the NBIA Home Page 6.45
Using the NBIA Home Page 6.45

Return to top of page

Using NBIA Online Help

Include Page
Using NBIA Online Help 6.15
Using NBIA Online Help 6.15

Return to top of page

Performing a Simple Search

Include Page
Performing a Simple Search 6.45
Performing a Simple Search 6.45

Return to top of page

Performing a Text Search

Include Page
Performing a Text Search 67.20
Performing a Text Search 6.27.0

Return to top of page

Performing an Advanced Search

Include Page
Performing an Advanced Search 6.25
Performing an Advanced Search 6.25

Return to top of page

Creating Saved Queries

Include Page
Saving a Search Query 6.15
Saving a Search Query 6.15

Return to top of page

Working with Saved Queries

Include Page
Working with Saved Search Queries 6.25
Working with Saved Search Queries 6.25

Return to top of page

Editing Saved Queries

Include Page
Viewing and Editing Queries 6.25
Viewing and Editing Queries 6.25

Viewing Query History

Include Page
Viewing Query History 6.25
Viewing Query History 6.25

Return to top of page

Search Results Studies for Subject

Include Page
Search Results Studies for Subject 6.45
Search Results Studies for Subject 6.45

Return to top of page

Creating a Shared List

Include Page
Creating a Shared List 6.15
Creating a Shared List 6.15

Return to top of page

Searching a Shared List

Include Page
Searching a Shared List 6.15
Searching a Shared List 6.15

Return to top of page

Editing a Shared List

Include Page
Editing a Shared List 6.25
Editing a Shared List 6.25

Return to top of page

Managing a Shared List

Include Page
Managing a Shared List 6.25
Managing a Shared List 6.25

Return to top of page

Managing the Data Basket

Include Page
Managing the Data Basket 67.20
Managing the Data Basket 6.2

Download Manager

...

Downloading TCIA Images

Panel
borderColorred
borderStylesolid
titleGet the TCIA Downloader app

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.

Info

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.
    • For a centOS system, enter the following at the command prompt:
      sudo yum -v -y remove TCIADownloader.x86_64;sudo yum -y install TCIADownloader-2.0-1.x86_64.rpm
    • For a Ubuntu system, enter the following at the command prompt:
      sudo -S dpkg -r TCIADownloader.x86_64;sudo -S dpkg -i TCIADownloader-2.0-2.x86_64.deb
      Enter the sudo password when prompted.

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.

Info

...

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

Info

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.

...

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

...

   

Info
titleNetwork Error?

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

7.0

Return to top of page

Adding Items to Your Basket

Include Page
Adding Items to Your Basket 7.0
Adding Items to Your Basket 7.0

Return to top of page

Downloading the Data Basket

Include Page
Downloading the Data Basket 7.0
Downloading the Data Basket 7.0

Return to top of page

Download Manager

Include Page
Download Manager 7.0
Download Manager 7.0

Return to top of page

Downloading NBIA Images

Include Page
Downloading NBIA Images 7.0
Downloading NBIA Images 7.0

Return to top of page

Creating Manifest Files

Include Page
Creating Manifest File 7.0
Creating Manifest File 7.0

Return to top of page

Viewing Submission Reports

Include Page
Viewing Submission Reports 6.25
Viewing Submission Reports 6.25

Return to top of page

Accrual Report

Include Page
Accrual Report 6.15
Accrual Report 6.15

Return to top of page

Image Submission Report

Include Page
Image Submission Report 6.15
Image Submission Report 6.15

Return to top of page

Annotation Submission Report

Include Page
Annotation Submission Report 6.15
Annotation Submission Report 6.15

Return to top of page

Using the Quality Control Tool

Include Page
Using the Quality Control Tool 6.45
Using the Quality Control Tool 6.45

Return to top of page

Generating a QC Status Report

Include Page
Generating a QC Status History Report 6.45
Generating a QC Status History Report 6.45

Return to top of page

Approving Image Deletions

Include Page
Approving Image Deletions 6.25
Approving Image Deletions 6.25

Return to top of page

Manually Deleting Image Series

Include Page
Manually Deleting Image Series 6.15
Manually Deleting Image Series 6.15

Return to top of page

Editing a Collection Description

Include Page
Editing a Collection Description 6.15
Editing a Collection Description 6.15

Return to top of page

Managing Workflow Items Items 

Include Page
Managing Workflow Items 6.25
Managing Workflow Items 6.25

Return to top of page

Creating Workflow items

Include Page
Creating Workflow Items 6.15
Creating Workflow Items 6.15

Return to top of page

Managing Saved Queries

Include Page
Managing Saved Queries 6.35
Managing Saved Queries 6.35

Return to top of page

Managing

...

Protection Groups

Include Page
Managing Users Protection Groups 6.45
Managing Users 6.4

...

Protection Groups 6.5

Return to top of page

Managing Protection Elements

Include Page
Managing Protection Elements 7.5
Managing Protection Elements 7.5

Return to top of page

Managing User Groups

Include Page
Managing Protection User Groups 6.45
Managing Protection User Groups 6.45

Return to top of page

Managing Users

Include Page
Managing Users 6.5
Managing Users 6.5

Return to top of page

Adding Protection Groups and Assigning Roles

Include Page
Adding Protection Groups and Assigning Roles 6.45
Adding Protection Groups and Assigning Roles 6.45

Return to top of page

Authorizing Protection Groups

Hidden Data

This topic belongs to the TCIA-branded version of the User Authentication Tool, accessed by logging into https://nbia.cancerimagingarchive.net/nbia-search/.

Include Page
Authorizing Protection Groups
Authorizing Protection Groups

Return to top of page

Authorizing User Groups

Hidden Data

This topic belongs to the TCIA-branded version of the User Authentication Tool, accessed by logging into https://nbia.cancerimagingarchive.net/nbia-search/.

Include Page
Authorizing User Groups
Authorizing User Groups

Return to top of page