planning:userguide:userguide
Differences
This shows you the differences between two versions of the page.
planning:userguide:userguide [2017/08/10 16:50] – [Getting Started] kerhart | planning:userguide:userguide [2021/07/29 18:24] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 11: | Line 11: | ||
===== Getting Started ===== | ===== Getting Started ===== | ||
- | The [[planning: | + | Proper use of this software is critical to safe and effective treatment of patients using plans generated by this application. Users are expected to read and understand this complete User Guide including the [[planning: |
- | * **[[planning: | + | * **[[planning: |
- | * **[[planning: | + | * [[planning: |
- | * **[[planning: | + | * [[planning: |
- | * **[[planning: | + | * [[planning: |
- | * **[[planning: | + | * [[planning: |
- | * **[[planning: | + | * [[planning: |
- | * **[[planning: | + | * [[planning: |
- | | + | * [[planning: |
- | - [[planning: | + | |
- | - [[planning: | + | |
- | - [[planning: | + | |
- | - [[planning: | + | |
- | - [[planning: | + | |
- | * **[[planning: | + | |
==== Precautions ==== | ==== Precautions ==== | ||
It is the responsibility of those utilizing this application to ensure all that all usages of this product relating to patient treatments are performed by trained and qualified personnel only and that such personnel is aware that the quality of any generated treatment plans is highly dependent on the quality and correctness of the input data; therefore if any questions or uncertainties exist regarding the quality, units, or identification of input data arise, they must be investigated and resolved before the data are used. | It is the responsibility of those utilizing this application to ensure all that all usages of this product relating to patient treatments are performed by trained and qualified personnel only and that such personnel is aware that the quality of any generated treatment plans is highly dependent on the quality and correctness of the input data; therefore if any questions or uncertainties exist regarding the quality, units, or identification of input data arise, they must be investigated and resolved before the data are used. | ||
+ | |||
+ | ==== Initial Setup ==== | ||
+ | |||
+ | Once Astroid has been purchased, Astroid staff will assist with beam model creation, software 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: | ||
+ | |||
+ | === 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:// | ||
+ | |||
+ | To update the site_info RKS record, perform the following steps. Note: you must have Thinknode //" | ||
+ | - Using the Thinknode Client or manual [[https:// | ||
+ | - Find, or create if it's missing, the RKS record named " | ||
+ | - Unlock the site_info RKS record using the Thinknode [[https:// | ||
+ | - Edit the site_info by either: | ||
+ | - Editing in place the site_info data using the Thinknode Client or | ||
+ | - Post new site_info data as an immutable object and update the Reference ID for the RKS entry | ||
+ | - Lock the site_info RKS record using the Thinknode [[https:// | ||
+ | |||
+ | === Site Facility Model === | ||
+ | |||
+ | The [[planning: | ||
+ | |||
+ | |||
==== Keyboard and Mouse Controls ==== | ==== Keyboard and Mouse Controls ==== | ||
Line 41: | Line 63: | ||
* [[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: | ||
* [[planning: | * [[planning: | ||
+ | * [[planning: | ||
+ | * [[planning: | ||
* [[planning: | * [[planning: | ||
* [[planning: | * [[planning: | ||
+ | * [[planning: | ||
+ | * [[planning: | ||
/* | /* | ||
- | | + | |
* [[planning: | * [[planning: | ||
*/ | */ | ||
Line 85: | Line 112: | ||
Below are listed the known application limitations, | Below are listed the known application limitations, | ||
- | | + | === General === |
+ | |||
+ | | ||
+ | - 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 | ||
+ | - 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 | ||
+ | |||
+ | === 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 === | ||
- When changing a structure type from a TARGET, whether at the Patient Model or Plan level, if that structure was an existing optimization constraint or objective with maximize options selected, those options will continue to be selected and will unable to be changed in the UI. They can be viewed in the optimization constraint and objective summaries, but will not be editable unless the structure type is changed back to TARGET. | - When changing a structure type from a TARGET, whether at the Patient Model or Plan level, if that structure was an existing optimization constraint or objective with maximize options selected, those options will continue to be selected and will unable to be changed in the UI. They can be viewed in the optimization constraint and objective summaries, but will not be editable unless the structure type is changed back to TARGET. | ||
- This can result in you having constraints or objectives that might not be ideal for this type of structure. Always double check the constraint/ | - This can result in you having constraints or objectives that might not be ideal for this type of structure. Always double check the constraint/ | ||
- | - 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. | ||
- Structures that are expanded in the axis of the CT image slices will have the expansion distance limited by the CT image spacing. So the expansion distance may appear to be an incorrect distance. | - Structures that are expanded in the axis of the CT image slices will have the expansion distance limited by the CT image spacing. So the expansion distance may appear to be an incorrect distance. | ||
- When creating a new target for a PBS beam via the Create subtask from the Geometric Target drop down, you are able to create a non target structure and have it be selected in this drop down. This is only possible when the Create subtask automatically populates the dropdown upon finishing, and you will not be able to select this target manually if you change the selection. | - When creating a new target for a PBS beam via the Create subtask from the Geometric Target drop down, you are able to create a non target structure and have it be selected in this drop down. This is only possible when the Create subtask automatically populates the dropdown upon finishing, and you will not be able to select this target manually if you change the selection. | ||
- | - Astroid uses only IEC 61217 coordinate systems (i.e. machine based coordinate systems are NOT available at this time) | ||
- | See [[planning: | + | === 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/ | ||
+ | |||
+ | - Astroid does not detect possible collisions between the patient and snout or the treatment table and snout. It is the users responsibility to ensure | ||
+ | |||
+ | === 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 | ||
+ | - 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 contact the .decimal Astroid Planning App development lead, Kevin Erhart, at kerhart@dotdecimal.com with details of your concerns. 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 | + | <WRAP center |
planning/userguide/userguide.1502383811.txt.gz · Last modified: 2021/07/29 18:22 (external edit)