Documentation/Nightly/Modules/PortPlacement - Revision history

Luist: Removing warning about this module only working on 4.2

2013-11-11T14:59:14Z

Removing warning about this module only working on 4.2

Luist: /* Notes */

2013-11-11T14:58:34Z

Notes

Luist: /* Ports */ Adding documentation on movement of fiducials

2013-11-11T14:58:11Z

Ports: Adding documentation on movement of fiducials

Luist: /* Tools */ Updating tools documentation for new markups-enabled module.

2013-11-11T14:56:54Z

Tools: Updating tools documentation for new markups-enabled module.

Luist: /* Ports */ Updating ports documentation for new Markups-enabled module

2013-11-11T14:51:27Z

Ports: Updating ports documentation for new Markups-enabled module

Luist: added note that this module does not work yet on Slicer 4.3.

2013-11-06T20:06:10Z

added note that this module does not work yet on Slicer 4.3.

Luist: Fixed acknowledgements

2013-07-11T13:59:19Z

Fixed acknowledgements

Luist: Added references

2013-07-09T15:47:47Z

Added references

Luist: Updated contact info

2013-07-09T15:36:50Z

Updated contact info

Luist at 17:41, 20 June 2013

2013-06-20T17:41:14Z

@@ Line 21: / Line 21: @@
 <!-- ---------------------------- -->
 {{documentation/{{documentation/version}}/module-section|Module Description}}
 The PortPlacement module assists in the planning of surgical port placement in a laparoscopic procedure. Users can specify ports using fiducial markers and the module will automatically visualize simulated surgical tools at the port locations. Users can freely pivot the simulated surgical tools about the ports, as well as automatically orient all surgical tools toward a specified surgical target. Simulated tools are represented by cylinders whose lengths and radii can be varied from tool to tool.

← Older revision		Revision as of 14:58, 11 November 2013
Line 64:		Line 64:

	Finally, you can toggle the visibility of individual tools by clicking "Visible" checkboxes at each row of the ports table.		Finally, you can toggle the visibility of individual tools by clicking "Visible" checkboxes at each row of the ports table.
−
−	~~== Notes ==~~
−	Each port added to the scene is tied directly to the fiducial marker used to specify it; this means the user can move the fiducial marker around and the port/tool will follow automatically. This also means that if the user deletes a fiducial marker associated with the port, the port will also be removed from the scene.

	<!-- ---------------------------- -->		<!-- ---------------------------- -->

← Older revision		Revision as of 14:58, 11 November 2013
Line 46:		Line 46:

	You can also continue to add fiducial markers to the associated MarkupsFiducial list and the module will automatically add the new markers as ports.		You can also continue to add fiducial markers to the associated MarkupsFiducial list and the module will automatically add the new markers as ports.
		+
		+	Lastly, you can move a markups fiducial around the scene and the port will interactively follow the fiducial.

	== Tools ==		== Tools ==

@@ Line 50: / Line 50: @@
 Once you've added some ports, you can re-orient the surgical tools in two ways:
 * Target-oriented
-# Place a fiducial marker in the scene that you want your surgical tools to point at. Think of this as your surgical target.
+# Select the Markups module.
-# Select that fiducial marker in the box labeled "Surgical Target Fiducial".
+# Click the combo box labeled "List" and then click "Create and rename new MarkupsFiducial". Rename this MarkupsFiducial to something meaningful like "surgical target".
 # Click the "Aim Tools at Target" button to automatically orient all surgical tools toward your selected target.
 * Manual Orientation
-# In order to manually orient an individual tool, look in the port table for the fiducial corresponding to that tool's port and select it by clicking on it.
+# In order to manually orient an individual tool, look in the port table for the fiducial corresponding to that tool's port and click on it.
-# Use the Tool Orientation sliders to re-orient the tool about the port location.
+# Use the Tool Orientation sliders to re-orient the selected tool about the port location.
 You can also vary the length and radius of individual tools by selecting them in the table and adjusting the "Tool radius" and "Tool length" spinboxes.
 == Notes ==

@@ Line 32: / Line 32: @@
 == Ports ==
