Differences

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

--- electronrt:userguide:tutorials:plan_reports [2020/07/20 15:45] – dpatenaude
+++ electronrt:userguide:tutorials:plan_reports [2021/07/29 18:28] (current) – external edit 127.0.0.1
@@ Line 3: / Line 3: @@
 The ElectronRT App allows PDF export of treatment plan reports. Treatment plan reports include all patient, plan, and beam data and can optionally include screen shots taken in the application.
-{{ :electronrt:userguide:tutorials:plan_report-overview.png?direct |}}
+**Note:** The Export block will be disabled if no machine or CT curve exists in the site configuration.
+<imgcaption report_overview|Plan Report UI>{{ :electronrt:userguide:tutorials:plan_report-overview.png?direct |}}</imgcaption>
 ===== Report Customization =====
-The ElectronRT App provides options for customizing the exported plan report including: customizing the header logo and setting the different options for details that will appear on the report.
+The ElectronRT App provides options for customizing the exported plan report including: customizing the header logo and setting the different options for details that will appear in the report.
 ==== Header Logo ====
-By default the header logo is set to the logo of the application. The header logo can be optionally overridden by the user in the Organization Configuration block. For more information please see <link to site config wiki> FIXME.
+By default, the header logo is set to the logo of the application. The header logo can be optionally overridden by the user in the Organization Configuration block. For more information please refer to the [[:electronrt:userguide:tutorials:all_tutorials#organization_settings| Organization Settings]].
-{{ :electronrt:userguide:tutorials:plan_report-customization.png?direct&400 |}}
+The header will be placed as shown in <imgref custom_header>. The header image is not scaled and is placed on the report at its native size.
-==== Report Content ====
+<imgcaption custom_header|Custom Header>{{ :electronrt:userguide:tutorials:plan_report-customization.png?direct&400 |}}</imgcaption>
-By default plan reports will contain all plan information currently present in the treatment plan. Users can optionally chose to not export specific content to the treatment plan report including: dose reference points, density overrides, beams, or ordered hardware information.
+=== Recommended Size ===
-=== Coordinate System (Equipment & IEC) ===
+Since the custom header image is not scaled when placed into the report, it's recommended to use a size that does not interfere with the report contents or reduce the readability of the report.
-By default the treatment plan report will export beam geometry information in the equipment coordinate system. Users can optionally chose to export beam coordinates using the IEC coordinate system as specified in the Machine Configuration. This option is provided as a checkbox in the Report Content Options section.
+As such, the recommended image size for a custom header logo is:
+  * **Width:** 200 to 500 pixels
+  * **Height:** 40 to 75 pixels
-For more information on setting the IEC coordinate systems please see <link to site config wiki> FIXME.
+Larger sized images may still render correctly on the report as long as they fit a standard portrait letter size, but are not recommended since they may impact readability of the report. Images larger than the PDF page may have the image cropped to fit on a single page.
 ==== Screen Shots ====
@@ Line 29: / Line 33: @@
 Users are able to take screen shots to include on their treatment plan report. Screen shots will include the entire display UI including all CT, Dose, 3D, BEV, and statistics views. Once a screen shot has been captured it will appear on the exported treatment plan report
-{{ :electronrt:userguide:tutorials:plan_report-screenshots.png?direct |}}
+<imgcaption report_screenshots|Report Screenshots>{{ :electronrt:userguide:tutorials:plan_report-screenshots.png?direct |}}</imgcaption>
-After specifying a name for the screenshot the application will allow the user to capture the current display and save the screen shot for the plan report.
+After specifying a name for the screenshot, the application will allow the user to capture the current display and save the screen shot for the plan report.
 === Managing Screen Shots ===
@@ Line 38: / Line 42: @@
   * **Preview/View:** You can view the captured screen shot by selecting the screenshot in the list of saved captures
   * **Delete:** You can remove a captured screenshot so that it is no longer exported to the treatment plan report by selecting the 'X' icon next to the screenshot name.
+==== Report Content ====
+By default, plan reports will contain all plan information currently present in the treatment plan. Users can optionally choose to not export specific content to the treatment plan report including: dose reference points, density overrides, beams, or ordered hardware information.
+=== Coordinate System (Equipment & IEC) ===
+By default, the treatment plan report will export beam geometry information in the equipment coordinate system. Users can optionally choose to export beam coordinates using the IEC coordinate system as specified in the Machine Configuration. This option is provided as a checkbox in the Report Content Options section.
+The selected coordinate system option will be displayed on the treatment plan report as either "Equipment" or "IEC" as shown in the <imgref report_coordinate_system> below.
+<imgcaption report_coordinate_system|Report Coordinate System>{{ :electronrt:userguide:tutorials:plan_report-coordinatesystem.png?direct&400 |}}</imgcaption>
+For more information on setting the IEC coordinate systems please refer to the [[:electronrt:userguide:tutorials:all_tutorials#machine_settings| Machine Geometry Settings]].