NIH | National Cancer Institute | NCI Wiki  

Introduction to the NBIA Data Retriever

NBIA Data Retriever is a client app that facilitates downloading images from the National Biomedical Imaging Archive (NBIA) and The Cancer Imaging Archive (TCIA) using a manifest file. You must install the NBIA Data Retriever before you begin downloading images. You only have to install it once to use it in future downloading sessions.

NBIA Data Retriever Release History

Version

App Name

OS

Release Date

Note

1.0

TCIA Downloader

Windows 7, 10, Mac, CentOS, Ubuntu

September 2017


2.0

TCIA Downloader

Windows 7, 10, Mac, CentOS, Ubuntu

January 2018


3.0

TCIA Downloader

Windows 7, 10, Mac, CentOS, Ubuntu

March 2018


3.0

TCIA Downloader

Windows 7, 10

July 2018

Signed with code signing certificate

3.0

TCIA Downloader

CentOS, RedHat and Linux variations of CentOS or Ubuntu

July 2018

Should increase the version number to version 3.1. Since we did not want to modify the web page and wiki, it renamed to 3.0

3.2

NBIA Data Retriever

Windows 7, 10, CentOS/RedHat, Ubuntu

November 2018


3.3

NBIA Data Retriever

Windows 7, 10, CentOS/RedHat, Ubuntu

February 2019


3.4

NBIA Data Retriever

Windows 7, 10, CentOS/RedHat, Ubuntu

June 2019


3.0

Downloader App

Mac App Store

August 2019


3.2

NBIA Data Retriever

Mac App Store

November 2018


3.3

NBIA Data Retriever

Mac App Store

February 2019


3.4

NBIA Data Retriever

Mac App Store

June 2019


3.5NBIA Data RetrieverMac App StoreSeptember 2019

3.6

NBIA Data Retriever

Mac App Store

April 2020


4.0NBIA Data RetrieverMac App StoreFebruary 2021
4.1NBIA Data RetrieverMac App StoreJuly 2021
4.2NBIA Data RetrieverMac App StoreNovember 2021

NBIA Data Retriever 3.4 Release Notes

Product: NBIA Data Retriever
Server Version: NBIA 7.0 GA, NBIA 7.1 TCIA
NBIA Data Retriever Version: 3.4
Date: June 2019

Features Addressed in This Release

  • NBIA-1237 Increase Size of Series to Long in Data Retriever
  • NBIA-1241 Embed a Tutorial Video on Data Retriever's Error Dialog.

Known Issues/Defects

None

NBIA Data Retriever 3.5 Release Notes

Product: NBIA Data Retriever
Server Version: NBIA 7.0 GA, NBIA 7.2 TCIA, NBIA 7.3 TCIA
NBIA Data Retriever Version: 3.5
Date: September 2019

Introduction to NBIA Data Retriever 3.5

This release embeds a video tutorial to the dialog to guide the user to create a manifest file and use it to download the image. This release also fixes the issue of the huge file size causing integer overflow.

Features Addressed in This Release

  • NBIA-1258 If the user selects manual upgrade, the app will not continue to show download manager window.
  • NBIA-1255 Investigate and implement 10,000 Series Limit from Data Retriever.

Known Issues/Defects

None

NBIA Data Retriever 3.6 Release Notes

Product: NBIA Data Retriever
Server Version: NBIA 7.1 GA, NBIA 7.4 TCIA, NBIA 7.5 TCIA
NBIA Data Retriever Version: 3.6
Date: April 2020

Introduction to NBIA Data Retriever 3.6

In this release, the file naming system used by the NBIA Data Retriever has been revised to provide a more natural ordering of the files within each series. This has been accomplished by first ordering the DICOM files by ordinal position of acquisition number and then by ordinal position of instance number. The files are then assigned numbers with the lowest acquisition being 1 and the lowest instance number within that acquisition being 1, separated by a dash. The numbers are incremented by 1 as the next values are encountered. All values are left-padded with zeros to provide for the ordering within the file system.  As an example, a series with 2 acquisition numbers with each acquisition having 42 instance numbers would start with 1-01.dcm for the lowest acquisition number and the lowest instance number in that acquisition. The last file in that acquisition would be 1-42.dcm. Then the second acquisition would start with 2-01.dcm, ending with 2-42.dcm, in that acquisition. For the purposes of ordering, an empty value in either acquisition number or instance number is lower than a file having a value for those numbers.

