NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

Page info
title
title

Tip
titleYou can print and export wiki pages

Include Page
CommonProjects:Included Page To Print the Guide
CommonProjects:Included Page To Print the Guide

Panel
titleContents of this Page
Table of Contents
minLevel2

This guide explains how to use caBIG® Annotation and Image Markup (AIM) on the ClearCanvas Workstation 3. 0.3. The information presented explains key procedures for creating and working with AIM annotation objects. The intended audience for this guide is a biomedical researcher familiar with the AIM information model.

...

Panel

Topics in this guide include:

Table of Contents
minLevel2

...

titleTo Print the Guide

...

  • Multiexcerpt include
    nopaneltrue
    MultiExcerptNameExitDisclaimer
    PageWithExcerptwikicontent:Exit Disclaimer to Include

Setting AIM Data Service Options

The purpose of AIM on the ClearCanvas workstation is to connect to multiple AIM Data Services that can accommodate the AIM 3.0 information model. As a result, these data services are collectively known as the AIM 3.0 Data ServicesService.

While by default the workstation is not configured to connect to any AIM 3.0 Data Services, it can use the AIM 3.0 Data Service. An end user can enter any valid URL for the AIM Data Service and click the Save button to have that URL remain on the workstation for future sessions.

Click AIM Data Service buttonImage Modified to configure the AIM Data Service. You can access the data service configuration from the explorer toolbar, shown in Figure 1, or through an opened study's toolbar, shown in Figure 2.

Clicking the AIM Data Service button from the explorer toolbar opens the AIM Data Service Options dialog boxImage Modified
Figure 1. Access AIM Data Service Options from Explorer Toolbar

Clicking the AIM Data Service button from an opened study opens the AIM Data Service Options dialog boxImage Modified
Figure 2. Access AIM Data Service Options from an Opened Study

Setting AIM Options

To access the AIM settings, on the ClearCanvas menu, select Tools > Options > AIM. When finished, click Apply to commit the changes. This is demonstrated in Figure 3.

AIM Options dialog boxImage Modified
Figure 3. AIM Options

Info
titleNoteSending AIM XML documents to the AIM 3.0 Data Service

By default, the setting for sending AIM XML documents to the AIM 3.0 Data Service is disabled. You must enable this option in order to have new AIM XML documents sent to the AIM Data Service. If you have neither set the AIM Data Service destination nor enabled the Send New Annotations to caGrid option, your existing AIM XML documents will not be sent to the AIM 3.0 Data Service.

...

Option

Description

Send New Annotations to caGRID caGrid

If selected, the workstation will send new annotations to the assigned caGrid location. Also see #Setting Setting AIM Data Service Options.

Store New Annotations Locally

If selected, the workstation will store a copy of new annotations in the AIM XML format on the local computer. A user can assign where the AIM annotation documents can be stored on the local computer.

Required User Information

If selected, user credentials need to be entered before creating an AIM annotation document.

Require Graphic Markup in Annotation

If selected, a user must create at least one graphical drawing on an image before creating an AIM annotation document.

Templates Folder

If entered, the directory will be used to search for AIM template XML documents.

Table 1. AIM Options Setting

Setting Toolbar Options

The ClearCanvas workstation allows a user to change the size of icons and show all icons on one screen. To do so, select Tools > Options > Toolbar. The recommended icon size is medium and you should select the Wrap long toolbars option. See Figure 4.

Toolbar tab of the AIM Options dialog boxImage Modified
Figure 4. Setting Toolbar Option

Using AIM Tools

Table 2 describes four AIM tools that are available on the ClearCanvas workstation.

Tool

Description

AIM Template buttonImage Modified

AIM Template displays a template based form with a set of questions and choice(s) of answers for each question. A user is able to can import a new AIM template at to that location. New Create new annotation objects can be created by completely filling out this form and pressing clicking the "Create Annotation" button.

AIM Object Locator buttonImage Modified

