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

From Slicer Wiki
Jump to: navigation, search
 
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<!-- ---------------------------- -->
+
#REDIRECT [[Documentation/Nightly/Modules/TransformVisualizer]]
{{documentation/{{documentation/version}}/module-header}}
 
<!-- ---------------------------- -->
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Introduction and Acknowledgements}}
 
{{documentation/{{documentation/version}}/module-introduction-start|{{documentation/modulename}}}}
 
{{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: Franklin King (PerkLab, Queen's University)<br>
 
Contributors: Andras Lasso (PerkLab, Queen's University), Csaba Pinter (PerkLab, Queen's University)<br>
 
Contact: Franklin King, <email>franklin.king@queensu.ca</email><br>
 
{{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}}
 
}}
 
{{documentation/{{documentation/version}}/module-introduction-end}}
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Module Description}}
 
The {{documentation/modulename}} module visualizes deformation fields using various visualization options.
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Use Cases}}
 
Visualize deformation fields
 
{|align="center"
 
|[[File:SlicerRT_DefFieldVisGlyphUI.png|thumb|320px|Deformation Field Visualizer module UI with glyph visualization mode active]]
 
|[[File:SlicerRT_DefFieldVisModels.png|thumb|700px|Deformation Field Visualizer modes]]
 
|}
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Tutorials}}
 
N/A
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Panels and their use}}
 
* IO
 
** Input
 
*** Deformation: The deformation field which will be visualized. The deformation field can be represented as either a vector volume or a transform (linear or non-linear) with a reference image.
 
*** Reference Image: The reference image to be used with a selected transform to generate a deformation field. Enabled only when a transform is selected as the input deformation. The deformation field will be generated when both a valid deformation and a reference image are selected.
 
** Output
 
*** Output Model: A model to be selected or created that will contain the output.
 
 
 
* Visualization Mode
 
** Glyph: Generates glyphs oriented to the vector direction and scaled to the vector magnitude
 
** Grid: Generates a cube grid that is warped by the deformation field
 
** Block: Generates a rectangular model that is then warped by the deformation field
 
** Contour: Generates isosurfaces according to the vector magnitudes of the deformation field
 
** Glyph Slice: Projects the deformation field to a chosen slice view and generates glyphs oriented to the vector direction and scaled to the vector magnitude
 
** Grid Slice: Projects the deformation field to a chosen slice view and generates a cube grid that is warped by the deformation field
 
 
 
* Parameters
 
** Glyph Options
 
*** Number of Glyphs: Number of randomly placed glyphs to create
 
*** Magnitude Threshold: Only vectors with a magnitude within the specified range will be represented with a glyph
 
*** Scaling
 
**** Scale Factor: Multiplier for size of glyph relative to vector magnitude
 
**** Directional Scaling: Scale glyph only along the vector direction
 
**** Isotropic Scaling: Scale glyph in all directions
 
*** Source: Model to be used as the glyph model; arrow, cone, and sphere are available and each have their own respective options
 
*** Random Seed: Seed used for random placement of glyphs
 
** Grid Options
 
*** Scale Factor: Multiplier for the scale of the deformation
 
*** Spacing: Line spacing used to generate a cube grid
 
** Block Options
 
*** Scale Factor: Multiplier for the scale of the deformation
 
** Contour Options
 
*** Number of Contours: Number of contours to generate between the specified range values
 
*** Range: Range to create contours within
 
*** Decimate: Target decimation as a decimal percentage reduction in polygons (0 results in no decimation whereas 0.99 results in a target of 99% reduction in polygons)
 
** Glyph Slice Options
 
*** Slice: Slice view to orient and project the glyphs to
 
*** Number of Glyphs: Number of randomly placed glyphs to create in total
 
*** Magnitude Threshold: Only vectors with a magnitude within the specified range will be represented with a glyph
 
*** Scale Factor: Multiplier for size of glyph relative to vector magnitude
 
*** Random Seed: Seed used for random placement of glyphs
 
** Grid Slice Options
 
*** Slice: Slice view to orient and project the glyphs to
 
*** Scale Factor: Multiplier for size of glyph relative to vector magnitude
 
*** Spacing: Line spacing used to generate a square grid
 
 
 
<!--
 
{{documentation/{{documentation/version}}/module-parametersdescription}}
 
-->
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Similar Modules}}
 
N/A
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|References}}
 
N/A
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Information for Developers}}
 
N/A
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-footer}}
 
<!-- ---------------------------- -->
 

Latest revision as of 22:28, 7 August 2013

Home < Documentation < Nightly < Modules < DeformationFieldVisualizer