Features Addressed in This Release

  • NBIA-1338 Instance numbers in downloader ordering
  • NBIA-1392 NBIA Data Retriever 3.6
  • NBIA-1419 .dcm missing from files downloaded from old version of server

Known Issues/Defects

None

NBIA Data Retriever 4.0 Release Notes

Product: NBIA Data Retriever
Server Version: NBIA 7.0 GA, NBIA 7.2 TCIA, NBIA 7.3 TCIA
Retriever Version: 4.0
Date: February 2021

Introduction to NBIA Data Retriever 4.0

In this release, Download Manager window adds an "overall progress" bar at the top (above the Series UID list) that calculates how much further the download has to go in total. A metadata file is created for each download and a license file is generated in the directory for a collection. This release also includes several bug fixes. See the list below and What's New in NBIA Data Retriever 4.0.

Features Addressed in This Release

  • NBIA-1600 Number of Series Limitation for Private collection
  • NBIA-1594 ACRIN-Contralateral-Breast-MR download issues
  • NBIA-1562 Remove file size checking feature in the NBIA Data Retriever 4.0
  • NBIA-1552 Spreadsheets for downloader and cart should include the DOI
  • NBIA-1483 Data retriever - Error handling for missing files
  • NBIA-1431 Data Licensing : Data Retriever Update
  • NBIA-1411 Single slash in series description breaks retriever
  • NBIA-1410 Create overall progress bar for the retriever
  • NBIA-1375 Modify NBIA data retriever to include table with metadata

Known Issues/Defects

None

NBIA Data Retriever 4.1 Release Notes

Product: NBIA Data Retriever
Server Version: NBIA 7.8 TCIA
Retriever Version: 4.1
Date: July 2021

Introduction to NBIA Data Retriever 4.1

In this release, a resume downloading feature is added for the situation that the app must be closed and restarted. A command-line interface was added to the app for Linux systems. Amazon-Corretto 8 now replaces Oracle Java 8 as the embedded Java runtime environment. The app now warns if commercial restrictions apply on data to be downloaded. It also shows the data usage agreement and retrieves the user’s consensus before letting the user proceed to download. This release also includes several bug fixes. See the list below and What's New in NBIA Data Retriever 4.1.

Features Addressed in This Release

NBIA-1707

Metadata for 4D-Lung is not generated by Downloading with Data Retriever CLI

NBIA-1705

Java Runtime Environment in NBIA Data Retriever

NBIA-1656

NBIA Data Retriever Needs to Ignore Invisible Characters at the end of Manifest File

NBIA-1654

Double header in metadata file

NBIA-1651

Series description consisting of a single slash / causes exception

NBIA-1629

Data Usage Notification in NBIA Data Retriever

NBIA-1597

On Rare Occasion, Data Retriever Create Two Headers in Metadata File

NBIA-1516

Adding a phrase to the data retriever to warn if commercial restrictions apply

NBIA-1513

Restart / Resume Data Retriever

NBIA-1460

REST API Facade for Download Servlet

Known Issues/Defects

None

NBIA Data Retriever 4.2 Release Notes

Product: NBIA Data Retriever
Server Version: NBIA 7.9 TCIA
Retriever Version: 4.2
Date: November 2021

Introduction to NBIA Data Retriever 4.2

In this release, an option was added to the File menu, Checksum Verification, to verify the integrity of the downloaded files using MD5 checksum. The build and embedded Java runtime environments were switched to Amazon Corretto 8. This release also includes several bug fixes. See the list below and What's New in NBIA Data Retriever 4.2.

Features Addressed in This Release

NBIA-1737

Data Retriever: Metadata.csv: All special characters except for period are stripped from data listed under the Data Description URI Column

NBIA-1708

Upgrade to using Amazon JDK for build

NBIA-1707

Metadata for 4D-Lung is not generated by Downloading with Data Retriever CLI

NBIA-1705

Java Runtime Environment in NBIA Data Retriever

NBIA-1690

Data Retriever: LICENSE file has Data Usage Policy repeated twice

NBIA-1458

MD5 Digest for Verifying Downloads

Known Issues/Defects

None

Bug Reports, Feature Requests, and Support

Send an email to NCIAppSupport@mail.nih.gov to request technical support or report a bug or request a new feature.

Existing requests and resolution may also be viewed at the NBIA JIRA site.

Documentation and Files

CBIIT Web Pages

  • No labels