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

From Slicer Wiki
Jump to: navigation, search
m (Text replacement - "\[https:\/\/www\.slicer\.org\/slicerWiki\/index.php\/([^ ]+) ([^]]+)]" to "$2")
 
(12 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<noinclude>{{documentation/versioncheck}}</noinclude>
+
<noinclude>{{documentation/versioncheck}}
 +
</noinclude>
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-header}}
 
{{documentation/{{documentation/version}}/module-header}}
Line 20: Line 21:
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Module Description}}
 
{{documentation/{{documentation/version}}/module-section|Module Description}}
Convenience module for sending commands through OpenIGTLink Remote to PLUS. Requires OpenIGTLink Remote module available in the SlicerIGT extension. See PLUS [https://www.assembla.com/spaces/plus/wiki/Users_guide user guide] and [http://perk-software.cs.queensu.ca/plus/doc/nightly/user/PlusServerCommands.html manual] for more information about PLUS server commands.
+
Convenience module for sending commands through OpenIGTLink Remote to PLUS. Requires OpenIGTLink Remote module available in the SlicerIGT extension. See PLUS [https://plustoolkit.github.io/usersguide user guide] and [http://perk-software.cs.queensu.ca/plus/doc/nightly/user/PlusServerCommands.html manual] for more information about PLUS server commands.
 +
 
 +
'''Demo video:''' https://youtu.be/lfZeXabDjMg
  
 
The module provides the following features:
 
The module provides the following features:
* Recording of 2D tracked ultrasound frames
+
 
* Volume reconstruction of recorded frames
+
*Recording of 2D tracked ultrasound frames
* Live ultrasound volume reconstruction using scout scanning
+
*Volume reconstruction of recorded frames
* Sending Transform Update command to PLUS server
+
*Live ultrasound volume reconstruction using scout scanning
 +
*Sending Transform Update command to PLUS server
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
Line 50: Line 54:
  
 
*'''Parameters sets:''' saving of all parameters
 
*'''Parameters sets:''' saving of all parameters
** Create a new parameter set to save your parameters
+
**Create a new parameter set to save your parameters
** Select previously saved ones  
+
**Select previously saved ones
** Default parameter set is selected when entering the module
+
**Default parameter set is selected when entering the module
 +
 
 
This is useful when user knows optimal parameters for a specific procedure. The parameters set is saved when saving the scene and is reloaded when opening a saved scene.
 
This is useful when user knows optimal parameters for a specific procedure. The parameters set is saved when saving the scene and is reloaded when opening a saved scene.
  
  
 
*'''Parameters:''' parameters for communication with PLUS server, recording and reconstruction
 
*'''Parameters:''' parameters for communication with PLUS server, recording and reconstruction
** OpenIGTLinkConnector
+
**OpenIGTLinkConnector
** Capture Device ID
+
**Capture Device ID
** Volume Reconstructor ID
+
**Volume Reconstructor ID
These parameters are essential. Therefore all commands are disabled when these parameters are not set. List of available OpenIGTLinkConnector is available once you created connections in [https://www.slicer.org/slicerWiki/index.php/Documentation/Nightly/Modules/OpenIGTLinkIF OpenIGTLinkIF] module. When a connector is selected, capture device ID and volume reconstruction ID lists are automatically filled.  
+
 
 +
These parameters are essential. Therefore all commands are disabled when these parameters are not set. List of available OpenIGTLinkConnector is available once you created connections in [[Documentation/Nightly/Modules/OpenIGTLinkIF|OpenIGTLinkIF]] module. When a connector is selected, capture device ID and volume reconstruction ID lists are automatically filled.  
  
  
 
*'''Recording:'''  
 
*'''Recording:'''  
** Start and stop recording
+
**Start and stop recording
** Advanced parameters:
+
**Advanced parameters:
*** Modify default output filename "Recording.mha"
+
***Modify default output filename "Recording.mha"
*** Add timestamp (YYYYMMDD_HHMMSS) to filename
+
***Add timestamp (YYYYMMDD_HHMMSS) to filename
  
  
 
*'''Offline reconstruction of recorded volume:'''  
 
*'''Offline reconstruction of recorded volume:'''  
** Offline reconstruction
+
**Offline reconstruction
** Advanced parameters:
+
**Advanced parameters:
*** Spacing (default value is 3mm)
+
***Spacing (default value is 3mm)
*** Output volume device name  
+
***Output volume device name
*** Volume to reconstruct filename (automatically filled when user record a file, but user can also edit this line and reconstruct previously saved files)
+
***Volume to reconstruct filename (automatically filled when user record a file, but user can also edit this line and reconstruct previously saved files)
*** Show results on completion (display reconstructed volume in the green, yellow and 3D views)  
+
***Show results on completion (display reconstructed volume in the green, yellow and 3D views)
  
  
 
*'''Scout scan and live reconstruction:'''  
 
*'''Scout scan and live reconstruction:'''  
** Start and stop scout scan  
+
**Start and stop scout scan
** Advanced parameters:
+
**Advanced parameters:
*** Spacing (default value is 3mm as we expect a low resolution scout scan)
+
***Spacing (default value is 3mm as we expect a low resolution scout scan)
*** Modify default output filename "ScoutScanRecording.mha"
+
***Modify default output filename "ScoutScanRecording.mha"
*** Add timestamp (YYYYMMDD_HHMMSS) to filename
+
***Add timestamp (YYYYMMDD_HHMMSS) to filename
*** Show results on completion (display reconstructed volume in the green, yellow and 3D views)
+
***Show results on completion (display reconstructed volume in the green, yellow and 3D views)
 +
 
 
Scout scan button record a file and automatically performs the volume reconstruction once the recording is over. The result of scout scan volume reconstruction is saved in "scoutFile.mha"
 
Scout scan button record a file and automatically performs the volume reconstruction once the recording is over. The result of scout scan volume reconstruction is saved in "scoutFile.mha"
** Start and stop live volume reconstruction:
+
 
** Display and modify ROI using eye icon (initialized to fit scout scan volume)
+
**Start and stop live volume reconstruction:
** Spacing (default value is 1mm for high resolution reconstruction)
+
**Display and modify ROI using eye icon (initialized to fit scout scan volume)
** Advanced parameters:
+
**Spacing (default value is 1mm for high resolution reconstruction)
*** Output volume device name (read only)
+
**Advanced parameters:
*** Modify default output filename "LiveReconstructedVolume.mha"
+
***Output volume device name (read only)
*** Add timestamp (YYYYMMDD_HHMMSS) to filename
+
***Modify default output filename "LiveReconstructedVolume.mha"
*** Display volume extent values
+
***Add timestamp (YYYYMMDD_HHMMSS) to filename
*** Take snapshots during live volume reconstruction (if 0, no snapshots)
+
***Display volume extent values (updated when clicking on scout scan or live reconstruction command buttons)
*** Show results on completion (display reconstructed volume in the green, yellow and 3D views)
+
***Display snapshots during live volume reconstruction (if 0, no snapshots)
 +
***Show results on completion (display reconstructed volume in the green, yellow and 3D views)
  
  
Line 108: Line 116:
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|References}}
 
{{documentation/{{documentation/version}}/module-section|References}}
* [https://www.assembla.com/spaces/plus/wiki/PlusServer_commands PlusServer commands]
+
 
 +
*[http://perk-software.cs.queensu.ca/plus/doc/nightly/user/PlusServerCommands.html PlusServer commands]
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Information for Developers}}
 
{{documentation/{{documentation/version}}/module-section|Information for Developers}}
{{documentation/{{documentation/version}}/module-developerinfo}}
 
  
  

Latest revision as of 02:42, 27 November 2019

Home < Documentation < Nightly < Modules < PlusRemote

For the stable Slicer documentation, visit the 4.10 page.

Introduction and Acknowledgements


Author: Franklin King (PerkLab, Queen's University)
Contributors: Tamas Ungi (PerkLab, Queen's University), Andras Lasso (PerkLab, Queen's University), Amélie Meyer (Télécom Physique Strasbourg, Université de Strasbourg)
Contact: Tamas Ungi, <email>ungi@cs.queensu.ca</email>

Cancer Care Ontario  

Module Description

Convenience module for sending commands through OpenIGTLink Remote to PLUS. Requires OpenIGTLink Remote module available in the SlicerIGT extension. See PLUS user guide and manual for more information about PLUS server commands.

Demo video: https://youtu.be/lfZeXabDjMg

The module provides the following features:

  • Recording of 2D tracked ultrasound frames
  • Volume reconstruction of recorded frames
  • Live ultrasound volume reconstruction using scout scanning
  • Sending Transform Update command to PLUS server

Use Cases

Some ultrasound-guided interventions require a general view of an entire area followed by more detailed images of a specific region. One example is spinal injection procedures. The problem is that, for elderly patients, the epidural area is not directly visible in ultrasound images because the intervertebral space is often compressed or deformed. In this case, physicians use four vertebrae landmarks to estimate the position of the target. Visualization can be improved using reconstructed 3D ultrasound volumes, but often there is not enough time for high resolution reconstruction of a large area during interventions.

The live ultrasound volume reconstruction workflow using scout scanning is then adapted for these procedures. The two-step method allows user to perform quick low resolution scout scan followed by high resolution volume reconstruction of a selected region of interest, in real-time. Low resolution scout scanning offers visualization of the global area and selection of the region of interest, and then high resolution reconstruction provides a good image quality of the targeted region.

Tutorials

The SlicerIGT website provides a tutorial for ultrasound volume reconstruction in Slicer using Plus Remote (U35).

Panels and their use

Plus Remote panel
Plus Remote panel with advanced parameters
  • Parameters sets: saving of all parameters
    • Create a new parameter set to save your parameters
    • Select previously saved ones
    • Default parameter set is selected when entering the module

This is useful when user knows optimal parameters for a specific procedure. The parameters set is saved when saving the scene and is reloaded when opening a saved scene.


  • Parameters: parameters for communication with PLUS server, recording and reconstruction
    • OpenIGTLinkConnector
    • Capture Device ID
    • Volume Reconstructor ID

These parameters are essential. Therefore all commands are disabled when these parameters are not set. List of available OpenIGTLinkConnector is available once you created connections in OpenIGTLinkIF module. When a connector is selected, capture device ID and volume reconstruction ID lists are automatically filled.


  • Recording:
    • Start and stop recording
    • Advanced parameters:
      • Modify default output filename "Recording.mha"
      • Add timestamp (YYYYMMDD_HHMMSS) to filename


  • Offline reconstruction of recorded volume:
    • Offline reconstruction
    • Advanced parameters:
      • Spacing (default value is 3mm)
      • Output volume device name
      • Volume to reconstruct filename (automatically filled when user record a file, but user can also edit this line and reconstruct previously saved files)
      • Show results on completion (display reconstructed volume in the green, yellow and 3D views)


  • Scout scan and live reconstruction:
    • Start and stop scout scan
    • Advanced parameters:
      • Spacing (default value is 3mm as we expect a low resolution scout scan)
      • Modify default output filename "ScoutScanRecording.mha"
      • Add timestamp (YYYYMMDD_HHMMSS) to filename
      • Show results on completion (display reconstructed volume in the green, yellow and 3D views)

Scout scan button record a file and automatically performs the volume reconstruction once the recording is over. The result of scout scan volume reconstruction is saved in "scoutFile.mha"

    • Start and stop live volume reconstruction:
    • Display and modify ROI using eye icon (initialized to fit scout scan volume)
    • Spacing (default value is 1mm for high resolution reconstruction)
    • Advanced parameters:
      • Output volume device name (read only)
      • Modify default output filename "LiveReconstructedVolume.mha"
      • Add timestamp (YYYYMMDD_HHMMSS) to filename
      • Display volume extent values (updated when clicking on scout scan or live reconstruction command buttons)
      • Display snapshots during live volume reconstruction (if 0, no snapshots)
      • Show results on completion (display reconstructed volume in the green, yellow and 3D views)


  • Transform Update: Update transform from what is set in the PLUS config file; Requires name of transform node to match an existing transform in the PLUS config file
  • Reply: Feedback message from PLUS server (also visible when moving the mouse on blue information icons)

Similar Modules

N/A

References

Information for Developers