-There are two ways to add surgical ports to be visualized:
+You can use Markups fiducials to add surgical ports for visualization:
-* Individually
+# Select the Markups module.
-# Place a fiducial marker at a desired surgical port location.
+# Click the combo box labeled "Select a MarkupsFiducial".
-# Select that fiducial in the box labeled "Surgical Port".
+# Select "Create and rename new MarkupsFiducial" and give your MarkupsFiducial list a meaningful name like "surgical ports".
-# Click the "Add Port" button.
+# Begin placing fiducial markers in the scene where surgical ports are desired.
-* From a List
+# Select the Port Placement Module (under the IGT category).
-# Select the Annotations module.
+# Select your MarkupsFiducial list using the combo box labeled "Markups node of surgical ports"
-# Click the "Create a new hierarchy" button.
+# Click "Set Port Markups Node" to associate the selected MarkupsFiducial list with the Port Placement module.
-Once you've added your ports, the module will automatically visualize surgical tools at each port at some default (and likely useless) orientation.
+The module will automatically visualize surgical tools centered at each fiducial marker at some default (and likely useless) orientation.
-You can remove a port by selecting the fiducial used to specify it in the ports table and then clicking the "Remove Port" button.
+You can always remove a port by either deleting its associated fiducial marker or by highlighting the port in the module's ports table and clicking "Remove Selected Port".
 == Tools ==

@@ Line 9: / Line 9: @@
 {{documentation/{{documentation/version}}/module-introduction-row}}
 Extension: [[Documentation/{{documentation/version}}/Extensions/PortPlacement|PortPlacement]] <br>
-This work is part of the National Alliance for Medical Image Computing (NA-MIC), funded by the National Institutes of Health through the NIH Roadmap for Medical Research, Grant U54 EB005149. Information on NA-MIC can be obtained from the [http://www.na-mic.org/ NA-MIC website].<br>
+This work is supported by NA-MIC and the 3DSlicer community. This work was partially supported by NSF GRFP Grant No. DGE-1144081 and NIH/NIBIB Grant No. 1R43EB014074-01.<br>
 Author: Andinet Enquobahrie (Kitware), Luis G. Torres (UNC-Chapel Hill)<br>
 Contact: Andinet Enquobahrie, <email>andinet.enqu@kitware.com</email> and Luis G. Torres, <email>lgtorres42@gmail.com</email><br>

@@ Line 76: / Line 76: @@
 <!-- ---------------------------- -->
-<!-- {{documentation/{{documentation/version}}/module-section|References}}
+{{documentation/{{documentation/version}}/module-section|References}}
-N/A -->
+*Andinet Enquobahrie, Vikas Shivaprabhu, Stephen Aylward, Julien Finet, Kevin Cleary, and Ron Alterovitz. [http://proceedings.spiedigitallibrary.org/proceeding.aspx?articleid=1668860 Patient-specific port placement for laparoscopic surgery using atlas-based registration], SPIE, Mar. 2013.
 <!-- ---------------------------- -->

@@ Line 46: / Line 46: @@
 Once you've added your ports, the module will automatically visualize surgical tools at each port at some default (and likely useless) orientation.
 == Tools ==
@@ Line 58: / Line 60: @@
 You can also vary the length and radius of individual tools by selecting them in the table and adjusting the "Tool radius" and "Tool length" spinboxes.
 <!-- ---------------------------- -->
-{{documentation/{{documentation/version}}/module-section|Panels and their use}}
+<!-- {{documentation/{{documentation/version}}/module-section|Panels and their use}}
-N/A
+N/A -->
 <!--
 {{documentation/{{documentation/version}}/module-parametersdescription}}
@@ Line 67: / Line 72: @@
 <!-- ---------------------------- -->
-{{documentation/{{documentation/version}}/module-section|Similar Modules}}
+<!-- {{documentation/{{documentation/version}}/module-section|Similar Modules}}
-N/A
+N/A -->
 <!-- ---------------------------- -->
-{{documentation/{{documentation/version}}/module-section|References}}
+<!-- {{documentation/{{documentation/version}}/module-section|References}}
-N/A
+N/A -->
 <!-- ---------------------------- -->
-{{documentation/{{documentation/version}}/module-section|Information for Developers}}
+<!-- {{documentation/{{documentation/version}}/module-section|Information for Developers}}
-{{documentation/{{documentation/version}}/module-developerinfo}}
+{{documentation/{{documentation/version}}/module-developerinfo}} -->