diff --git a/docs/_static/favicon_hat/android-chrome-192x192.png b/docs/_static/favicon_hat/android-chrome-192x192.png new file mode 100644 index 000000000..ec91eaed5 Binary files /dev/null and b/docs/_static/favicon_hat/android-chrome-192x192.png differ diff --git a/docs/_static/favicon_hat/android-chrome-512x512.png b/docs/_static/favicon_hat/android-chrome-512x512.png new file mode 100644 index 000000000..dbc0dee3e Binary files /dev/null and b/docs/_static/favicon_hat/android-chrome-512x512.png differ diff --git a/docs/_static/favicon_hat/apple-touch-icon.png b/docs/_static/favicon_hat/apple-touch-icon.png new file mode 100644 index 000000000..b3b9a4718 Binary files /dev/null and b/docs/_static/favicon_hat/apple-touch-icon.png differ diff --git a/docs/_static/favicon_hat/favicon-16x16.png b/docs/_static/favicon_hat/favicon-16x16.png new file mode 100644 index 000000000..75a8c03c6 Binary files /dev/null and b/docs/_static/favicon_hat/favicon-16x16.png differ diff --git a/docs/_static/favicon_hat/favicon-32x32.png b/docs/_static/favicon_hat/favicon-32x32.png new file mode 100644 index 000000000..0a2ec07e6 Binary files /dev/null and b/docs/_static/favicon_hat/favicon-32x32.png differ diff --git a/docs/_static/favicon_hat/favicon.ico b/docs/_static/favicon_hat/favicon.ico new file mode 100644 index 000000000..f547bb768 Binary files /dev/null and b/docs/_static/favicon_hat/favicon.ico differ diff --git a/docs/_static/favicon_hat/site.webmanifest b/docs/_static/favicon_hat/site.webmanifest new file mode 100644 index 000000000..45dc8a206 --- /dev/null +++ b/docs/_static/favicon_hat/site.webmanifest @@ -0,0 +1 @@ +{"name":"","short_name":"","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"} \ No newline at end of file diff --git a/docs/_static/favicon_mR/android-chrome-192x192.png b/docs/_static/favicon_mR/android-chrome-192x192.png new file mode 100644 index 000000000..58310a88b Binary files /dev/null and b/docs/_static/favicon_mR/android-chrome-192x192.png differ diff --git a/docs/_static/favicon_mR/android-chrome-512x512.png b/docs/_static/favicon_mR/android-chrome-512x512.png new file mode 100644 index 000000000..99a354747 Binary files /dev/null and b/docs/_static/favicon_mR/android-chrome-512x512.png differ diff --git a/docs/_static/favicon_mR/apple-touch-icon.png b/docs/_static/favicon_mR/apple-touch-icon.png new file mode 100644 index 000000000..c2356b736 Binary files /dev/null and b/docs/_static/favicon_mR/apple-touch-icon.png differ diff --git a/docs/_static/favicon_mR/favicon-16x16.png b/docs/_static/favicon_mR/favicon-16x16.png new file mode 100644 index 000000000..ee5e32123 Binary files /dev/null and b/docs/_static/favicon_mR/favicon-16x16.png differ diff --git a/docs/_static/favicon_mR/favicon-32x32.png b/docs/_static/favicon_mR/favicon-32x32.png new file mode 100644 index 000000000..073d93844 Binary files /dev/null and b/docs/_static/favicon_mR/favicon-32x32.png differ diff --git a/docs/_static/favicon_mR/favicon.ico b/docs/_static/favicon_mR/favicon.ico new file mode 100644 index 000000000..a33c23a06 Binary files /dev/null and b/docs/_static/favicon_mR/favicon.ico differ diff --git a/docs/_static/favicon_mR/site.webmanifest b/docs/_static/favicon_mR/site.webmanifest new file mode 100644 index 000000000..45dc8a206 --- /dev/null +++ b/docs/_static/favicon_mR/site.webmanifest @@ -0,0 +1 @@ +{"name":"","short_name":"","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"} \ No newline at end of file diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html new file mode 100644 index 000000000..a81e40b66 --- /dev/null +++ b/docs/_templates/layout.html @@ -0,0 +1,16 @@ +{% extends "!layout.html" %} + +{% block extrahead %} + {{ super() }} + + + + + + + +{% endblock %} \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index fa831c297..919ea270d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -42,7 +42,7 @@ def _patch_matlabdomain_noindex() -> None: _patch_matlabdomain_noindex() project = "matRad" -copyright = "2025, e0404" +copyright = "2026, e0404" author = "e0404" version = "3.2.2" @@ -53,6 +53,15 @@ def _patch_matlabdomain_noindex() -> None: html_static_path = ["_static"] html_css_files = ["style.css"] html_logo = "../matRad/gfx/matrad_logo.png" + +templates_path = ["_templates"] + +favicon_path = "_static/favicon_mR/" + +html_context = { + "fav": favicon_path, +} + html_theme_options = { 'logo_only': True, 'navigation_depth': 5, diff --git a/docs/images/QuickStart_GUI_3D_Viewer.png b/docs/images/QuickStart_GUI_3D_Viewer.png new file mode 100644 index 000000000..326f14cac Binary files /dev/null and b/docs/images/QuickStart_GUI_3D_Viewer.png differ diff --git a/docs/images/QuickStart_GUI_DVH_QI.png b/docs/images/QuickStart_GUI_DVH_QI.png new file mode 100644 index 000000000..2fd2e20db Binary files /dev/null and b/docs/images/QuickStart_GUI_DVH_QI.png differ diff --git a/docs/images/QuickStart_GUI_DoseCalc.png b/docs/images/QuickStart_GUI_DoseCalc.png new file mode 100644 index 000000000..fdff6306a Binary files /dev/null and b/docs/images/QuickStart_GUI_DoseCalc.png differ diff --git a/docs/images/QuickStart_GUI_GUI_after_Optimization.png b/docs/images/QuickStart_GUI_GUI_after_Optimization.png new file mode 100644 index 000000000..b205b2b74 Binary files /dev/null and b/docs/images/QuickStart_GUI_GUI_after_Optimization.png differ diff --git a/docs/images/QuickStart_GUI_Plan_Window.png b/docs/images/QuickStart_GUI_Plan_Window.png new file mode 100644 index 000000000..fd9f4eb4b Binary files /dev/null and b/docs/images/QuickStart_GUI_Plan_Window.png differ diff --git a/docs/images/QuickStart_GUI_Profile_Depth.png b/docs/images/QuickStart_GUI_Profile_Depth.png new file mode 100644 index 000000000..386f1cd13 Binary files /dev/null and b/docs/images/QuickStart_GUI_Profile_Depth.png differ diff --git a/docs/images/QuickStart_GUI_Profile_Lateral.png b/docs/images/QuickStart_GUI_Profile_Lateral.png new file mode 100644 index 000000000..1fa271a44 Binary files /dev/null and b/docs/images/QuickStart_GUI_Profile_Lateral.png differ diff --git a/docs/images/QuickStart_GUI_finishedDoseCalc.png b/docs/images/QuickStart_GUI_finishedDoseCalc.png new file mode 100644 index 000000000..4da93547e Binary files /dev/null and b/docs/images/QuickStart_GUI_finishedDoseCalc.png differ diff --git a/docs/images/QuickStart_GUI_finished_Optimization.png b/docs/images/QuickStart_GUI_finished_Optimization.png new file mode 100644 index 000000000..7909619be Binary files /dev/null and b/docs/images/QuickStart_GUI_finished_Optimization.png differ diff --git a/docs/images/QuickStart_GUI_load_patient.png b/docs/images/QuickStart_GUI_load_patient.png new file mode 100644 index 000000000..a12c48c9f Binary files /dev/null and b/docs/images/QuickStart_GUI_load_patient.png differ diff --git a/docs/images/QuickStart_GUI_loaded_patient.png b/docs/images/QuickStart_GUI_loaded_patient.png new file mode 100644 index 000000000..dad8f1b44 Binary files /dev/null and b/docs/images/QuickStart_GUI_loaded_patient.png differ diff --git a/docs/images/QuickStart_GUI_matRad_empty_GUI.png b/docs/images/QuickStart_GUI_matRad_empty_GUI.png new file mode 100644 index 000000000..72a3452c9 Binary files /dev/null and b/docs/images/QuickStart_GUI_matRad_empty_GUI.png differ diff --git a/docs/images/QuickStart_GUI_objectives_and_constraints_Window.png b/docs/images/QuickStart_GUI_objectives_and_constraints_Window.png new file mode 100644 index 000000000..948c2604c Binary files /dev/null and b/docs/images/QuickStart_GUI_objectives_and_constraints_Window.png differ diff --git a/docs/images/QuickStart_GUI_readyForDoseCalc.png b/docs/images/QuickStart_GUI_readyForDoseCalc.png new file mode 100644 index 000000000..c38fc2369 Binary files /dev/null and b/docs/images/QuickStart_GUI_readyForDoseCalc.png differ diff --git a/docs/images/QuickStart_Script_DAO.png b/docs/images/QuickStart_Script_DAO.png new file mode 100644 index 000000000..06e7abab2 Binary files /dev/null and b/docs/images/QuickStart_Script_DAO.png differ diff --git a/docs/images/QuickStart_Script_DVH_vis.png b/docs/images/QuickStart_Script_DVH_vis.png new file mode 100644 index 000000000..a8c7ee86d Binary files /dev/null and b/docs/images/QuickStart_Script_DVH_vis.png differ diff --git a/docs/images/QuickStart_Script_GUI_post.png b/docs/images/QuickStart_Script_GUI_post.png new file mode 100644 index 000000000..1a331aedc Binary files /dev/null and b/docs/images/QuickStart_Script_GUI_post.png differ diff --git a/docs/images/QuickStart_Script_GUI_pre.png b/docs/images/QuickStart_Script_GUI_pre.png new file mode 100644 index 000000000..47b9ad83d Binary files /dev/null and b/docs/images/QuickStart_Script_GUI_pre.png differ diff --git a/docs/images/QuickStart_Script_dosecalc_cmd_win.png b/docs/images/QuickStart_Script_dosecalc_cmd_win.png new file mode 100644 index 000000000..933e36585 Binary files /dev/null and b/docs/images/QuickStart_Script_dosecalc_cmd_win.png differ diff --git a/docs/images/QuickStart_Script_dosecalc_code.png b/docs/images/QuickStart_Script_dosecalc_code.png new file mode 100644 index 000000000..d9deffd0a Binary files /dev/null and b/docs/images/QuickStart_Script_dosecalc_code.png differ diff --git a/docs/images/QuickStart_Script_init_vis_GUI.png b/docs/images/QuickStart_Script_init_vis_GUI.png new file mode 100644 index 000000000..15b8ad3cc Binary files /dev/null and b/docs/images/QuickStart_Script_init_vis_GUI.png differ diff --git a/docs/images/QuickStart_Script_optimization_code.png b/docs/images/QuickStart_Script_optimization_code.png new file mode 100644 index 000000000..28a1eb7ed Binary files /dev/null and b/docs/images/QuickStart_Script_optimization_code.png differ diff --git a/docs/images/QuickStart_Script_optimize_cmd_win.png b/docs/images/QuickStart_Script_optimize_cmd_win.png new file mode 100644 index 000000000..6b2191314 Binary files /dev/null and b/docs/images/QuickStart_Script_optimize_cmd_win.png differ diff --git a/docs/images/QuickStart_Script_resultGUI.png b/docs/images/QuickStart_Script_resultGUI.png new file mode 100644 index 000000000..7cb807a8d Binary files /dev/null and b/docs/images/QuickStart_Script_resultGUI.png differ diff --git a/docs/images/QuickStart_Script_results.png b/docs/images/QuickStart_Script_results.png new file mode 100644 index 000000000..a689571d7 Binary files /dev/null and b/docs/images/QuickStart_Script_results.png differ diff --git a/docs/images/QuickStart_Script_sequencing.png b/docs/images/QuickStart_Script_sequencing.png new file mode 100644 index 000000000..b012da14e Binary files /dev/null and b/docs/images/QuickStart_Script_sequencing.png differ diff --git a/docs/images/QuickStart_Script_stf.png b/docs/images/QuickStart_Script_stf.png new file mode 100644 index 000000000..33beb4949 Binary files /dev/null and b/docs/images/QuickStart_Script_stf.png differ diff --git a/docs/images/QuickStart_Script_stf_cmd_win.png b/docs/images/QuickStart_Script_stf_cmd_win.png new file mode 100644 index 000000000..cbd68a6a5 Binary files /dev/null and b/docs/images/QuickStart_Script_stf_cmd_win.png differ diff --git a/docs/images/QuickStart_Script_vars.png b/docs/images/QuickStart_Script_vars.png new file mode 100644 index 000000000..c31737154 Binary files /dev/null and b/docs/images/QuickStart_Script_vars.png differ diff --git a/docs/quickstart/guiintro.rst b/docs/quickstart/guiintro.rst index d6b0382a4..17fa3f686 100644 --- a/docs/quickstart/guiintro.rst +++ b/docs/quickstart/guiintro.rst @@ -13,7 +13,7 @@ To execute the matRad GUI using MATLAB you need to: If you prefer to use the :file:`matRad.m` script to execute matRad, check out the :ref:`matRad script `. For more detailed information about the different features of the GUI you can take a look at :ref:`matRad GUI Overview `. -Step 1: Open matRad folder in MATLAB +Step 1: Open the matRad folder in MATLAB ------------------------------------ To use matRad you need to open the matRad folder in MATLAB. @@ -33,7 +33,7 @@ Step 2: Start the matRad GUI To start the GUI select :file:`matRadGUI.m` from your current folder and run it (right-click → run or F9) or simply type ``matRadGUI`` in your command window. Now the empty GUI should be opened: -.. image:: /images/GUI-Guide_emptyGUIScreenshot.png +.. image:: /images/QuickStart_GUI_matRad_empty_GUI.png :width: 650px If the GUI is not empty, then there is a patient already loaded in your workspace. To get an empty GUI you can clear your workspace and restart the GUI. However, this is not necessary as you can simply load a new patient. @@ -47,12 +47,12 @@ First, you need to load the patient data. Therefore, the matRad release contains To load a patient click the **Load \*.mat data** button in the **Workflow** section. A window should open. In the folder ``phantoms``, you can find different patient files. -.. image:: /images/GUI-Guide_loadDataGUIScreenshot.png +.. image:: /images/QuickStart_GUI_load_patient.png Here you can select which patient file (``*.mat``) you want to load. Upon opening the ``*.mat`` file the patient data is loaded into the GUI: On the right side of the GUI you should see the patient-CT with the defined VOIs. On the left side, the optimization parameter table should now be filled. -.. image:: /images/GUI-Guide_loadedGUIScreenshot.png +.. image:: /images/QuickStart_GUI_loaded_patient.png :width: 650px **Set plan parameters** @@ -61,27 +61,33 @@ Now you can start to adjust the plan parameters: +-----------------------------------------------------------------------------------------------+ | The bixel width, as well as the isocenter, can be adjusted but should already be set to | +| | | reasonable values. | +-----------------------------------------------------------------------------------------------+ | To set the beam directions you have to select the according gantry and couch angles. Every | +| | | gantry angle defines a beam and needs a couch angle. | +-----------------------------------------------------------------------------------------------+ | For the radiation mode, you can choose photons, protons or carbon. | +-----------------------------------------------------------------------------------------------+ | If you set carbon as radiation mode, you can activate the biological optimization. You can | +| | | choose between an effect based optimization (*effect*) or the optimization of the RBE-weighted| +| | | dose (*RBExD*). | +-----------------------------------------------------------------------------------------------+ | For the radiation mode "photons", you have the option to run a MLC sequencing, where you can | +| | | set the number of stratification levels and additionally you can run a direct aperture | +| | | optimization. | +-----------------------------------------------------------------------------------------------+ -.. image:: /images/GUI-Guide_planParametersGUIScreenshot.png +.. image:: /images/QuickStart_GUI_Plan_Window.png -**Set optimization parameters** +**Set objectives and constraints** -The optimization parameters are used to influence the outcome of the fluence optimization. Here you can set the parameters of the VOIs (e.g. min/max dose, penalty, overlap priority, etc.). For more information, take a look at the :doc:`../datastructures/cst`. Using the '**+**' and '**-**' buttons you can add and remove VOIs. +The objectives and constraints are used to influence the outcome of the fluence optimization. Here you can set the parameters of the VOIs (e.g. min/max dose, penalty, overlap priority, etc.). For more information, take a look at the :doc:`../datastructures/cst`. Using the '**+**' and '**-**' buttons you can add and remove VOIs. The column ``p`` (*penalty*) determines the relative weighting of the objective within the overall weighted sum objective function. The column ``Parameters`` lets you specify additional parameters for given objectives. For squared over- and underdosage as well as squared deviation, this simply corresponds to the reference dose level, for EUD it is the exponent. A mean dose objective does not require an additional parameter. @@ -89,27 +95,27 @@ The column ``OP`` (*overlap priority*) is very important as it determines the as *Note: Changing the VOI Type from OAR to target will lead to additional beamlets or spots that need to be considered for the dose-influence-matrix calculation. As a result, these changes have to be done before the Dij-calculation.* -.. image:: /images/GUI-Guide_optimizationParametersGUIScreenshot.png +.. image:: /images/QuickStart_GUI_objectives_and_constraints_Window.png **Calculate Dose influence matrix** To start the calculation of the dose-influence-matrix you simply need to click the **Calc. Dose Influence** button in the workflow: -.. image:: /images/GUI-Guide_workflowGUIScreenshot.png +.. image:: /images/QuickStart_GUI_readyForDoseCalc.png You should see a window pop up, showing a progress bar of the calculation: -.. image:: /images/GUI-Guide_dijProgressBarScreenshot.png +.. image:: /images/QuickStart_GUI_DoseCalc.png In addition, the progress is displayed in the Command Window: -.. image:: /images/GUI-Guide_dijOutputScreenshot.png +.. image:: /images/QuickStart_GUI_finishedDoseCalc.png **Execute fluence optimization** Once the dose calculation is completed, you can start the fluence optimization by clicking the **Optimize** button in the workflow section. The iterations of the optimization are displayed in the Command Window: -.. image:: /images/GUI-Guide_fluenceOptOutputScreenshot.png +.. image:: /images/QuickStart_GUI_finished_Optimization.png To adjust the convergence criteria you can specify the *maximum number of iterations* and the *convergence* precision in the *Optimization Parameter* section. Default values are: 1000 iterations and a precision of :math:`10^{-3}`: (Precision ≡ \|(FuncValue_old − FuncValue_new) / FuncValue_old\|) @@ -121,14 +127,30 @@ Step 4: Visualize resulting treatment plan Once the fluence optimization has converged the resulting dose distribution will be displayed in the GUI. Here you can adjust the visualization parameters to display different slices/planes, use different plot types, etc. -.. image:: /images/GUI-Guide_optimizedGUIScreenshot.png +.. image:: /images/QuickStart_GUI_GUI_after_Optimization.png :width: 650px +You can choose between an intensity plot (for the coronal, sagital and axial plane) and a profile plot (either depth or lateral, see images below), for which you can choose your slice to be displayed, respectively: + +.. image:: /images/QuickStart_GUI_Profile_Depth.png + :width: 50% + +.. image:: /images/QuickStart_GUI_Profile_Lateral.png + :width: 50% + + +Furthermore, you can have a look at your slice within a 3D model of your patient by clicking *Open 3D Viewer*: + +.. image:: /images/QuickStart_GUI_3D_Viewer.png + + To calculate a DVH of all VOIs and to see the quality indicators (which contain the mean/max/min dose for each VOI) you can use the **Show DVH/QI** button in the *Visualization* section. .. image:: /images/DVHVisScreenshot.png + + Step 5: Import additional patient data -------------------------------------- diff --git a/docs/quickstart/index.rst b/docs/quickstart/index.rst index 100af51fe..51a59ce89 100644 --- a/docs/quickstart/index.rst +++ b/docs/quickstart/index.rst @@ -8,9 +8,9 @@ Quick Start =========== -It's the first time you want to use matRad? +Is it the first time you want to use matRad? -First, get a local copy of matRad by download or git cloning. Having done that, we recommend you navigate into the folder in Matlab and execute +First, get a local copy of matRad by downloading or git cloning. Having done that, we recommend you navigate into the folder in Matlab and execute .. code-block:: matlab @@ -18,14 +18,14 @@ First, get a local copy of matRad by download or git cloning. Having done that, which will setup the path & configuration and tell you the current version. -Then there're three options for a pleasant start with matRad. Choose one or try out each of them. +A key feature of matRad is that it can be used either through a graphical user interface (GUI) or as a MATLAB script. +Accordingly, there are different ways to familiarize yourself with the software and get started with matRad. Below, we present three different beginner-friendly approaches. Choose one or explore and try out each of them. .. rubric:: Option 1: Using the GUI :heading-level: 2 - -For an intuitive workflow with the graphical user interface, type +For the most intuitive workflow, we recommend using the graphical user interface (GUI). In order to start it, type .. code-block:: matlab @@ -42,9 +42,9 @@ If you prefer scripting, open the default script *matRad.m* from the main matRad edit matRad.m -Use it to learn something about the code structure and execute it section by section. +You can use it to learn something about the code structure of a typical matRad workflow and execute it section by section. -You can also run the full script for an example photon plan by just typing +If you want to run the full script for an exemplary photon plan, you can type .. code-block:: matlab @@ -55,9 +55,9 @@ in your command window. .. rubric:: Option 3: Using the examples :heading-level: 2 -The most time consuming but also most educational approach to matRad. +This is by far the most time consuming, but also the most educational approach to matRad, as it includes working through tutorial-style example scripts for different scenarios, e.g. treatment planning with different radiation sources or including biological models. Therefore, if you want to have in-depth training on the whole bandwidth of applications of our software, working through the examples is what we recommend. -When in the main matRad folder, navigate to the folder *examples*. Open one of the examples given there. Execute it section by section. Move on to the next example afterwards. +In order to get started with the examples, you simply need to navigate to the folder *examples* when in the main matRad directory, open any example of your choice, execute it section by section and move on to the next example afterwards. As the code includes detailed instructional comments, the examples serve as a step-by-step guide to different matRad use cases and are easy to follow and understand. **See also:** diff --git a/docs/quickstart/matradscript.rst b/docs/quickstart/matradscript.rst index 0df553978..8d290a445 100644 --- a/docs/quickstart/matradscript.rst +++ b/docs/quickstart/matradscript.rst @@ -26,7 +26,7 @@ The main script to run matRad is called `matRad.m `_ script ca 8. `Visualization of the resulting treatment plan`_ 9. `Show DVH and quality indicators`_ -To evaluate a single section, you have to "activate" it (*Left-click* inside section) and then use *ctrl + enter* or use *Right-click* → *Evaluate Current Section*. +To evaluate a single section, you have to "activate" it (*Left-click* inside section) and then use *ctrl + enter*, use *Right-click* → *Run Section* or click *Run Section* within the *Editor* window of the MATLAB interface. .. _Load settings: @@ -100,7 +100,7 @@ To evaluate a single section, you have to "activate" it (*Left-click* inside sec Now you can execute the first section. You should see, among others, the variables ``cst``, ``ct`` and ``pln`` in your Workspace. -.. image:: /images/parametersLoadedScreenshot.png +.. image:: /images/QuickStart_Script_vars.png :width: 300px .. _Initial visualization: @@ -110,11 +110,11 @@ Now you can execute the first section. You should see, among others, the variabl After the patient data is loaded, you can execute the second section to open the GUI: -.. image:: /images/executeGUIScreenshot.png +.. image:: /images/QuickStart_Script_init_vis_GUI.png In the GUI you can view the patient CT, change the plan parameters and adjust the optimization parameters. -.. image:: /images/GUI-Guide_loadedGUIScreenshot.png +.. image:: /images/QuickStart_Script_GUI_pre.png :width: 650px The usage of the GUI is explained in more detail in the :doc:`guiintro`. Here we will focus on the "manual" execution of the matRad script. To "manually" change the optimization parameters, you can adjust the ``cst``-cell (see :ref:`cst cell array documentation ` for more information). @@ -126,11 +126,11 @@ The usage of the GUI is explained in more detail in the :doc:`guiintro`. Here we In this section, the steering file ``stf`` is created and the matRad steering information is stored as a struct (see :ref:`stf struct ` for more information). -.. image:: /images/STFScreenshot.png +.. image:: /images/QuickStart_Script_stf.png The Command Window should show the progress. -.. image:: /images/calcSTFScreenshot.png +.. image:: /images/QuickStart_Script_stf_cmd_win.png .. _Dose calculation: @@ -139,11 +139,11 @@ The Command Window should show the progress. In this section, the dose influence matrix ``dij`` for the defined beam angles is calculated (see :ref:`dij struct ` for more information). -.. image:: /images/doseCalcScreenshot.png +.. image:: /images/QuickStart_Script_dosecalc_code.png Again, the progress should be shown in the Command Window. -.. image:: /images/doseCalcProgScreenshot.png +.. image:: /images/QuickStart_Script_dosecalc_cmd_win.png .. _Inverse planning for IMRT: @@ -152,11 +152,11 @@ Again, the progress should be shown in the Command Window. In this section, the fluence is optimized to find the bixel (*photons*) or spot (*protons/carbon*) weights minimizing the objective function. -.. image:: /images/invPlanningScreenshot.png +.. image:: /images/QuickStart_Script_optimization_code.png During this process, the current objective function value is displayed: -.. image:: /images/invPlanningProgScreenshot.png +.. image:: /images/QuickStart_Script_optimize_cmd_win.png .. _sequencing_step: @@ -165,7 +165,7 @@ During this process, the current objective function value is displayed: For photon IMRT the application of a multileaf collimator is necessary. By sequencing, the applicable dose distribution can be simulated. The fourth input of ``matRad_engelLeafSequencing(resultGUI,stf,dij,7)`` is the number of stratification levels. You can adjust this number to use the number of levels you want. -.. image:: /images/sequencingScreenshot.png +.. image:: /images/QuickStart_Script_sequencing.png When the sequencing is finished, the `result struct `_ is updated. @@ -176,7 +176,7 @@ When the sequencing is finished, the `result struct `. -.. image:: /images/daoScreenshot.png +.. image:: /images/QuickStart_Script_DAO.png .. _Visualization of the resulting treatment plan: @@ -185,12 +185,12 @@ For photon therapy, the multileaf collimator sequencing can be further refined b Now you can visualize the resulting treatment plan using the GUI. -.. image:: /images/doseVisGUIScreenshot.png +.. image:: /images/QuickStart_Script_results.png In the GUI you can see the resulting dose distribution for the calculated treatment plan. You can choose which plane and slice should be displayed. You can also display a dose profile plot by changing *Type of plot* from *intensity* to *profile*. If you have chosen a biological optimization, then you have several parameters to be displayed (e.g. RBE-weighted dose, biological effect, α or β values). -.. image:: /images/GUI-Guide_optimizedGUIScreenshot.png +.. image:: /images/QuickStart_Script_GUI_post.png :width: 650px .. _Show DVH and quality indicators: @@ -200,9 +200,9 @@ If you have chosen a biological optimization, then you have several parameters t In this section, the dose-volume histograms (DVH) are calculated and visualized. -.. image:: /images/DVHScreenshot.png +.. image:: /images/QuickStart_Script_resultGUI.png -.. image:: /images/DVHVisScreenshot.png +.. image:: /images/QuickStart_Script_DVH_vis.png :width: 650px The diagram shows the DVH and in the table, you see the mean, maximum and minimum dose for every VOI. Additionally, the dose and dose-volume coefficient for several confidence levels are displayed. diff --git a/submodules/MOcov b/submodules/MOcov index 2bcb1741f..995abc8ef 160000 --- a/submodules/MOcov +++ b/submodules/MOcov @@ -1 +1 @@ -Subproject commit 2bcb1741fefa79718f32d04b7694042a6c60255e +Subproject commit 995abc8ef4766dcbc6318804bd01573901cad718 diff --git a/submodules/MOxUnit b/submodules/MOxUnit index 92bcf4eec..db6c87fe7 160000 --- a/submodules/MOxUnit +++ b/submodules/MOxUnit @@ -1 +1 @@ -Subproject commit 92bcf4eec200c29024ce8d1145ec66bd76c1d623 +Subproject commit db6c87fe7379d5a5d727feed760c38f3c533b339 diff --git a/submodules/matlab2tikz b/submodules/matlab2tikz index 7c8f50a93..816f87548 160000 --- a/submodules/matlab2tikz +++ b/submodules/matlab2tikz @@ -1 +1 @@ -Subproject commit 7c8f50a93b630fedd6f08602d2d27d9a481798fd +Subproject commit 816f8754804cd45d8b41b3adf3ff9709a29cf173