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

From Slicer Wiki
Jump to: navigation, search
(Added information to How to section)
Tag: 2017 source edit
 
(40 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<noinclude>{{documentation/versioncheck}}</noinclude>
+
<noinclude>{{documentation/versioncheck}}
<!-- ---------------------------- -->
+
</noinclude>
{{documentation/{{documentation/version}}/module-header}}
 
<!-- ---------------------------- -->
 
  
<!-- ---------------------------- -->
+
{{documentation/banner
{{documentation/{{documentation/version}}/module-section|Introduction and Acknowledgements}}
+
| text  = [https://slicer.readthedocs.io/en/latest/user_guide/modules/segmentations.html This page has been moved to read-the-docs.]
{{documentation/{{documentation/version}}/module-introduction-start|{{documentation/modulename}}}}
+
| background-color = 8FBC8F }}
{{documentation/{{documentation/version}}/module-introduction-row}}
 
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.<br>
 
Author: Csaba Pinter (PerkLab, Queen's University)<br>
 
Contact: Csaba Pinter, <email>csaba.pinter@queensu.ca</email><br>
 
[http://www.slicer.org/slicerWiki/index.php/Documentation/Nightly/Extensions/SlicerRT Back to SlicerRT home]
 
{{documentation/{{documentation/version}}/module-introduction-row}}
 
{{documentation/{{documentation/version}}/module-introduction-logo-gallery
 
|{{collaborator|logo|cco}}|{{collaborator|longname|cco}}
 
|{{collaborator|logo|sparkit}}|{{collaborator|longname|sparkit}}
 
|{{collaborator|logo|ocairo}}|{{collaborator|longname|ocairo}}
 
}}
 
{{documentation/{{documentation/version}}/module-introduction-end}}
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Module Description}}
 
The {{documentation/modulename}} module manages segmentations. Each segmentation can contain multiple segments, which correspond to one structure or ROI. Each segment can contain multiple data representations for the same structure, and the module supports automatic conversion between these representations (the default ones are: planar contour, binary labelmap, closed surface model), as well as advanced display settings and import/export features.<br><br>
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Use Cases}}
 
* 3D printing: Convert labelmaps to surface models and export them to STL
 
* Contour analysis: Convert RT planar contours to labelmap for per-voxel analysis
 
* Nice and flexible visualization: Show any structure as 3D surface, and line intersections in 2D views; Show surface and labelmap simultaneously
 
* Organize segmented structures: Each segmentation contains multiple "segments"
 
 
 
{|align="center"
 
|[[File:20150710_SegmentationsModuleUI.png|thumb|720px| Segmentations module UI]]
 
|[[File:ContourRepresentations_201507.png|thumb|620px| Segment representations (A: planar contours, B: closed surface, C: binary labelmap, D: ribbon model)]]
 
|}
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Tutorials}}
 
N/A
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|How to}}
 
 
 
; Create segmentation from scratch
 
: Select 'Create new Segmentation' or 'Create new Segmentation as...' in the Current segmentation drop-down box at the top of the Segmentations module
 
 
 
; Create segment from labelmap volume or model
 
: Expand Copy/mode segment (import/export) section at the bottom of the Segmentations module (it is collapsed by default)
 
: Select labelmap volume or model in the list on the right
 
: Click on '<+' button to import the selected object as a segment to the currently selected segmentation (multiple segments in case of multi-label labelmap)
 
 
 
; Export labelmap or surface model representation from a segment (for editing, saving to STL, etc).
 
: Make sure the representation to export is present. If there is no green tick icon next to binary labelmap (if exporting to labelmap) or closed surface (if exporting to model), then click on the Create 'Default' button in the row of desired representation
 
: Expand Copy/mode segment (import/export) section at the bottom of the Segmentations module (it is collapsed by default)
 
: Select segment to export (multiple segments can be exported to labelmap, but note that if they overlap then the alphabetical order of the segments determine which one is exported)
 
: Select representation node (labelmap or model) to export the segment to. New node can be conveniently created by the two small buttons next to the node selector box.
 
: Export segment(s) by clicking '>' or '+>' buttons. Move button ('>') will remove the segment from the segmentation while the copy button ('+>') will not.
 
 
 
;[[Documentation/Nightly/Modules/Contours/HowToEdit|Edit an existing contour]]
 
: See page via link above '''!!!TODO!!!'''
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Panels and their use}}
 
* TODO
 
 
 
<!--
 
{{documentation/{{documentation/version}}/module-parametersdescription}}
 
-->
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Similar Modules}}
 
This module and infrastructure is a successor of the [[Documentation/{{documentation/version}}/Modules/Contours|Contours]] module and mechanism, which was the first implementation for this task, but its design was overgrewn by the new features and needs, and became inconvenient and unstable. Further information about the Segmentation effort on the related [https://www.assembla.com/spaces/slicerrt/tickets/626 Assembla ticket] and [https://www.assembla.com/spaces/slicerrt/wiki/Segmentation wiki page], and the links pointing from these pages.
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|References}}
 
* [https://www.assembla.com/spaces/slicerrt/wiki/Segmentation wiki page]
 
* Past references
 
** Issue for Segmentations (complete Contours overhaul, delivery June 2015) [https://www.assembla.com/spaces/slicerrt/tickets/626 here]
 
** Issue for original Contours effort on SlicerRT Assembla ticketing system [https://www.assembla.com/spaces/slicerrt/tickets/137 here]
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Information for Developers}}
 
* [http://www.slicer.org/slicerWiki/index.php/Documentation/Labs/Segmentations Labs page]
 
 
 
<!-- ---------------------------- -->
 
=FAQ=
 
; The closed surface generated from the RTSS contour points is flawed
 
: TODO (report issue, ribbon workaround)
 
 
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-footer}}
 
<!-- ---------------------------- -->
 

Latest revision as of 23:35, 22 May 2020

Home < Documentation < Nightly < Modules < Segmentations