Differences

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

--- planning:userguide:userguide [2017/10/17 15:43] – Added USR-005 tag dpatenaude
+++ planning:userguide:userguide [2021/07/29 18:24] (current) – external edit 127.0.0.1
@@ Line 20: / Line 20: @@
     * [[planning:instructions_for_use:instructions_for_use#product_features|Product Features]]
     * [[planning:instructions_for_use:instructions_for_use#Data Model|Data Model]]
 ==== Precautions ====
@@ Line 29: / Line 30: @@
 Once Astroid has been purchased, Astroid staff will assist with beam model creation, software installation, and user training. Users will be generally be trained at two separate levels, system administrators and end users. System administrators will be setup with appropriate access and tools for managing software including both the local and cloud resources. End users will be primarily trained on the details of generating high-quality treatment plans using the local client portion of the application suite. The beam modeling and equipment setup processes are explained more fully in the [[http://apps.dotdecimal.com/doku.php?id=dosimetry:commissioning_guide:commissioning_guide|Dosimetry App Commissioning Guide]].
-== Site Settings and Defaults ==
+=== Installation ===
+The Astroid Planning App includes both a local User Client and a cloud-based calculation provider, therefore, there are specific requirements on computers in which the local client application can be installed. Please see the [[planning:userguide:systemrequirements|System Requirements]] page for details.
+=== Site Settings and Defaults ===
 The astroid Planning App provides a RKS record for specifying site level configurations and defaults. The RKS entry exists at the root level of the realm for which the app is installed. The record holds a site_info, whose definition can be viewed at the [[http://docs.apps.dotdecimal.com/|astroid Manifest Documentation site]]. An empty {{ :planning:userguide:sample_site_info.json | sample json version}} of the site_info is provided.
@@ Line 42: / Line 47: @@
   - Lock the site_info RKS record using the Thinknode [[https://developers.thinknode.com/services/rks/entries| PUT /rks/:id/lock]] route to prevent unrestricted changes.
-== Site Facility Model ==
+=== Site Facility Model ===
 The [[planning:userguide:userguide#site_settings_and_defaults|site_info]] for the astroid Planning App references the [[http://apps.dotdecimal.com/doku.php?id=dosimetry:commissioning_guide:commissioning_guide#data_requirements|astroid Dosimetry App machine model]]. This model must be posted and referenced from within the site_info rks record.
@@ Line 58: / 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 65: / 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 104: / Line 114: @@
 === General ===
-  - The Astroid Planning App is pre-510(k) at this time and has not been validated for use in actual patient treatments
+  - Astroid uses DICOM patient space coordinates for all slice and 3D views and IEC 61217 coordinate systems for BEV (other options, such as machine based coordinate systems are NOT available at this time)
-  - Astroid uses only IEC 61217 coordinate systems (i.e. machine based coordinate systems are NOT available at this time)
+  - 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'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\(username)\.launcher\(thinknode domain)\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 121: / Line 146: @@
 === Facility Model ===
-  - When multiple machines are defined in the facility model each room must have a unique name within the entire facility model. The treatment_plan references a treatment_room by it's name and assumes this name will only exist one time in the facility model.\
+  - When multiple machines are defined in the facility model each room must have a unique name within the entire facility model. The treatment_plan references a treatment_room by it's name and assumes this name will only exist one time in the facility model.
 === Machine/Patient Collision ===
@@ Line 127: / Line 152: @@
   - 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 ===
-See [[planning:userguide:errors|Thinknode Errors]] for common problems that can occur during usage of the Planning app.
+  - 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.
-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 =====
+See [[planning:userguide:errors|Thinknode Errors]] for common problems that can occur during usage of the Planning app.
-The results API is provided to facilitate a controlled and consistent means for accessing necessary treatment plan details and information.
+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.
-The Results API is most frequently used by customers wishing to develop custom treatment plan reports for clinical patients. From the results API treatment plan data can be accessed, including (but not limited to): patient geometries, prescriptions, beam information, spot placements, and plan dose results. It should be pointed out that when users generate custom plan reports they must include an indication of the coordinate system in which any position information is being displayed and users should be reminded that all Results API position data is provided in IEC 61217 coordinate systems at this time.
-Most Planning Results API functions must be called using Thinknode meta requests. Because of this added complexity, an example function call has been added for end user convenience.
-==== Available Functions ====
+===== ResultsAPI =====
-For a comprehensive list of available Planning Results API functions, please refer to the [[http://docs.apps.dotdecimal.com/planning_results_api/|Results API Function List]].
+{{page>planning:userguide:results_api#Planning App ResultsAPI&noheader&firstseconly&noreadmore&nofooter}}
-==== Example ====
-In the [[https://github.com/dotdecimal/astroid-script-library|.decimal astroid-script-library]] there is a script called //planning_results_api_example.py// that provides a basic example in calling and accessing the results API meta functions.
-In this particular example the //generate_plan_summary_request// is the API function being called by the generator and meta function as this is a common function to use in extracting data for use in generating treatment plan reports.
+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.
 ----
-<WRAP center 10%>//USR-005//</WRAP>
-<WRAP center 50%>.decimal LLC, 121 Central Park Place, Sanford, FL. 32771</WRAP>
+<WRAP center 60%>.decimal LLC, 121 Central Park Place Sanford, FL. 32771 1-800-255-1613</WRAP>