planning:userguide:userguide
Differences
This shows you the differences between two versions of the page.
planning:userguide:userguide [2017/10/24 20:02] – [Initial Setup] kerhart | planning:userguide:userguide [2021/07/29 18:24] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 30: | Line 30: | ||
Once Astroid has been purchased, Astroid staff will assist with beam model creation, software installation, | Once Astroid has been purchased, Astroid staff will assist with beam model creation, software installation, | ||
- | == Installation == | + | === 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: | 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: | ||
- | == Site Settings and Defaults == | + | === 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:// | 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:// | ||
Line 47: | Line 47: | ||
- Lock the site_info RKS record using the Thinknode [[https:// | - Lock the site_info RKS record using the Thinknode [[https:// | ||
- | == Site Facility Model == | + | === Site Facility Model === |
The [[planning: | The [[planning: | ||
Line 63: | Line 63: | ||
* [[planning: | * [[planning: | ||
- | * [[planning: | + | * [[planning: |
* [[planning: | * [[planning: | ||
* [[planning: | * [[planning: | ||
Line 70: | Line 70: | ||
* [[planning: | * [[planning: | ||
* [[planning: | * [[planning: | ||
- | * [[planning: | + | * [[planning: |
* [[planning: | * [[planning: | ||
- | | + | |
- | * [[planning: | + | * [[planning: |
- | * [[planning: | + | * [[planning: |
- | * [[planning: | + | * [[planning: |
* [[planning: | * [[planning: | ||
+ | * [[planning: | ||
* [[planning: | * [[planning: | ||
* [[planning: | * [[planning: | ||
* [[planning: | * [[planning: | ||
+ | * [[planning: | ||
+ | * [[planning: | ||
* [[planning: | * [[planning: | ||
* [[planning: | * [[planning: | ||
+ | * [[planning: | ||
+ | * [[planning: | ||
/* | /* | ||
- | | + | |
* [[planning: | * [[planning: | ||
*/ | */ | ||
Line 109: | Line 114: | ||
=== General === | === General === | ||
- | - The Astroid | + | - Astroid |
- | - 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 // |
- | - 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 // | + | - 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 " |
+ | * 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 === | === 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. | - 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 === | === Structures === | ||
Line 126: | Line 146: | ||
=== Facility Model === | === 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/ | === Machine/ | ||
Line 132: | 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/ | - 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/ | ||
+ | === SOBP Patch Fields === | ||
- | See [[planning: | + | - For SOBP plans with patch fields, dose overlap at the patch junction may result in a maximum dose that exceeds the limits |
+ | - 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' | ||
- | 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: |
- | The results API is provided to facilitate | + | 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 |
- | The Results API is most frequently used by customers wishing | + | |
- | 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:// | + | {{page> |
- | ==== Example ==== | + | |
- | In the [[https:// | ||
- | In this particular example | + | Please refer to the [[planning: |
---- | ---- | ||
- | <WRAP center 10%>// | ||
- | <WRAP center | + | <WRAP center |
planning/userguide/userguide.1508875337.txt.gz · Last modified: 2021/07/29 18:22 (external edit)