Merged in feature/RAM-3504_image_generator_pf (pull request #377)

Feature/RAM-3504 image generator Approved-by: Randy Taylor
jrkerns · Apr 24, 2024 · 1d9291f · 1d9291f
2 parents 28d3542 + de4cb24
commit 1d9291f
Show file tree

Hide file tree

Showing 13 changed files with 3,365 additions and 0 deletions.
diff --git a/bitbucket-pipelines.yml b/bitbucket-pipelines.yml
@@ -227,6 +227,17 @@ definitions:
               - "pylinac/core/**"
               - "tests_basic/test_winstonlutz.py"
               - "pylinac/winston_lutz.py"
+    - step: &plan-generator-tests
+        name: Plan generator tests
+        script:
+          - source venv/bin/activate
+          - pytest tests_basic/test_plan_generator.py --cov-report term --junitxml=./test-reports/pytest_results.xml
+        condition:
+            changesets:
+                includePaths:
+                - "pylinac/core/**"
+                - "pylinac/plan_generator/**"
+                - "tests_basic/test_plan_generator.py"
     - step: &core-module-tests
         name: Run core module tests
         script:
@@ -301,6 +312,7 @@ pipelines:
           - step: *vmat-tests
           - step: *winston-lutz-tests
           - step: *winston-lutz-mtmf-tests
+          - step: *plan-generator-tests
           - step: *core-module-tests
 
   branches:

diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -5,6 +5,17 @@ Changelog
 v 3.23.0
 --------
 
+Plan Generator
+^^^^^^^^^^^^^^
+
+* A new module has been introduced: the plan generator! This module can assist in generating DICOM RT plan QA files
+  customized for your clinic. It can produce basic shapes and typical QA fields such as picket fence, open fields,
+  and more. See the :ref:`plan-generator` section for more.
+* RT plan fluence can be plotted using a new function: ``plot_fluences()``. This will plot the fluence of the plan
+  fields as figures. This is useful for visualizing the plan fluence and comparing it to the expected fluence. This
+  can be used in conjunction with the plan generator to visualize the fluence of the generated plan. See :ref:`plan_fluence`
+  for more.
+
 Picket Fence
 ^^^^^^^^^^^^
 

diff --git a/docs/source/images/jaw_orientation.png b/docs/source/images/jaw_orientation.png
diff --git a/docs/source/images/new_qa_plan.gif b/docs/source/images/new_qa_plan.gif
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -38,6 +38,7 @@
 
    core_modules
    image_generator
+   plan_generator
    contrib
 
 .. toctree::
@@ -53,6 +54,7 @@
    topics/scale
    topics/profiles
    topics/image_metrics
+   topics/fluence
 
 .. toctree::
    :hidden: