Difference between revisions of "Documentation/Nightly/Modules/SubjectHierarchy"

From Slicer Wiki
Jump to: navigation, search
(Overhaul step 1)
(Removed all information, because everething moved to the Data module)
 
(23 intermediate revisions by 4 users not shown)
Line 24: Line 24:
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Module Description}}
 
{{documentation/{{documentation/version}}/module-section|Module Description}}
The {{documentation/modulename}} module acts as a central data-organizing point in Slicer. All DICOM data is autmatically added to the tree. Non-DICOM data can be parsed if loaded from a local directory structure, or has to be manually added (non-SH nodes are the ones on the bottom with no icons).
+
<big>'''The content of the Subject Hierarchy module moved to the [[Documentation/{{documentation/version}}/Modules/Data|Data module]]'''</big>
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 [[Documentation/Labs/SubjectHierarchy|Subject hierarchy labs page]]
+
<br>
 
+
<br>
<!-- ---------------------------- -->
+
<br>
{{documentation/{{documentation/version}}/module-section|Use Cases}}
+
<br>
 
+
<br>
{| class="wikitable"
+
<br>
|
+
<br>
* Load DICOM data and need to see in the same hierarchy
 
* Visualize and bulk-handle lots of data nodes loaded from disk
 
* Easy show/hide of branches of displable data
 
* Transform whole study (any branch)
 
* Export DICOM data (coming soon)
 
* Edit DICOM tags (coming soon)
 
* Create contour from labelmap or model (currently supported only in the [[Documentation/{{documentation/version}}/Extensions/SlicerRT|SlicerRT extension]]
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Tutorials}}
 
None specifically for Subject Hierarchy yet
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|How to}}
 
 
 
; Create new Patient/Subject from scratch
 
: Right-click on the top-level item 'Scene' and select 'Create new subject'
 
 
 
; Create new generic Subject hierarchy node from scratch
 
: Right-click on an existing node and select 'Create generic child node'. The level of the child node will be one under the parent node if available (e.g. 'Patient' / 'Subject' -> 'Study', 'Subseries' -> 'Subseries').
 
 
 
; 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 column named 'Tr', then set the desired transform. If the column is not visible, check the 'Transforms' checkbox under the tree
 
 
 
 
<br>
 
<br>
; Contour-specific features (requires [[Documentation/{{documentation/version}}/Extensions/SlicerRT|SlicerRT extension]]):
 
;: Create contour from scratch
 
:: In Contours module select 'Create new Contour' in the contour selector drop-down to create a new contour
 
:: In Subject Hierarchy module drag&drop new contour from 'Potential subject hierarchy nodes' list to under a contour set in the tree
 
:: The default representation is an empty Ribbon model. It can be converted to Indexed labelmap in the Contours module and then the labelmap '''can be edited in the Editor module'''
 
 
;: Create contour from labelmap volume or model
 
:: In Subject Hierarchy module drag&drop the existing representation (labelmap or model) from the non-Subject hierarchy nodes (on the bottom of the tree without role icons) to under a contour set in the tree. This way an encapsulating Contour node gets created and associated to the corresponding color table
 
 
;: Create new Contour set from scratch
 
:: Right-click on an existing Study node and select 'Create child contour set'. This menu item is only available for Study level nodes
 
 
| [[File:SlicerRT_0.11_PatientHierarchy_ProstateEntLoaded.png|thumb|408px| Subject hierarchy module GUI]]
 
|}
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Panels and their use}}
 
; Subject hierarchy tree (top)
 
: Contains all the objects in the Subject hierarchy in a tree representation.
 
: The only items that exist in the tree before importing any data are the default contour set and its corresponding color table, which facilitates Contour node creation without having any DICOM data imported
 
 
; 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
 
 
; Potential subject hierarchy nodes list
 
: List of nodes that are currently outside the subject hierarchy, but can be added. Nodes are listed in this list if there is at least one plugin that can do the adding of that node.
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Similar Modules}}
 
N/A
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|References}}
 
* Manual editing of contours can be done in the [http://www.slicer.org/slicerWiki/index.php/Documentation/Nightly/Modules/Contours Contours module]
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Information for Developers}}
 
* [http://www.slicer.org/slicerWiki/images/7/7c/SlicerRt_PatientHierarchy_Overview.pptx Technical overview of the Patient Hierarchy mechanism]
 
* [https://www.assembla.com/spaces/slicerrt/wiki/SlicerRt_naming_conventions Glossary of all the used terms in SlicerRT]
 
 
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-footer}}
 
{{documentation/{{documentation/version}}/module-footer}}
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->

Latest revision as of 19:41, 25 April 2017

Home < 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 content of the Subject Hierarchy module moved to the Data module