Modules:AtlasCreator

Return to Slicer 3.6 Documentation

AtlasCreator

Atlas Creator User Interface in simple mode

Example of generated Atlases

Comparison of the alignment of two cases before and after Atlas Creation

General Information

Module Type & Category

Type: Built-in Loadable Module

Category: Registration

Authors, Collaborators & Contact

• Daniel Haehn, University of Pennsylvania
• Kilian Pohl, University of Pennsylvania
• Contact: Daniel Haehn (haehn@bwh.harvard.edu)

Module Description

The Atlas Creator module aligns images paired with segmentations to generate statistical atlases for several segmented structures.

Features:

• Support for BRAINSFit/CMTK/Congeal toolkits for Registration and Resampling
• Fixed Registration against a template or Dynamic Registration against a mean image
• Normalization of output atlases to a given value
• auto-detection of Structures (labels)
• different Output Casts
• Principal Component Analysis
• Cluster Computation Mode
• using existing Transforms and skipping the Registration (f.e. to re-run a previous generation)

Usage

This module supports different usage types and interfaces:

1. Simple Atlas Creation
2. The extended graphical user interface
3. The command line interface
4. External invocation using the Atlas Creator MRML Node

Use Cases, Examples

Input Data Requirements

The Atlas Creator expects input data to be structured the following way:

• In general each original image is accompanied by a manual segmentation.
• The images and the segmentations have to be in two different folders but have matching filenames.
• All images and segmentations have to be in Slicer-readable format.
• For Example:
  • ./originals/case1.nrrd
  • ./originals/case2.nrrd
  • ./originals/case3.nrrd
  • ./segmentations/case1.nrrd
  • ./segmentations/case2.nrrd
  • ./segmentations/case3.nrrd

HowTo: Simple Atlas Creation

The following steps perform a Pair Fixed Registration against an automatic chosen template for automatically detected structures.

1. Select the directories containing the Original Images and the Segmentations in the Input/Output panel.

2. Select an Output Directory in the Input/Output panel. It makes sense to create a new directory to use for the Output.

3. Hit Start!

4. After some wait (minutes or hours!, depending on the number of input cases), the generated atlases and the used template will be loaded into 3D Slicer.

Quick Tour of Features and Use

The Extended Graphical User Interface

Atlas Creator User Interface in extended mode

The Atlas Creator module is organized in panels from which only the Input/Output panel is expanded by default. Additional features are provided through an extended interface. This extended interface is divided into the Parameters panel and the Advanced panels which are collapsed by default.

Input/Output Panel

• Original Images:
• Segmentations:
• Output directory:
• Registration Type:
  • Pair Fixed:
  • Pair Online:
  • Group Online:

Parameters Panel

• Original Images:
• Segmentations:
• Output directory:
• Registration Type:
  • Pair Fixed:
  • Pair Online:
  • Group Online:

Advanced Panels

Cluster Configuration Panel

• Original Images:
• Segmentations:
• Output directory:
• Registration Type:
  • Pair Fixed:
  • Pair Online:
  • Group Online:

Principal Component Analysis Panel

• • Original Images:
  • Segmentations:
  • Output directory:
  • Registration Type:
    • Pair Fixed:
    • Pair Online:
    • Group Online:

Use Existing Transforms Panel

• • Original Images:
  • Segmentations:
  • Output directory:
  • Registration Type:
    • Pair Fixed:
    • Pair Online:
    • Group Online:

Misc. Panel

• • Original Images:
  • Segmentations:
  • Output directory:
  • Registration Type:
    • Pair Fixed:
    • Pair Online:
    • Group Online:

The Command Line Interface

Beside using the graphical user interface in 3D Slicer, the Atlas Creator can be accessed using the commandline.

$ cd Slicer3-release/lib/Slicer3/Modules/AtlasCreator/atlascreator.py
$ python atlascreator.py --help
AtlasCreator for 3D Slicer
Version v0.4

Usage:

-h, --help
        Show this information.

-i, --images DIR
        Directory containing original images.

-s, --segmentations DIR
        Directory containing segmentations.

-o, --output DIR
        Output directory.

[....]

The full documentation of the commandline interface is available at this page.

Development

Notes from the Developer(s)

Separate notes on the development are available on a separate page.

Dependencies

At least BRAINSFit, CMTK or Congeal have to be installed. BRAINSFit is deployed via Slicer, VMTK and Congeal are available as Slicer extensions.

Tests

On the Dashboard, these tests verify that the module is working on various platforms:

• vtkMRMLAtlasCreatorNodeTest1 Modules/AtlasCreator/Cxx/Testing/vtkMRMLAtlasCreatorNodeTest1.cxx
• AtlasCreatorLaunchFixedTest Modules/AtlasCreator/Cxx/Testing/vtkMRMLAtlasCreatorNodeLaunchTest1.py
• AtlasCreatorLaunchFixedFailProofTest Modules/AtlasCreator/Cxx/Testing/vtkMRMLAtlasCreatorNodeLaunchTest2.py
• AtlasCreatorLaunchDynamicTest Modules/AtlasCreator/Cxx/Testing/vtkMRMLAtlasCreatorNodeLaunchTest3.py

Usability issues

• Congeal support is still Under Construction.

Source code & documentation

Source code:

• Available in the 3D Slicer Trunk: Modules/AtlasCreator

Doxygen documentation:

• AtlasCreatorGUI
• AtlasCreatorLogic
• AtlasCreatorHelper
• vtkMRMLAtlasCreatorNode

More Information

Acknowledgment

The research was funded by an ARRA supplement to NIH NCRR (P41 RR13218).

The Atlas Creator module benefits from several different Toolkits: Thank you to Hans Johnson et al. for BRAINSFit, Torsten Rolfing et al. for CMTK and Jeremy De Bonet et al. for Congeal.