dosimetry:userguide:radiotherapy_support_functions:rsf
Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
dosimetry:userguide:radiotherapy_support_functions:rsf [2015/07/02 15:36] – created 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 ===== | ===== 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:// | + | 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:// |
* **override_image_inside_structure: | * **override_image_inside_structure: | ||
Line 33: | Line 33: | ||
* Where N is the size of the image | * Where N is the size of the image | ||
* Create an image of uniform pixel values (e.g. water phantom) over a grid of dimension N | * Create an image of uniform pixel values (e.g. water phantom) over a grid of dimension N | ||
- | * See [[userguide: | + | * See [[dosimetry:userguide: |
===== Contour Modification ===== | ===== 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:// | + | 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:// |
* **polygon_centroid: | * **polygon_centroid: | ||
Line 58: | Line 58: | ||
===== Structure Modification ===== | ===== 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:// | + | 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:// |
* **structure_combination: | * **structure_combination: | ||
Line 72: | Line 72: | ||
===== Geometric Primitives ===== | ===== 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:// | + | 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:// |
* **make_cube: | * **make_cube: | ||
* Creates a triangle mesh representing a 3D box | * Creates a triangle mesh representing a 3D box | ||
- | * See [[userguide: | + | * See [[dosimetry:userguide: |
* **make_cylinder: | * **make_cylinder: | ||
* Creates a triangle mesh representing an axis aligned, right 3D cylinder | * Creates a triangle mesh representing an axis aligned, right 3D cylinder | ||
Line 95: | Line 95: | ||
===== Degrader Manipulation ===== | ===== 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:// | + | 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:// |
* **make_block: | * **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. | 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:// | ||
+ | |||
+ | * **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 | ||
---- | ---- |
dosimetry/userguide/radiotherapy_support_functions/rsf.1435851387.txt.gz · Last modified: 2021/07/29 18:24 (external edit)