AIM Object Locator depicts available AIM objects in the currently displayed study without searching through every image in the study or series.

AIM Details buttonImage Modified

AIM Details provides the ability to view specific areas of a selected graphic markup for an existing annotation.

Closed Polygon Markup buttonImage Modified

Closed Polygon Markup tool allows creation of a free hand graphical markup. This tool can be used in addition to existing ClearCanvas tools in creating graphical markup.

Table 2. Available AIM Tools

AIM Template

To activate the AIM template tool in Figure 5, click the AIM template tool button (#1). If you put the pin down (#2), you can detach the AIM Template tab by putting the mouse pointer at the header (#3) and dragging it out, as illustrated in Figure 5-16.

Explorer window and AIM Template tabImage Modified
Figure 5. Activate AIM Template

AIM Template tab detached from Explorer windowImage Modified
Figure 5-16. Detached AIM Template Tool

Info
titleImportant

When an AIM annotation is created, the following conditions are applied (based on AIM default settings described in #Setting Setting AIM Options;)

  1. A user must answer all questions presented in the AIM Annotation window.
  2. A graphical markup is required on an image if "Require Graphic Markup in Annotation" is selected before an AIM annotation can be saved to the AIM Data Service and/or stored locally.
  3. User information must be entered if "Require User Information" is selected.

Importing a New AIM Template

An Import an AIM template XML document can be imported by clicking the AIM Template button, as shown in Figure 67. Windows Explorer opens a predefined folder described in the Setting AIM Options section.

Composite image showing XML folders on a hard drive and AIM Annotation dialog boxImage Modified
Figure 67. Importing an AIM Template

User Information

Author information as depicted in (Figure 78) can be changed. To use this feature, click the User Info button to activate the AIM User Information form. Enter appropriate information and click Save.

Info
titleNoteUser information is saved

The user information will be saved on the workstation for future use. If you are sharing the workstation with another reader, you must change or at least verify that the information in the "User Info" section reflects your personal credentials.

The AIM Template Manager is a tool used to create an AIM template XML document.

AIM User Information dialog boxImage Modified
Figure 78. AIM User Information

Detailed Description of a Question

A detailed description of a question can be seen by placing the mouse pointer over the first three characters of each feature name, as shown in Figure 89.

AIM Annotation dialog box showing pop-up window definition of a questionImage Modified
Figure 89. Detail Description of a Question

AIM Locator

The AIM locator, depicted in (Fig 9Figure 10), allows users to see existing AIM instances available in a study. A list of available AIM instances is displayed below the Available AIM Annotations section, which is #2 in the following image. To access this feature and see an AIM annotation, click Show Study, which is #3 in the following image.

AIM Locator showing available AIM annotations and a Show Study linkImage Modified
Figure 910. AIM Locator

AIM Annotation Details

The AIM annotation details, as illustrated by Figure 1011, allow a user to examine detailed information captured in an AIM instance. To access this feature, you select an image containing an AIM instance and then click the AIM Details button, as shown in (#1). The AIM Annotation Details panel appears. This panel contains information tabs including Anatomic Entity, Imaging Observation, Calculations, and All Details. The All Details tab (shown in #3) allows a user to see information related to both Anatomic Entity and Imaging Observation and their characteristics.

AIM annotation details for a selected annotationImage Modified
Figure 1011. AIM Details

AIM Display Markups from

...

Different Users

For a given image in an imaging study that has more than one reader interpreting and creating AIM annotations, the workstation can display every annotation while allowing you to turn off markups from a selected group of readers. Figure 11 12 depicts an image with three markups from three readers. The markup from reader named qwe-3 was turned off.

A right-mouse click on the image activates a pop-up menu with a " Visible AIM Users " option to turn readers' markups on or off.

Visible AIM Users option is selected and three readers' names are listed next to itImage Modified
Figure 1112. AIM Markup Display

By default, the workstation also displays annotations created by different users in different colors. Selecting Tools > Options > AIM > Markup allows you to You can change which colors are used for which user's AIM annotations ( Figure 12). Selected by . To assign a color to a user, go to Tools > Options > AIM > Markup.

By default, the " Random " checkbox (#2) is selected, which assigns a random color to each user's markup drawings. By clearing the Random checkbox, a default color is used instead. Colors may be assigned to a single user's markup drawings by selecting the color next to the user's name in the list.
Click the Add Login button (#3) to add a new user to the list.

. If you do not select the option, you can override the random color with a different color. You can also override the color used to depict one or more user's AIM annotations. The default color may be changed by clicking the button to the left of the checkbox when the checkbox is deselected. A user's color may be changed by clicking the color next to their name and selecting a new color in the color picker dialog that appears. Users not yet loaded into the list may be added to the list by clicking the "Add Login" button (#3). Selected users may be removed from the list (resetting their colors to the default) by selecting the "by clicking the Remove Selected" button (#4). All . Users removed from the list will have their annotations reset to the default color.
Select all users in the list may be selected by clicking the "Select All" button (#5). Selected users may have their color reset to the default color, either random or predefined as determined by the Random checkbox (#2), by clicking Click the Reset To Default Color button (#6) to reset the color assigned to selected users to the default color.

AIM Markup display optionsImage Modified
Figure 1213. AIM Markup Display

Viewing AIM Data for Each Image Series

You can see AIM annotations for an imaging study grouped by image series in the Available AIM Annotations section. Figure 14 shows two different image series. The first, Axial FSE, includes one AIM instance. The second, Axial T1, includes three AIM instances.

Image Added
Figure 14. AIM Data in Each Image Series

Using Data Services

National Biomedical Imaging Archive (NBIA) Data Service

The NBIA Data Service (Figure 1315) tab provides the ability to connect and retrieve studies from NBIA directly within the workstation. Holding the "Ctrl" key allows you to click on and select multiple studies. Right-clicking activates a feature that allows you to retrieve selected studies.

Explorer window showing NBIA studiesImage Modified
Figure 1315. NBIA Data Service

Users can enter search parameters (Figure 1416) based on a single value or multiple values of Patient ID, Patient's Name, Sex, Birth Date, Project name at NCI, Slice Thickness, Study Instance UID, and Modality.

Search NBIA dialog boxImage Modified
Figure 1416. Search NBIA Data Service

Columns in the NBIA Data Service page can be selected or deselected to display or hide an available result. Fig Figure 15 depicts that all available columns for the service have been selected.

Image Modified
Figure 1517. Select NBIA Data Service Display Columns

AIM Data Service

The AIM Data Service tab (Figure 1618) provides the ability to connect and retrieve AIM XML documents from an AIM 3.0 Data Service (see #Setting Setting AIM Data Service Options). It also allows a user to retrieve both AIM documents and studies from NCI's NBIA. Right-clicking activates a feature that allows you to retrieve studies.

Right-click menu offering Retrieve Selected Annotation option and Retrieve Selected Annotation and Study optionImage Modified
Figure 1618. AIM Data Service

You can enter search parameters (Fig 17Figure 19) based on a single value or multiple values of Anatomic Entities, Anatomic Entity Characteristics, the User user who created the AIM XML documents, Imaging Observation, Imaging Observation Characteristics, and Study Instance UID.

Info
titleNoteThe AIM Data Service search is case-sensitive.
 

A type of AIM XML document, Imaging Annotation, or Annotation Of Annotation, must be selected. The default value is Imaging Annotation.

Search AIM Data Service dialog boxImage Modified
Figure 1719. Search AIM Data Service

Columns in the AIM Data Service page can be selected or deselected to display or hide an available result. Figure 18 20 depicts that all available columns for the service have been selected.

List allowing you to select columns to displayImage Modified
Figure 1820. Select AIM Data Service Display Columns

...

Additional Information

Follow the links below for more information on how to set up AIM, information on the AIM Template Manager, and AIM Template Manager software.