You can print and export wiki pages.
Topics in this chapter include:
What's New in the TCIA Data Portal
- You can filter search results based on the number of days from clinical time point event. Example: Show all studies that occurred within X days of Diagnosis. See Clinical Time Points filter.
- You can filter search results to exclude collections that have commercial use restrictions. See Exclude Collections with Commercial Use Restrictions filter.
- You can sort the Collections and Anatomical Site filters alphabetically or numerically. See Collections filter and Anatomical Site filter.
- The Export Metadata button on the Cart screen now includes four new columns in the output: 3rd Party Analysis status, Data Description URI, SOP Class Name, and SOP Class UID. See Exporting the Cart to a Spreadsheet.
- NBIA Data Retriever 4.0 introduces the following changes.
- A status bar has been added at the top of the Downloads table to indicate Overall Progress.
NBIA Data Retriever showing download in progress - Downloads now include a metadata file in CSV format, which provides an overview of the downloaded files. This file includes the following columns: Series Instance UID, Collection, 3rd Party Analysis, Data Description URI, Subject ID, Study UID, Study Description, Study Date, Series Description, Modality, Manufacturer, SOP Class Name, SOP Class UID, Number of Images, File size, File Location, and Download Time Stamp.
Metadata file in the manifest folder
Metadata file opened in Microsoft Excel - A license file has been added to the collection level of the directory to inform you of the usage policy & restrictions for each collection downloaded.
License file downloaded with collection - Under the folder the user selects for downloaded files, a new top-level folder has been added that has the same name as the manifest file.
Manifest folder - A more descriptive error message now appears when files are missing files from the file server, with options to retry the failed series, save the error report, and exit.
- Fixed a bug preventing downloads of over 10,000 series for restricted-access datasets.
- A status bar has been added at the top of the Downloads table to indicate Overall Progress.
Introduction to the TCIA Data Portal
TCIA Data Portal enables you to search for images in the local TCIA in vivo image repository. If available, you can also search remote imaging archives.
TCIA submissions are organized in the following hierarchy, which is important to remember in creating your search query and reviewing search results:
Collection > Patient (Subject) > Study > Series > Images |
---|
In other words, a Collection is the largest organizing concept within TCIA and it includes data about Patients (also called Subjects). As you continue to drill down to more granular concepts, Patients contain Studies, Studies contain (Image) Series, and Series contain individual Images.
Browser Support
TCIA supports the latest versions of Google Chrome and Mozilla Firefox browsers.
Searching for Image Studies
TCIA provides two ways to search for image studies:
When you first open TCIA Data Portal, the Summary tab displays filters for a simple search and pie charts showing counts of collections, image modalities, and anatomical sites in the database. Each pie "slice" is a filter you can use to narrow the data in the portal. Hover over a pie chart slice to view the name of each filter. The size of each pie slice is relative to the size of that filter's representation in the database.
Click one or more boxes next to each search filter to select it. As you select search filters, they move to the top of the list. They also appear in Boolean query format above the pie charts. This query specifies the filters you have applied to your search. Click Clear if you want to remove all of your filters at once and start over. You can save your query as a URL for later use or to put in an email to a colleague. For more information about sharing, go to Sharing a Query.
You can narrow your search by the following filters:
- Collections
- Image Modality
- Anatomical Site
- Species
- Phantoms
- 3rd-Party Analysis Results
- Clinical Time Points
- Exclude collections with commercial use restrictions
- Date Released
- Subject IDs
You can also specify the minimum number of image studies you want to match each search filter. For Collections, if you know the name of the collection, click
to enter it instead of finding and clicking the collection's box.3rd-party analysis results are derived data (e.g. segmentations) that were contributed by researchers who were not part of the group that originally submitted a collection to TCIA.
The Simple Search page shows a summary of image studies that match your search criteria. Your selections appear in the following ways:
- Boxes you selected are checked.
- Pie charts update to show the exact search results.
- Breadcrumb-style labels at the top of the page show the applied search filters (not all may display due to space constraints).
- Count of search results appears.
The pie charts show the count of image studies in your search results by Collection, Image Modality, and Anatomical Site. Click a pie slice or hover over it to see the name of the Collection, Image Modality, or Anatomical Site, and number of each, in your search results.
The Search Results tab shows the same results as the pie charts but in tabular form.
Text searches involve entering any text that might appear in any search filter.
Results are displayed in pie charts and a table, just as with the simple search.
Accessing Limited-Access Collections
You can search and download public data without logging in to the TCIA Data Portal. To access restricted data, however, you must log in first to see that data in your search results. Consult the TCIA Collections page to learn which collections have limited access.
- In the top menu bar, click
The Login window appears. . - Enter your user name and password, then click Log In.
Performing a Simple Search
To perform a simple search
- On the TCIA home page, click the Simple Search tab.
The Simple Search page appears. Select filters to narrow down the available image series.
To Select Do This Collections
Option 1: Click the box next to each collection name you want to select.
Hovering over a collection name opens a window with information about the collection in it. Quickly move your mouse to this window, were you can select text and click links. The window stays open until you move your mouse away from it.
Option 2: Click the magnifying glass to enter a name.
Image Modality
Click the box next to one or more image modalities.
If you select more than one image modality, clicking ANY returns any study that is associated with any of the modalities you selected. Clicking ALL returns all studies that are associated with all of the modalities you selected.
When you select the ANY search modifier here, only the studies that match your search criteria are returned. Be aware that these may be only be a subset of the studies belonging to a single subject (patient). The potential difference between total studies available and the number of studies returned by your search becomes clearer when you select the Total Studies and Total Series columns to appear in your search results. To do so, click at the top of the Search Results tab. Select Total Studies and Total Series in the Pick Columns list.
Anatomical Site
Click the box next to each anatomical site you want to select. Click alpha or num to sort the list alphabetically or numerically
<Replace screenshot and document new sorting feature>
Species
Click the box next to the species you want your search results to represent, either human or Mus musculus (mouse).
Phantoms
Click the box next to the phantom option you want to select.
3rd-Party Analysis Results
3rd-party analysis results are derived data (e.g. segmentations) that were contributed by researchers who were not part of the group that originally submitted a collection to TCIA.
Click the box next to each third-party analysis results option you want to select. Only DICOM data from third-party analysis results appear when using this search filter. A full listing of all third-party analysis data inclusive of non-DICOM formats can be found in the Analysis Results Directory.
Clinical Time Points
Clinical time points can take various types. Click "select" to view the types that are available in the database, plus their available date range. In the from and to boxes, enter numbers that correspond to the range of days from and to that time point.
Exclude collections with commercial use restrictions
TCIA supports collections with different types of licenses. Some licenses prohibit the commercial use of the collection. You can filter your search results to exclude those collections that have commercial use restrictions.
At least X time point (DICOM studies) Enter the minimum number of time points that match the criteria of your search. This filter allows you to see subjects that have more than one DICOM study (that is, the patient was seen at multiple time points).
Date Released
Enter a From and To date to narrow your search results to studies that TCIA first made available during that date range.
Alternately, select the Apply "Available" date range box to exclude studies that were unavailable to TCIA during the selected date range. Click the
button to return the dates to the default date range.Subject IDs Enter Subject IDs associated with the image series you want to receive in your search results. Separate each Subject ID with a comma and then click Apply Subject IDs.
Select which columns you want to have appear in the detailed search results on the Search Results tab by clicking
at the top of the Search Results tab. The Pick Columns panel appears.
Search results are shown in two different ways, as a summary and as detailed search results, and which one appears first matches your last choice. The Summary tab shows updated pie charts and the number of image series in the search results.
Click the Search Results tab for more detailed results.
Performing a Text Search
DICOM Examples
- Enter pancreas in the Text Search box and find all subjects associated with the value pancreas.
- Query using the attribute:searchTerm technique: for example, Body Part Examined:pancreas. In this example, the colon interprets the DICOM field from the value.
- Query by DICOM codes, such as 0018,0015:pancreas. 0018,0015 is the DICOM code for Body Part Examined.
- Query by DICOM SR attributes, such as 0008,0104 for Code Meaning. Entering 0008,0104:tonsil, returns all subjects with a Code Meaning that includes the word "tonsil," and 0008,0104:tonsil adenoid returns all subjects with a Code Meaning that includes both "tonsil" and "adenoid."
- Use a wildcard search such as Body Part Examined:panc* to find all subjects associated with values beginning with panc, including pancreas, pancreatic duct, and pancreatic duct and bile duct systems.
Examples for Strains
- Query for the strain name or parts of the strain name or use a value name pair to construct the query. You can query by the Mouse Genome Informatics (MGI) number or query for MGI in the coding scheme designator field. Examples follow.
- Strain Description (0010,0212) = "NOD.Cg-Prkdc<scid> Il2rg<tm1Wjl>/SzJ"
- Strain Nomenclature (0010,0213) = "MGI_2013"
- Strain Code Sequence (0010,0219):
- Code Value (0008,0100) = "3577020"
- Coding Scheme Designator (0008,0102) = "MGI"
- Code Meaning I0008,0103) = "NOD.Cg-Prkdc<scid> Il2rg<tm1Wjl>/SzJ"
The text search does have some restrictions. These are:
- The text string you use must have more than one character. The search won't return any values if the text string has only one character.
- Do not use a forward slash (/) in your text string.
- Do not use complex searches with AND or OR statements (text search supports Lucene syntax but only a single field can be searched at a time).
To perform a text search
On the TCIA home page, click Text Search or Search Images > Text Search.
The Text Search page appears.- In the Text Search box, enter a text string of two characters or more.
Click
.
The search results appear.Navigation Tips
- Click the down arrow next to the Subject ID column header to sort the results alphabetically (A to Z or Z to A) by Subject ID.
- Click the arrows at the bottom of the table to display the first, previous, next, or last page of results.
- Click the page number links to move to a specific page of results.
- In the Show (10) entries box in the bottom left, edit the default 10 to the number of entries you want to see on a search results page.
The following table describes each item in the search results table.
Search Result Description Click the caret to view the subject details. Click the cart symbol to add image series to your cart. Collection ID Collection identifier Subject ID Click the Subject ID to view all study images for this subject in a DICOM web viewer, a single series' thumbnails, or the DICOM header for the first image in the series. See Search Results (Studies for Subject).
Hit The field in the study where the text string you entered as your search criteria appears.
Viewing Subject Details
From the Search Results tab, you can view subject details, view all image series associated with the subject, and add image series to your cart for download. You can also view the DICOM header for a selected image series. In the future, you will be able to view the image.
To view subject details
- Search for studies that match criteria that interest you.
The Summary tab refreshes to show your search results in pie chart form. Click the Search Results tab.
The search results that match your criteria appear sorted by Subject ID.You can add all studies associated with a subject to your cart at the same time or drill down to an individual study and add it to your cart instead.
Click a Subject ID link.
All studies associated with this subject appear. In this example, this subject is only associated with one study, and only one image series is associated with that study.The red asterisk indicates that the date, which is the date that this series was first available at TCIA, has been offset to protect private health information.
- Click the date or the arrow to the left of the study cart icon to view details about the selected study.
All of the image series associated with that study appear.
You can now
- Add an image series to your cart.
- View the series description, modality, manufacturer, number of images, and series ID.
- View thumbnails of the image series.
- View an animation of the image series.
- View DICOM data for this image series.
Viewing Thumbnails of the Image Series
To view thumbnails
- View the details for a subject.
- Select a study and view its details.
- In the row for an image series, click
Thumbnails of all of the images in the selected image series appear. . - Click any image to download it to your computer.
Follow your browser's instructions to open or save the file.
Viewing DICOM Data
Digital Imaging and Communications in Medicine (DICOM) is a standard for handling, storing, printing, and transmitting information in medical imaging.
You can view the DICOM tags that form the header of the selected image series.
To view DICOM data
- View the details for a subject.
- Select a study and view its details.
- In the row for an image series, click
The DICOM tags associated with the image series appear. .
Viewing TCIA Collections
To view a TCIA collection
- View the details for a subject.
- Click the study date link for the collection you want to view.
The image series associated with this study appear. - In the row for an image series, click
The images in the series open in the Open Health Imaging Foundation (OHIF) Viewer. . - Click to display the images in the series sequentially.
Downloading Study Data
You can download items you add during the current work session. Before you download items you must download and then install the NBIA Data Retriever.
You select items to download by first searching for them in TCIA and then adding them to your cart.
You can also export data in your cart to a spreadsheet.
Adding Data to the Cart
To add all subjects to the cart
- Search for the subject.
- Click the Search Results tab.
Click the subject cart icon in the row of one or more subjects. This selects all studies associated with each subject.
The cart icon turns green and the number of image series now in your cart appears next to the cart. The cart itself, in the upper-right of the window, shows how large the download will be.To remove all of the data associated with this subject from the cart, click the cart icon again.
To add selected studies to the cart
- Search for the subject.
- Click the Search Results tab.
- Click a Subject ID link or click the arrow to the left of the subject cart to open all series associated with that subject.
- Click the cart icon for one or more series.
- The study cart icons you select turn green.
- The subject cart icon for the subject turns yellow, indicating that you have not selected all available studies for this subject.
To add selected series to the cart
- Search for the subject.
- Click the Search Results tab.
- Click a Subject ID link or click the arrow to the left of the subject cart to open all series associated with that subject.
- Click a study date link or click the arrow to the left of the study cart to open all the series associated with that study.
- Click the cart icon for one or more series.
- The series cart icons you select turn green.
- The study cart icon for the subject turns yellow, indicating that you have not selected all available series for this study.
- The subject cart icon for the subject turns yellow, indicating that you have not selected all available studies and series for this subject.
Downloading the NBIA Data Retriever
The most convenient method of downloading is by using the NBIA Data Retriever. You must install the NBIA Data Retriever before you begin downloading. You only have to install it once to use it in future downloading sessions.
Click one of the following links to download the NBIA Data Retriever for that operating system.
- RPM (tested on centOS)
To run this file, type the following at the command prompt:sudo yum -v -y remove NBIADataRetriever-3.6-1.x86_64.rpm;sudo yum -y install NBIADataRetriever-4.0-1.x86_64.rpm
- DEB (tested on Ubuntu)
To run this file, type the following at the command prompt:sudo -S dpkg -r nbia-data-retriever-3.6.deb;sudo -S dpkg -i nbia-data-retriever-4.0.deb
- NBIA Data Retriever in the Mac App Store
- Windows
New features and one fixed issue are available in NBIA Data Retriever 4.0 (February 2021).
Consult the NBIA Data Retriever FAQ for more information about NBIA Data Retriever versions and usage.
Installing the NBIA Data Retriever
To install the NBIA Data Retriever on Windows
- Download the installer package for Windows using the Windows link above.
- Save the installer package file to your computer.
- Install the app by double-clicking the installer package file.
- Agree to the terms in the License Agreement and click Install.
- When the Setup Wizard ends, click Finish.
To install the NBIA Data Retriever on Mac
The Mac version of the NBIA Data Retriever is only available through the iOS App Store. It requires a manifest file to work. You can download the app first or create a manifest file first. If you download the app first, right-click the manifest file and select Open With Downloader App. If you create a manifest file first, right-click it and select Open With App Store. This installs the app and then opens the manifest file in the app.
On your Mac, find the NBIA Data Retriever on the Mac App Store.
The NBIA Data Retriever is free but still requires you to log in to download it. Consider changing your iOS Password Settings so that you can download free software without having to log in separately for it.
- Click Get, then click Install App. The NBIA Data Retriever is free.
The app starts downloading to your Mac. When the download is complete, you can open a manifest file with the NBIA Data Retriever.
To install the NBIA Data Retriever on Linux (centOS or Ubuntu)
You must have the sudo privilege on your computer and a sudo password to install the NBIA Data Retriever on CentOS and Ubuntu.
- Download the installer package for centOS or Ubuntu using the links above.
- Save the installer package file to your computer.
- Open a command window and go to the location where you saved the installer.
Downloading Images Using the NBIA Data Retriever
When you download images you have added to your cart, TCIA provides a list of these images in a manifest file (manifest-xxx.tcia
). You must have already installed the NBIA Data Retriever 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 cart. Collaborators must also install the NBIA Data Retriever 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 NBIA Data Retriever. The latest version of the NBIA Data Retriever 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.
To download images using the NBIA Data Retriever
- Search for images of interest.
- Add those images to your cart.
- Click the cart icon in the top-right of the page
The cart contents appear. . - Click
A message appears reminding you to download the NBIA Data Retriever. If you have already downloaded it, click Do not show this message again and click . Otherwise, click to go to a page with links for downloads for each operating system. . Open the
manifest-xxx.tcia
file.
The NBIA Data Retriever appears, with the items you added to your cart in the Downloads table. See the note about the file naming system that appears in the manifest file.
The NBIA Data Retriever lists all items you selected in the cart. 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 cart in the Radiology Portal.NBIA Data Retriever File Naming System
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 an file having a value for those number.
Click Browse to navigate to the destination where you want the images/annotations to be downloaded.
- Click Start to begin the download. You can monitor the status of the full download in the progress bar on top, and for each collection 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 > part of Study Date + part of Study ID + part of Study Description + last 5 digits of Study Instance UID > part of Series Number + part of Series Description + last 5 digits of Series Instance UID
.Network Error?
If network errors occur during large downloads, the NBIA Data Retriever retries downloading the series in the manifest file the number of times that your administrator has configured. The default is four times.
After the automatic retries, you have the option of retrying just the failed series, saving an error report, which you can share with the TCIA help desk, and exiting.
Exporting the Cart to a Spreadsheet
To export your cart
- Add data to your cart.
- Click
The cart appears. . - Click
A CSV file called "metadata" opens in your browser. This file provides an overview of the downloaded files. The spreadsheet includes the following columns:- Series Instance UID
- Collection
- 3rd Party Analysis
- Data Description URI
- Subject ID
- Study UID
- Study Description
- Study Date
- Series Description
- Modality
- Manufacturer
- SOP Class Name
- SOP Class UID
- Number of Images
- File size
- File Location
- Download Time Stamp
.
Sharing a Query
You can save your query for later use or share it with a colleague by email.
To share a query
- In the top menu bar, click
The Query URL box appears. and then select Share my query. - Click Copy URL.
The URL copies into your Clipboard. Paste the URL into an email or other document.
Shared queries honor data permissions that may exist. Each person that runs the shared query will only see search results that he or she is allowed to see.
Sharing Data in Your Cart
Once you have added data to your cart, you can share it as a URL to a static set of data. When you or a colleague opens the URL in a browser window, the new TCIA Graphical User Interface (GUI) opens to the cart page.
In the legacy TCIA data portal, this was called a shared list. This is a similar concept in the new TCIA GUI.
To share data in your cart
- Add data to your cart.
- In the top menu bar, click
The Retrieve Cart Data URL box appears. and then select Share My Cart. - Click Copy URL.
The URL copies into your Clipboard. - Paste the URL into an email or other document.
The shared cart honors data permissions that may exist. Each person that opens the shared cart will only see data that that person is allowed to see.