Differences

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

--- dosimetry:userguide:radiotherapy_support_functions:rsf [2015/07/02 15:47] – [Geometric Primitives] dpatenaude
+++ dosimetry:userguide:radiotherapy_support_functions:rsf [2021/07/29 18:28] (current) – external edit 127.0.0.1
@@ Line 5: / Line 5: @@
 ===== Image Processing =====
-Below is a list of some common image processing functions and a brief explanation of their intended usage (Specific details of each function, argument parameters, and return values are provided at the [[http://docs.dosimetry.dotdecimal.com|Dosimetry App Manifest Guide]]).
+Below is a list of some common image processing functions and a brief explanation of their intended usage (Specific details of each function, argument parameters, and return values are provided at the [[http://docs.apps.dotdecimal.com|Dosimetry App Manifest Guide]]).
   * **override_image_inside_structure:**
@@ Line 36: / Line 36: @@
 ===== Contour Modification =====
-Below is a list of some common polygon and polyset functions and a brief explanation of their intended usage (Specific details of each function, argument parameters, and return values are provided at the [[http://docs.dosimetry.dotdecimal.com|Dosimetry App Manifest Guide]]).
+Below is a list of some common polygon and polyset functions and a brief explanation of their intended usage (Specific details of each function, argument parameters, and return values are provided at the [[http://docs.apps.dotdecimal.com|Dosimetry App Manifest Guide]]).
   * **polygon_centroid:**
@@ Line 58: / Line 58: @@
 ===== Structure Modification =====
-Below is a list of some common structure manipulation functions and a brief explanation of their intended usage (Specific details of each function, argument parameters, and return values are provided at the [[http://docs.dosimetry.dotdecimal.com|Dosimetry App Manifest Guide]]).
+Below is a list of some common structure manipulation functions and a brief explanation of their intended usage (Specific details of each function, argument parameters, and return values are provided at the [[http://docs.apps.dotdecimal.com|Dosimetry App Manifest Guide]]).
   * **structure_combination:**
@@ Line 72: / Line 72: @@
 ===== Geometric Primitives =====
-Below is a list of some common creation functions for geometric primitives and a brief explanation of their intended usage (Specific details of each function, argument parameters, and return values are provided at the [[http://docs.dosimetry.dotdecimal.com|Dosimetry App Manifest Guide]]).
+Below is a list of some common creation functions for geometric primitives and a brief explanation of their intended usage (Specific details of each function, argument parameters, and return values are provided at the [[http://docs.apps.dotdecimal.com|Dosimetry App Manifest Guide]]).
   * **make_cube:**
@@ Line 95: / Line 95: @@
 ===== Degrader Manipulation =====
-Below is a list of some common degrader manipulation functions and a brief explanation of their intended usage (Specific details of each function, argument parameters, and return values are provided at the [[http://docs.dosimetry.dotdecimal.com|Dosimetry App Manifest Guide]]).
+Below is a list of some common degrader manipulation functions and a brief explanation of their intended usage (Specific details of each function, argument parameters, and return values are provided at the [[http://docs.apps.dotdecimal.com|Dosimetry App Manifest Guide]]).
   * **make_block:**
@@ Line 113: / Line 113: @@
 By changing the input (shape, image, etc) passed into the the degrader make functions, the resulting degrader can be manipulated as desired.
+===== PBS Energy Layers =====
+Below is a list of some common functions that are helpful to compute appropriate machine deliverable energy layers and settings for PBS beams and a brief explanation of their intended usage (Specific details of each function, argument parameters, and return values are provided at the [[http://docs.apps.dotdecimal.com|Dosimetry App Manifest Guide]]).
+  * **compute_range_extents_from_structure_geometry:**
+    * Computes the minimum and maximum radiological path length necessary to reach the provided target for the a proton beam
+  * **create_pbs_layer_list:**
+    * Creates a vector of machine deliverable energy layers (that contain no spots) that cover the specified range extents and are spaced according to the specified spacing strategy
+  * **create_pbs_layers_for_target:**
+    * Computes a list of deliverable layers and spots that will fill the given target structure plus the nearby area as specified by the given margins and spot & layer spacing strategies
+  * **create_pbs_layers_from_spots:**
+    * Converts a list of spots to deliverable calculation layers according to the provided machine definition; an error will be thrown if the provided spot list contains undeliverable spot energies
 ----