Differences

This shows you the differences between two versions of the page.

--- planning:userguide:tutorials:apertures [2016/08/17 11:58] – created dpatenaude
+++ planning:userguide:tutorials:apertures [2021/07/29 18:28] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
 ====== Creating an Aperture ======
-An aperture can be added for any snout that has slabs defined for use in the site specific machine model.
+An aperture can be added for any snout that has slabs defined for use in the site specific machine model. The site model also includes a definition for the aperture milling tool and Astroid enforces the "millability" of all apertures so that dose is only computed using a device that exactly matches what will be manufactured. The user has the ability to utilize apertures for all types of proton delivery including: PBS, DS, and US. The major steps involved in creating an aperture are common to all delivery modes, so the PBS beam example below can be referenced for all cases.
 ===== Adding an Aperture =====
-  * From within the PBS Beam Task you may add an aperture to a beam by selecting the Aperture Task Block clicking the "Add One" button. {{ :planning:userguide:walkthroughs:add_one.png?250 |}}
+==== PBS ====
+  * From within the PBS Beam Task you may add an aperture to a beam by clicking the "Add One" button from within the //Aperture Task Block//. {{ :planning:userguide:tutorials:aperture_add.png?250 |}}
+==== SOBP ====
+  * From within the SOBP Beam Task, an initial aperture is automatically created (note: the "Create New Hardware" option is selected from within the //Aperture Task Block//) based on your site configuration default margins and the selected beam target. Changes to the default aperture can be made according to the instructions and descriptions below if needed. Alternatively, you can re-use an existing aperture by clicking the "Re-Use Existing Hardware" button. Selecting the "Re-Use Existing Hardware" option ensures that the current beam will use the exact same device used in an another beam within the plan. {{ :planning:userguide:tutorials:re-using_existing_hardware_-_aperture.png? 300 |}}
 ===== Target =====
-{{ :planning:userguide:walkthroughs:aperturemain.png?300|}}
+  * Your target structure is automatically selected from your beam setup information. So you need to only specify the number of millimeters you want to expand your aperture around the target structure using the "Margin" option to generate your initial aperture shape. For this example we will give a margin of 10mm around the PTV7920. {{ :planning:userguide:tutorials:aperture_target.png?300 |}}
-  * Your target structure is automatically selected from your beam information so you need to only specify the number of millimeters you want to expand your aperture around the target structure using the "Margin" option to generate your initial aperture shape.
     * Your aperture should now appear in the BEV display window.
+    * As seen in the example, the aperture is created so that it there is a 10mm margin from the PTV7920 to the edge of the aperture. {{ :planning:userguide:tutorials:aperture_target_demo.png?300 |}}
 ===== Avoidance Structures =====
   * In many cases you may have nearby critical structures that must be avoided. You can add an "Avoidance Structure" to your aperture design by clicking on the "Add Structure" dropdown and selecting a structure.
-  * Once added you can now specify a margin (mm) around this structure if desired (note negative margins will reduce the size of the blocked area of the structure).
+  * Once added you can now specify a margin (mm) around this structure if desired (note negative margins will reduce the size of the blocked area, exposing part of the structure to the open field).
-    * You may also choose to occlude the structure by the target or not using the "Occlude by Target" option.
+    * You may also choose to occlude the structure by the target or not using the "Occlude by Target" option. For the following examples we will use the Urethra as it shows a dramatic example of differences of using or not using the "Occulde by Target" option. A 2mm margin was applied to the Urethra for the following examples. {{ :planning:userguide:tutorials:aperture_choose_structure_avoidance.png?300 |}}
-      * By checking the "Occlude by Target" box you are choosing to give the target priority over the structure in the view you are looking at in the DRR. In other words the visible target (target in front of this structure) will not be blocked by the aperture. <add screen shot>FIXME
+      * By checking the "Occlude by Target" box you are choosing to give the target priority over the structure in the view you are looking at in the DRR. In other words the visible target (target in front of this structure) will not be blocked by the aperture. Note that just the inferior edge of the Urethra is blocked by the aperture. The part of the Urethra that is behind the PTV7920 is not blocked. {{ :planning:userguide:tutorials:aperture_occlude.png?200 |}}
-      * If you leave the "Occlude by Target" unchecked, you are choosing to give the structure priority over the target. This means you will block the entire structure regardless of its position relative to the target. <add screen shot>FIXME
+      * If you leave the "Occlude by Target" unchecked, you are choosing to give the structure priority over the target. This means you will block the entire structure regardless of its position relative to the target. In this example the aperture blocks out all of the Urethra. {{ :planning:userguide:tutorials:aperture_not_occluded.png?200 |}}
   * You may add as many Avoidance Structures as needed to design your aperture shape.
@@ Line 24: / Line 30: @@
   * The "Shape Smoothing" section allows you to smooth the aperture if needed.
-  * The smoothing level value can be set from 0-20, with zero applying no smoothing and higher numbers increasing the smoothness of the aperture. More details regarding the smoothing algorithm and process can be found here <link>FIXME.
+  * The smoothing level value can be set from 0-20, with zero applying no smoothing and higher numbers increasing the smoothness of the aperture. See [[http://apps.dotdecimal.com/doku.php?id=dosimetry:userguide:design_task_functions:dtf#aperture_mill_radius_and_smoothing|dosimetry explanation on aperture smoothing]] for more details regarding the smoothing algorithm and process.
 ===== Manual Edits =====
-  * Manual edits allow you to draw on the BEV in order to manually edit the aperture shape.
+  * Manual edits allow you to draw on the BEV in order to manually edit the aperture shape. To begin editing simply click the //Enable// link.
-  * First, set the radius of the editing tool to the desired size (you can directly type a size or use the -/+ on either side to increment the size)
+  * First, set the radius of the editing tool to the desired size (you can directly type a size or use the -/+ on either side to increment the size) {{ :planning:userguide:tutorials:aperture_brush_size.png?300 |}}
-  * Next, click the "Enable Editing" button to allow manual edits. You are now free to draw manual override regions directly on the BEV. You draw by simply clicking and dragging the mouse at the desired positions.
+  * You are now free to draw manual override regions directly on the BEV. You draw by simply clicking and dragging the mouse at the desired positions.
+    * You have the option to use a freehand brush tool or a straight line drawing tool for performing manual edits.
+      * While using the straight line tool, the Snapping option allows snapping for horizontal, vertical, and 45 degree angles.
     * The editing tool automatically switches between adding or subtracting material based on the position of the tool when the mouse is first clicked (i.e. when starting each new draw operation).
-      * When outside the aperture, you edit the aperture by pushing in/subtracting and your edit regions are drawn in a blue color. <screen capture>FIXME
+      * When outside the aperture, you edit the aperture by pushing in/subtracting and your edit regions are drawn in a blue color. The hashed red line denotes the original placement of the aperture. {{ :planning:userguide:tutorials:aperture_outside_edit.png?200 |}}
-      * When inside the aperture, you edit the aperture by pushing out/adding and your edit regions are drawn as the color of your target.  <screen capture>FIXME
+      * When inside the aperture, you edit the aperture by pushing out/adding and your edit regions are drawn as the color of your target. {{ :planning:userguide:tutorials:aperture_inside_edit.png?200 |}}
+    * <WRAP center round tip 85%>
+The manual edits contain an "undo" feature, so that the user can successively remove the last manual edit step by pressing Ctrl+Z. Please note that the undo functionality only tracks edits performed in the active session, so as soon as you leave this block or disable manual edits, you will be unable to use the undo functionality on those changes when returning to this task. </WRAP>
     * Once done with manually editing, click the "Disable Editing" button to end the process.
-    * Note that your edits and the resulting aperture shape will still show on the DRR (BEV) and your edits will remain active even when changing other options.
+    * Note that your edits and the resulting aperture shape will still show on the BEV and your edits will remain as-drawn even when changing other options.
+==== Removing Edits ====
     * If you need to remove the manual edits for any reason, you may do so by pressing the "Clear Edits" button. Pressing this button will remove __ALL__ manual edits for this aperture.
 ===== Removing an Aperture =====
-   * If you wish to remove the aperture from this beam, simply press the "Remove Aperture" button at the bottom of the Aperture Task Block
+   * If you wish to remove the aperture from this beam, simply press the "Remove Aperture" button at the bottom of the Aperture Task Block to completely remove it.