decimal App Documentation

User Tools

Site Tools

Trace: • rn-30 • decimallauncher • pdotd • instructions_for_use • userguide • it_troubleshooting
electronrt:userguide:userguide

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
electronrt:userguide:userguide [2021/04/28 18:19] – [Approved Plans] dpatenaudeelectronrt:userguide:userguide [2023/03/09 20:59] (current) – [General] dpatenaude
Line 34: Line 34:
  
 The main high level requirements for using the decimal Launcher and decimal eRT application are: The main high level requirements for using the decimal Launcher and decimal eRT application are:
-  - .decimal Direct (using Auth0) account credentials+  - .decimal Direct account credentials
     - This account needs association with a Site ID (.decimal Customer Account number) that has been licensed for use of the decimal eRT application     - This account needs association with a Site ID (.decimal Customer Account number) that has been licensed for use of the decimal eRT application
     - This account needs specific .decimal Permission for accessing the eRT modules     - This account needs specific .decimal Permission for accessing the eRT modules
Line 54: Line 54:
  
  
-===== Feature/Task Descriptions =====+===== Application Usage =====
  
-The following task descriptions are thorough guides providing complete information about each task within the decimal eRT application.+The following sections are thorough guides providing complete information about each task within the decimal eRT application.
  
   * [[electronrt:userguide:tutorials:all_tutorials#launching_electronrt|Launching decimal eRT]]   * [[electronrt:userguide:tutorials:all_tutorials#launching_electronrt|Launching decimal eRT]]
Line 62: Line 62:
   * [[electronrt:userguide:tutorials:all_tutorials#patient_courses|Patient Courses]]    * [[electronrt:userguide:tutorials:all_tutorials#patient_courses|Patient Courses]] 
   * [[electronrt:userguide:tutorials:all_tutorials#electron_treatment_plans|Electron Plans]]   * [[electronrt:userguide:tutorials:all_tutorials#electron_treatment_plans|Electron Plans]]
 +    * [[electronrt:userguide:tutorials:all_tutorials#prescription|Prescription]]
     * [[electronrt:userguide:tutorials:all_tutorials#patient_geometry|Patient Geometry]]     * [[electronrt:userguide:tutorials:all_tutorials#patient_geometry|Patient Geometry]]
       * [[electronrt:userguide:tutorials:all_tutorials#points|Points]]       * [[electronrt:userguide:tutorials:all_tutorials#points|Points]]
Line 72: Line 73:
       * [[electronrt:userguide:tutorials:all_tutorials#electron_bolus_creation|Electron Bolus Creation]]       * [[electronrt:userguide:tutorials:all_tutorials#electron_bolus_creation|Electron Bolus Creation]]
       * [[electronrt:userguide:tutorials:all_tutorials#intensity_modulator_device|Electron Intensity Modulator]]       * [[electronrt:userguide:tutorials:all_tutorials#intensity_modulator_device|Electron Intensity Modulator]]
 +      * [[electronrt:userguide:tutorials:all_tutorials#electron_beam_normalization|Electron Beam Normalization]]
     * [[electronrt:userguide:tutorials:all_tutorials#plan_approval|Plan Approval]]     * [[electronrt:userguide:tutorials:all_tutorials#plan_approval|Plan Approval]]
     * [[electronrt:userguide:tutorials:all_tutorials#plan_reports|Plan Reports]]     * [[electronrt:userguide:tutorials:all_tutorials#plan_reports|Plan Reports]]
Line 80: Line 82:
   * [[electronrt:userguide:tutorials:all_tutorials#decimal_ert_settings|App Settings]]   * [[electronrt:userguide:tutorials:all_tutorials#decimal_ert_settings|App Settings]]
  
-===== System Usage =====  
  
-==== Improper System Usage ====+ 
 +===== Improper System Usage =====
  
 When using decimal eRT, as with any complex program, there is the potential for misuse. The decimal eRT app is a radiotherapy treatment planning tool that is intended to be used by experienced and knowledgeable professionals working in the field of radiation therapy. When using decimal eRT, as with any complex program, there is the potential for misuse. The decimal eRT app is a radiotherapy treatment planning tool that is intended to be used by experienced and knowledgeable professionals working in the field of radiation therapy.
Line 93: Line 95:
  
 ^ ID  ^ Affected Version(s)  ^  Description   ^ ^ ID  ^ Affected Version(s)  ^  Description   ^
-|  1  | All                  | decimal eRT does not show the MU value for beams and treatment plans. | +|  1  | 0.0.1\\ 0.0.2\\ 0.0.3\\ 0.0.4| decimal eRT does not show the MU value for beams and treatment plans. | 
-|  2  | All                  | Simultaneous record access:<WRAP>+|  2  | All                          | Simultaneous record access:<WRAP>
   * If multiple instances of the application have the same treatment plan record opened, changes will be prevented from being pushed to the patient database if the treatment plan is changed first by another user. This will cause the other simultaneous instances to become outdated. Changes to the local application on outdated instances will be blocked from pushing plan changes to the patient database, but the changes may still appear to have happened in the local application. Users will be warned of their changes being blocked by the error: ''“Plan revision is outdated. Please close and reopen the treatment plan to continue using this plan."''   * If multiple instances of the application have the same treatment plan record opened, changes will be prevented from being pushed to the patient database if the treatment plan is changed first by another user. This will cause the other simultaneous instances to become outdated. Changes to the local application on outdated instances will be blocked from pushing plan changes to the patient database, but the changes may still appear to have happened in the local application. Users will be warned of their changes being blocked by the error: ''“Plan revision is outdated. Please close and reopen the treatment plan to continue using this plan."''
 +</WRAP>|
 +|  3  | All                          | Random Application Crashes:<WRAP>
 +  * If the [[electronrt:instructions_for_use:instructions_for_use#network_local_data_cache|local or network disk cache]] becomes corrupted the application may crash at seemingly random places while calculations are computing. Clearing the [[electronrt:userguide:tutorials:all_tutorials#local_disk_cache|local disk cache]] within the application settings may help resolve unreproducible application crashes during calculations running.
 +</WRAP>|
 +|  4  | All                          | Network patient database:<WRAP>
 +  * If the application is set to use a [[electronrt:instructions_for_use:instructions_for_use#patient_database_file_storage|network patient directory]] shared with multiple users there may be a risk for 'database is locked' errors. This is due to the application using SQLite as it's database engine, which does not robustly support concurrent database users and reading/writing. While normal usage between one or two users may not pose a problem with this, having a significant number of users simultaneously accessing the network database or the following scenarios can cause the database to lock and throw this error:
 +    * The application crashes or a network connection is interrupted during a SQL commit that allows the 'unlock' step to be missed OR
 +    * The file is locked due to other network usage (e.g.: the file is in use by an external service such as an Antivirus scan, backup, etc) OR
 +    * Multiple simultaneous users are attempting to read/write to the database at the same time
 +  * If you receive the error "database is locked" you'll have to wait and try again once the database is unlocked
 +</WRAP>|
 +|  5  | All                          | Application fails to load computed data: Under the following scenario, the application request and state handling has a known bug that results in computed data not loading within the application until a application close and re-open is performed:<WRAP>
 +  * A patient/plan is opened and a user interface or task is opened
 +  * Data begins computing (e.g.: a dose, beam, or device)
 +  * While the data is computing the user navigates to another user interface within the application
 +  * If the data finishes computing for the first user interface while the user is navigated to a new user interface and then the user navigates back to the first user interface, the application may not know the data is computed to display or use the results.
 </WRAP>| </WRAP>|
 ==== DICOM Import ==== ==== DICOM Import ====
Line 101: Line 119:
 ^ ID  ^ Affected Version(s)  ^  Description   ^ ^ ID  ^ Affected Version(s)  ^  Description   ^
 | 1 | All                  | Closing the application immediately after importing a DICOM patient and before the job 'copy_imported_dicom_files_to_course' completes will cause an incomplete CT Image Set when exporting DICOM later in the application. | | 1 | All                  | Closing the application immediately after importing a DICOM patient and before the job 'copy_imported_dicom_files_to_course' completes will cause an incomplete CT Image Set when exporting DICOM later in the application. |
 +| 2 | 0.9.0                | Only plan files with a valid bolus in at least one beam will import properly. |
  
 ==== DICOM Export ==== ==== DICOM Export ====
Line 113: Line 132:
 | 3  | 0.0.3+               | Skin collimator devices may cause interference with fitting inside of the electron bolus when fitting on the patient surface. This is due to sharp corners that result from a rough patient surface contour.| | 3  | 0.0.3+               | Skin collimator devices may cause interference with fitting inside of the electron bolus when fitting on the patient surface. This is due to sharp corners that result from a rough patient surface contour.|
  
-==== Approved Plans ====+==== Plans ====
 ^ ID ^ Affected Version(s)  ^  Description   ^ ^ ID ^ Affected Version(s)  ^  Description   ^
-| 1  | All                  | Users should understand that the eRT application stores only user input information and not computed data. However, since machine models and dose calculation algorithms can change over time, certain calculated data and equipment model data that is considered critical to the patient's treatment record is stored with each plan upon approval. This stored data includes: treatment device shapes (e.g. bolus, collimators, intensity modulators), 3D dose fields per beam, and beam model data. However, it should be noted that data derived from these stored results may be recomputed and is therefore subject to change if Approved Plans are loaded in future eRT versions. One such example would be DVH curves. While the dose is stored and will never change for an Approved Plan, the sampling scheme used in DVH calculations can change over time, therefore DVH curves may change even for Approved Plans if such changes are made in the eRT application. Patient-to-applicator collisions, structure volumes, and QA Dose Calculations are additional examples of information that could change in future application versions as this data remains computed, not stored, even for Approved Plans. | +| 1  | All                  | (Approved Plans) Users should understand that the eRT application stores only user input information and not computed data. However, since machine models and dose calculation algorithms can change over time, certain calculated data and equipment model data that is considered critical to the patient's treatment record is stored with each plan upon approval. This stored data includes: treatment device shapes (e.g. bolus, collimators, intensity modulators), 3D dose fields per beam, and beam model data. However, it should be noted that data derived from these stored results may be recomputed and is therefore subject to change if Approved Plans are loaded in future eRT versions. One such example would be DVH curves. While the dose is stored and will never change for an Approved Plan, the sampling scheme used in DVH calculations can change over time, therefore DVH curves may change even for Approved Plans if such changes are made in the eRT application. Patient-to-applicator collisions, structure volumes, and QA Dose Calculations are additional examples of information that could change in future application versions as this data remains computed, not stored, even for Approved Plans. | 
-| 2  | 0.0.4+               | Treatment plans approved in versions earlier than eRT version 0.0.4 will not have the plan prescription filled in (denoted by the error: ''"Prescription statement not found in plan"'') resulting in dose not being displayed within the treatment plan displays. Users can resolve this by cloning, adding in the new plan prescription, and re-approving pre-existing approved plans. |+| 2  | 0.0.1 - 0.0.4               | (Unapproved Plans) Unapproved treatment plans created versions earlier than eRT version 0.0.4 will not have the plan prescription filled in (denoted by the error: ''"Prescription statement not found in plan"'') resulting in dose not being displayed within the treatment plan displays. Users can resolve this by re-adding the prescription that previously existed in the corresponding Course. | 
 +| 3  | 0.0.1 - 0.7.0               | (Approved Plans) Approved treatment plans created versions earlier than eRT version 0.8.0 that contain a skin collimator will no longer be able to load the approved skin collimator when opening the plan. Users will be required to clone the approved plan and re-approve the plan to allow the skin collimator devices to be exported or ordered.|
  
  
electronrt/userguide/userguide.1619633991.txt.gz · Last modified: 2021/07/29 18:22 (external edit)