Documentation/Nightly/Modules/SubjectHierarchy

For the latest Slicer documentation, visit the read-the-docs.

Introduction and Acknowledgements

Title: Subject Hierarchy Author: Csaba Pinter (PerkLab, Queen's University) Acknowledgements: This work is part of the SparKit project, funded by An Applied Cancer Research Unit of Cancer Care Ontario with funds provided by the Ministry of Health and Long-Term Care and the Ontario Consortium for Adaptive Interventions in Radiation Oncology (OCAIRO) to provide free, open-source toolset for radiotherapy and related image-guided interventions. Contact: Csaba Pinter, <email>csaba.pinter@queensu.ca</email>

Cancer Care Ontario   Software Platform and Adaptive Radiotherapy Kit   Ontario Consortium for Adaptive Interventions in Radiation Oncology

Module Description

The Subject hierarchy module acts as a central data-organizing point in Slicer.

It is deactivated by default, so when the user enters it the first time, it asks whether subject hierarchy should be created for the data loaded in Slicer. Clicking No leaves subject hierarchy unused, clicking Yes adds the nodes only once to subject hierarchy, and clicking Yes to All enables automtic creation of subject hierarchy nodes from all loaded data objects.

DICOM data is automatically added as patient-study-series hierarchy. Non-DICOM data can be parsed if loaded from a local directory structure, or can be manually organized in tree structure by creating DICOM-like hierarchy or Folder nodes.

Subject hierarchy nodes provide features for the underlying data nodes, including cloning, bulk transforming, bulk show/hide, type-specific features, and basic node operations such as delete or rename. Additional plugins can provide other type-specific features and general operations, see Subject hierarchy labs page

Use Cases

Overview all loaded data objects in the same place, types indicated by icons Organize data in folders or patient/subject trees Visualize and bulk-handle lots of data nodes loaded from disk Easy show/hide of branches of displayable data Transform whole study (any branch) Export DICOM data (edit DICOM tags) Lots of type-specific functionality offered by the plugins Tutorials 2016 Jan 8th: This tutorial demonstrates the basic usage and potential of Slicer’s data manager module Subject Hierarchy using a two-timepoint radiotherapy phantom dataset. Panels and their use Subject hierarchy tree Contains all the objects in the Subject hierarchy in a tree representation Data loaded from DICOM are automatically added to the tree in the right structure (patient, study, series) Non-DICOM data also appears automatically in Subject hierarchy. There two ways are two ways to organize them in hierarchy 'Create hierarchy from loaded directory structure' action in the context menu of the scene (see bottom screenshot). This organizes the nodes according to the local file structure they have been loaded from. Drag&drop manually under a hierarchy node Nodes can be drag&dropped under other nodes, thus re-arranging the tree Basic operations (accessible in the context menu of the nodes by right-clicking them) Transform node or branch: Double-click the cell of the node or branch to transform in the column named 'Tr', then set the desired transform. If the column is not visible, check the 'Transforms' checkbox under the tree. An example can be seen in the top screenshot at 'Day 2' study Show/hide node or branch: Click on the eye icon Delete: Delete both data node and SH node Rename: Rename both data node and SH node Clone: Creates a copy of the selected node that will be identical in every manner. Its name will contain a '_Copy' postfix Edit properties: If the role of the node is specified (i.e. its icon is not a question mark), then the corresponding module is opened and the node selected (e.g. Volumes module for volumes) Create child...: Create a node with the specified type There are no nodes in the tree when Slicer is opened, new nodes can be added by right-clicking the Scene Roles and corresponding functions Volumes: icon, Edit properties and additional information in tooltip 'Register this...' action to select fixed image for registration. Right-click the moving image to initiate registration 'Segment this using...' action allows segmenting the volume, for example, in the Editor module 'Toggle labelmap outline display' for labelmaps Models: icon, Edit properties and additional information in tooltip Markups: icon and Edit properties SceneViews: icon, Edit properties and Restore scene view Charts: icon and Show chart Transforms: icon, additional tooltip info, Edit properties, Invert, Reset to identity MRML Node Inspector (closed drop-down panel under the tree) Displays the attributes of the currently selected Subject hierarchy node. Can be edited by double-clicking on an attribute name or value How to Create new Subject from scratch Right-click on the top-level item 'Scene' and select 'Create new subject' Create new hierarchy node Right-click on an existing node and select 'Create child ...'. The type and level of the child node will be specified by the user and the possible types depend on the parent. Folder type hierarchy node can be converted to Subject or Study using the context menu Rename Subject hierarchy node Right-click on the node and select 'Rename', or double-click the name of a node Apply transform on node or branch Double-click the cell of the node or branch to transform in the transform column (same icon as Transforms module), then set the desired transform. If the column is not visible, check the 'Transforms' checkbox under the tree. An example can be seen in the top screenshot at Patient 2

Subject hierarchy tree Parse local data loaded from directory structures

Similar Modules

• Data

References

• Additional information on Subject hierarchy labs page
• Manual editing of segmentations can be done in the Segmentations module

Information for Developers

• Important note: Instead of the usual New function, vtkMRMLSubjectHierarchyNode::CreateSubjectHierarchyNode should be used for instantiating an SH node. The reason is that when SH auto creation is turned on, then there is no need to create an SH node, but only to set up its properties (parent, level, name, association), but when it is turned off, then creating an SH node is necessary if the module relies on it. The CreateSubjectHierarchyNode function takes care of this, and only creates a node if it doesn't exist, otherwise just updates its properties.
• Implementing new plugins: Plugins are the real power of subject hierarchy, as they provide support for data node types, and add functionality to the context menu items.
  To create a C++ plugin, implement a child class of qSlicerSubjectHierarchyAbstractPlugin, for Python plugin see below. Many examples can be found in Slicer core and in the SlicerRT extension, look for folders named SubjectHierarchyPlugins.
  • Role plugins: add support for new data node types
    • Defines: ownership, icon, tooltip, edit properties, help text (in the yellow question mark popup), visibility icon, set/get display visibility, displayed node name (if different than name of the node object)
    • Existing plugins in Slicer core: Markups, Models, SceneViews, Charts, Folder, Tables, Transforms, LabelMaps, Volumes
  • Function plugins: add feature in right-click context menu for certain types of nodes
    • Defines: list of contect menu actions for nodes and the scene, types of nodes for which the action shows up, functions handling the defined action
    • Existing plugins in Slicer core: CloneNode, ParseLocalData, Register, Segment, DICOM
  • Writing plugins in Python:
    • Child class of AbstractScriptedSubjectHierarchyPlugin which is a Python adaptor of the C++ qSlicerSubjectHierarchyScriptedPlugin class
    • Example: https://subversion.assembla.com/svn/slicerrt/trunk/VolumeClip/src/SubjectHierarchyPlugins
• Glossary of all the used terms in SlicerRT