Differences

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

--- planning:userguide:userguide [2018/08/16 17:06] – [Results API] dpatenaude
+++ planning:userguide:userguide [2021/07/29 18:24] (current) – external edit 127.0.0.1
@@ Line 63: / Line 63: @@
   * [[planning:userguide:tutorials:all_tutorials#launching_astroid|Launching the Astroid Planning App]]
-  * [[planning:userguide:tutorials:all_tutorials#uploading_a_dicom_patient|Uploading a DICOM Patient]]
+  * [[planning:userguide:tutorials:all_tutorials#uploading_dicom_patient_files|Uploading DICOM Patient Files]]
   * [[planning:userguide:tutorials:all_tutorials#importing_patient_data|Importing Patient Data]]
   * [[planning:userguide:tutorials:all_tutorials#courses|Courses, Intents, and Directives]]
@@ Line 70: / Line 70: @@
     * [[planning:userguide:tutorials:all_tutorials#structures|Structures]]
     * [[planning:userguide:tutorials:all_tutorials#dose_grid|Dose Grid]]
-    * [[planning:userguide:tutorials:all_tutorials#creating_a_pbs_beam|PBS Beams]]
+    * [[planning:userguide:tutorials:all_tutorials#proton_beams|Proton Beams]]
       * [[planning:userguide:tutorials:all_tutorials#creating_an_aperture|Defining an Aperture]]
-    * [[planning:userguide:tutorials:all_tutorials#fraction_groups|Fraction Groups]]
+      * [[planning:userguide:tutorials:all_tutorials#creating_a_range_compensator|Defining a Range Compensator]]
-    * [[planning:userguide:tutorials:all_tutorials#optimization_constraints|Defining Constraints]]
+    * [[planning:userguide:tutorials:all_tutorials#astroid_optimization_pbs|Astroid Optimization]] (PBS)
-    * [[planning:userguide:tutorials:all_tutorials#optimization_objectives|Setting Objectives]]
+      * [[planning:userguide:tutorials:all_tutorials#pbs_fraction_groups|PBS Fraction Groups]]
-    * [[planning:userguide:tutorials:all_tutorials#astroid_optimization|Astroid Optimization]]
+      * [[planning:userguide:tutorials:all_tutorials#optimization_constraints|Defining Constraints]]
       * [[planning:userguide:tutorials:all_tutorials#feasibility_and_constraints|Feasibility & Constraints]]
+      * [[planning:userguide:tutorials:all_tutorials##optimization_objectives|Setting Objectives]]
       * [[planning:userguide:tutorials:all_tutorials#running_the_optimizer|Running the Optimizer]]
       * [[planning:userguide:tutorials:all_tutorials#dose_normalization_and_display|Dose Normalization]]
       * [[planning:userguide:tutorials:all_tutorials#navigating_the_solutions|Navigating the Solutions]]
+    * [[planning:userguide:tutorials:all_tutorials#beam_delivery_sobp|Beam Delivery]] (SOBP)
+      * [[planning:userguide:tutorials:all_tutorials#sobp_fraction_groups|SOBP Fraction Groups]]
     * [[planning:userguide:tutorials:all_tutorials#plan_history|Using the Plan History]]
     * [[planning:userguide:tutorials:all_tutorials#plan_publishing|Publishing a Plan]]
+  * [[planning:userguide:tutorials:all_tutorials#plan_templates|Plan Templates]]
+  * [[planning:userguide:tutorials:all_tutorials#plan_export|Exporting a Plan]]
 /*
-    * [[planning:userguide:tutorials:all_tutorials#plan_export|Exporting a Plan]]
     * [[planning:userguide:tutorials:all_tutorials#plan_reports|Generating Plan Reports]]
 */
@@ Line 112: / Line 117: @@
   - If a user's computer is abruptly shut down (e.g. computer crash or power failure) while the Astroid Planning App has a plan open, there is a potential for the user's local data cache index file to become corrupted. If this happens, generally the Planning App will automatically close (crash) whenever the user tries to open the plan that was active at the time of crash. In order to fix this, the user must close the Planning App and delete the entire cache folder. The default directory location for this folder should be C:\Users\All Users\Astroid2\cache. If the location has been changed, the new location can be found within the Planning App from the //View-->Settings// menu.
   - If a user starts a calculation using the calculation status UI (e.g.: feasibility or MCO) and is outside the block the interface is in when the calculation finishes, the status of the calculation will remain "calculating". Manually refreshing data (pressing F5) or re-launching the application resolves this issue.
+    * This issue may also apply to other requests and calculations in the application too
+  - Treatment plans store an optional fluence override vector which will be used instead of the optimization fluence results if present. These overrides must be added via scripts outside the Planning App UI. If an override is present in a plan the Planning App UI becomes mostly read-only to limit the potential for changes that could invalidate the fluence override. However there are no hard stops to ensure that the fluence override vectors are properly sized for the plan at hand, so users must ensure properly sized fluence vectors are set in their scripts.
+=== DICOM Upload ===
+  - The Uploads block must remain open while uploading DICOM files.
+=== DICOM Export ===
+  - Computed treatment plan dose is required prior to users being able to export DICOM files.
+    * Note: Users may still be able to attempt to export DICOM files from the user interface, but may encounter errors if their plan does not have, or is unable to, compute dose.
+  - DICOM Export of CT and SS files searches the RKS for the CT image record, therefore modifying the RKS record of the CT images can cause changes to the exported data even on an approved plan (deleting the record will prevent export of CT and SS altogether)
 === Importing ===
   - When importing a new patient, the default physician will be set from the DICOM file. When this physician selection is changed, either during import or later in the Patient Overview, there is no way to re-select the original from DICOM physician.
+=== Plan Templates ===
+  - Plan templates are unable to be edited and/or removed from within the Planning App without manually manipulating the RKS record.
+  - All referenced and used structures in the original plan template must exist in the new patient model for which the plan template is being used.
 === Structures ===
@@ Line 131: / Line 151: @@
   - Astroid does not detect possible collisions between the patient and snout or the treatment table and snout. It is the users responsibility to ensure that there is enough distance between the patient/table and the snout so as to avoid collisions.
+=== SOBP Patch Fields ===
+  - For SOBP plans with patch fields, dose overlap at the patch junction may result in a maximum dose that exceeds the limits of the isobands and DHV displays
+  - If a patch field is added to an existing thru-beam that's already in a fraction group, the thru-beam must be removed and re-added to the fraction group for the patch field to be included in the fraction group's beam list.
@@ Line 137: / Line 162: @@
 Should you discover or suspect any additional errors or limitations not noted above, please alert the .decimal Astroid Planning App development team by providing creating a ticket at dotdecimal.freshdesk.com including details of your concerns and steps to reproduce the issue. All concerns will be addressed as quickly as possible and follow up with the submitter will occur throughout the inquiry and correction process.
-===== Results API =====
-{{page>planning:userguide:resultsapi#Planning App ResultsAPI&noheader&firstseconly&noreadmore&nofooter}}
+===== ResultsAPI =====
+{{page>planning:userguide:results_api#Planning App ResultsAPI&noheader&firstseconly&noreadmore&nofooter}}
-Please refer to the [[planning:userguide:resultsapi|Planning App ResultsAPI Guide]] for a more detailed look at explanation, usages, and examples of the Planning App ResultsAPI.
+Please refer to the [[planning:userguide:results_api|Planning App ResultsAPI Guide]] for a more detailed look at explanation, usages, and examples of the Planning App ResultsAPI.