Difference between revisions of "Documentation/Nightly/Extensions/TrackerStabilizer"

From Slicer Wiki
Jump to: navigation, search
Line 1: Line 1:
 +
#REDIRECT [[Documentation/Nightly/Modules/TrackerStabilizer]]
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
{{documentation/{{documentation/version}}/module-header}}
+
{{documentation/{{documentation/version}}/extension-footer}}
<!-- ---------------------------- -->
 
 
 
<!-- ---------------------------- -->
 
{{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 supported by NA-MIC, NCIGT, and the Slicer Community.<br>
 
Author: Laurent Chauvin, Jayender Jagadeesan, Nobuhiko Hata<br>
 
Contact: Laurent Chauvin <email> lchauvin@bwh.harvard.edu</email> <br>
 
{{documentation/{{documentation/version}}/module-introduction-row}}
 
{{documentation/{{documentation/version}}/module-introduction-logo-gallery
 
|{{collaborator|logo|namic}}|NA-MIC
 
|{{collaborator|logo|ncigt}}|NCIGT
 
|{{collaborator|logo|spl}}|SPL
 
}}
 
 
 
This project is supported by National Institute of Health (5P01CA067165, 5R01CA124377, 5R01CA138586, 2R44DE019322, 7R01CA124377, 5R42CA137886, 8P41EB015898).
 
 
 
{{documentation/{{documentation/version}}/module-introduction-end}}
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Module Description}}
 
{{documentation/modulename}} module allows to output a filtered transform node based on an tracker input (transform node). Tracking sensors are particularly usefull to track surgical tools, robots, patient motion, etc... . However, data imported in 3D Slicer from these devices are often noisy. To reduce the noise and smoothly control objects, such as 3D Slicer camera, the {{documentation/modulename}} module will apply a low-pass filter on input data. The cut-off frequency (i.e. the smoothing parameter) is adjustable by the user.
 
It is important to notice that filters induce delay, and the smoother the motion is, the bigger the delay between the raw data and the filtered position will be.
 
<!--
 
Here comes a description what the module is good for. Explain briefly how it works and point to the [[documentation/{{documentation/version}}/Modules/{{documentation/modulename}}#References|references]] giving more details on the algorithm.
 
 
 
If you are documenting a CLI, the description should be extracted from the corresponding XML description. This could be done automatically using the following wiki template:<pre>{{documentation/{{documentation/version}}/module-description}}
 
 
 
{{documentation/{{documentation/version}}/module-description}}
 
-->
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Use Cases}}
 
The {{documentation/modulename}} module could be used in any situation requiring stable tracking data and not requiring a "real-time" information. Indeed, applying a filter on raw data will induce a delay (depending on choosen parameters) on the filtered position/orientation.
 
An example could be to drive Slicer's virtual camera. Having some noise on the transformation driving the camera will cause the camera to "shake" which could be really distracting and uncomfortable to look at. By filtering this raw data, camera motion is smoothed.
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Tutorials}}
 
N/A
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Panels and their use}}
 
{|
 
The GUI of the {{documentation/modulename}} module contains 4 elements:
 
* Input Transform. This is the raw data, usually raw tracker data, represented by a vtkMRMLLinearTransformNode
 
* Output Transform. This is the filtered transform represented also by a vtkMRMLLinearTransformNode. This node can be created directly from the list
 
* Filter checkbox. This checkbox turn on/off the filtering
 
* Smoothing slider. This slider control the smoothing parameter. In the left, smoother, with relatively important delay. In the right, faster (almost no delay), but noisier.
 
|}
 
{|
 
|[[Image:Slicer4-TrackerStabilizer-GUI.png|thumb|400px|{{documentation/modulename}} GUI ]]
 
|}
 
 
 
<!--
 
{{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}}
 
{{documentation/{{documentation/version}}/module-developerinfo}}
 
This module is for now only a low-pass filter, but in the futur, several filters would be implemented to let the choice to the user.
 
 
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-footer}}
 
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->

Revision as of 14:28, 12 February 2013

Home < Documentation < Nightly < Extensions < TrackerStabilizer