Merged in docs/result_descriptions (pull request #413)

result field descriptions Approved-by: Randy Taylor Approved-by: Hasan Ammar
jrkerns · Jul 15, 2024 · 8b26ece · 8b26ece
2 parents ca430a3 + 69ef202
commit 8b26ece
Show file tree

Hide file tree

Showing 17 changed files with 1,045 additions and 441 deletions.
diff --git a/docs/source/acr.rst b/docs/source/acr.rst
diff --git a/docs/source/cbct.rst b/docs/source/cbct.rst
@@ -511,7 +511,7 @@ Analysis
   correspond to the HU material regions. The median pixel value of the ROI is the stated HU value. Nominal HU values
   are taken as the mean of the range given in the manual(s):
 
-  .. note:: As of v3.16, these can be overriden: :ref:`custom-hu-values`.
+  .. note:: As of v3.16, these can be overridden: :ref:`custom-hu-values`.
 
   .. image:: images/catphan_densities.png
 
@@ -591,7 +591,7 @@ The results of a CatPhan analysis in RadMachine or from ``results_data`` are:
     * ``stdev``: The pixel value standard deviation of the ROI.
     * ``difference``: The difference between the measured and nominal values.
 
-* ``ctp528``: A dictionary of results for the CTP528 (spatial resolution) module with the
+* ``ctp528``: The results of the CTP528 (spatial resolution) module with the
   following items:
 
   * ``start_angle_radians``: The angle where the circular profile started.
@@ -608,11 +608,11 @@ The results of a CatPhan analysis in RadMachine or from ``results_data`` are:
     * ``gap size (cm)``: The size of the gap between the bars in cm.
     * ``lp/mm``: The number of line **pairs** per mm.
 
-* ``ctp515``: A dictionary of results for the CTP515 (Low contrast) module with the following items:
+* ``ctp515``: The results of the CTP515 (Low contrast) module with the following items:
 
   * ``cnr_threshold``: The contrast-to-noise ratio threshold used to determine if a low contrast ROI was "seen".
   * ``num_rois_seen``: The number of ROIs that were above the threshold; ie. "seen".
-  * ``roi_settings``: A dictionary of the settings used for each low contrast ROI. The key names are ``n``
+  * ``roi_settings``: The settings used for each low contrast ROI. The key names are ``n``
     where ``<n>`` is the size of the ROI. The values are a dictionary with the following keys:
 
     * ``angle``: The angle of the ROI in degrees.
@@ -622,7 +622,7 @@ The results of a CatPhan analysis in RadMachine or from ``results_data`` are:
     * ``angle_corrected``: The angle of the ROI corrected for phantom roll.
     * ``radius_pixels``: The radius of the ROI in pixels.
 
-  * ``roi_results``: A dictionary of the low contrast ROIs and their values. The keys will be the size
+  * ``roi_results``: Results of the low contrast ROIs and their values. The keys will be the size
     of the ROI such as ``'9'``. The values for each ROI will be a dictionary with the following keys:
 
     * ``contrast method``: The method used to calculate the contrast. See :ref:`contrast`.

diff --git a/docs/source/planar_imaging.rst b/docs/source/planar_imaging.rst
@@ -937,7 +937,7 @@ The results from phantoms that are meant to measure image quality, contrast, etc
 * ``num_contrast_rois_seen``: The number of low contrast ROIs that had a visibility
   score above the passed threshold. See :ref:`visibility` for more.
 * ``phantom_center_x_y``: The center of the phantom in the image in pixels.
-* ``phantom_area``: The area of the phantom in pixels.
+* ``phantom_area``: The area of the phantom in pixels^2.
 * ``mtf_lp_mm``: The 80%, 50%, and 30% MTF values in lp/mm. For more values see: :ref:`calculate-specific-mtf`.
 * ``percent_integral_uniformity``: The percent integral uniformity of the image.
 * ``low_contrast_rois``: A dictionary of the individual low contrast ROIs. The dictionary keys

diff --git a/docs/source/quart.rst b/docs/source/quart.rst
@@ -247,10 +247,11 @@ The outcome from analyzing the phantom available in RadMachine or from
 * ``geometric_module``: A dictionary containing the following items:
 
   * ``offset``: The offset of the module slice in mm from the origin slice.
-  * ``high_contrast_distances``: A dictionary of the high contrast distances in mm. See: :ref:`quart-high-res`.
-    The key is the region of the line and the value is the distance in mm.
   * ``distances``: A dictionary of the phantom size itself in horizontal and vertical dimensions in mm.
     The keys are ``horizontal mm`` and ``vertical mm``.
+  * ``high_contrast_distances``: A dictionary of the high contrast distances in mm. See: :ref:`quart-high-res`.
+    The key is the region of the line and the value is the distance in mm.
+  * ``mean_high_contrast_distance``: The mean of the high contrast distances in mm.
 
 
 API Documentation

diff --git a/docs/source/winston_lutz.rst b/docs/source/winston_lutz.rst
@@ -569,10 +569,10 @@ Interpreting Results
 This explains the :class:`~pylinac.winston_lutz.WinstonLutzResult` class that is returned from the ``results_data`` method.
 This is also what is given in RadMachine image analysis results and is explained further here.
 
-* ``num_gantry_images``: The number of images that were taken at different gantry angles and all other axes were 0.
-* ``num_gantry_coll_images``: The number of images that were taken at different gantry and collimator angles and the couch was 0.
-* ``num_coll_images``: The number of images that were taken at different collimator angles and all other axes were 0.
-* ``num_couch_images``: The number of images that were taken at different couch angles and all other axes were 0.
+* ``num_gantry_images``: The number of images that were taken at different gantry angles and all other axes were at reference.
+* ``num_gantry_coll_images``: The number of images that were taken at different gantry and collimator angles and the couch was at reference.
+* ``num_coll_images``: The number of images that were taken at different collimator angles and all other axes were at reference.
+* ``num_couch_images``: The number of images that were taken at different couch angles and all other axes were at reference.
 * ``num_total_images``: The total number of images analyzed.
 * ``max_2d_cax_to_bb_mm``: The maximum 2D distance from the field CAX to the BB across all images analyzed in mm.
 * ``median_2d_cax_to_bb_mm``: The median 2D distance from the field CAX to the BB across all images analyzed in mm.
@@ -588,17 +588,17 @@ This is also what is given in RadMachine image analysis results and is explained
       This value is independent of the BB position.
 
 * ``max_gantry_rms_deviation_mm``: The maximum RMS value of the field CAX to BB for the gantry axis images in mm. This is an alternative to the max/mean/median calculations.
-* ``max_coll_rms_deviation_mm``: The maximum RMS deviation of the field CAX to BB for the collimator axis images in mm. This is an alternative to the max/mean/median calculations.
-* ``max_couch_rms_deviation_mm``: The maximum RMS value of the field CAX to BB for the couch axis images in mm. This is an alternative to the max/mean/median calculations.
 * ``max_epid_rms_deviation_mm``: The maximum RMS value of the field CAX to EPID center for the EPID images in mm. This is an alternative to the max/mean/median calculations.
 * ``gantry_coll_3d_iso_diameter_mm``: The 3D isocenter diameter **of the gantry and collimator axes** as determined by the gantry and collimator images in mm.
+* ``coll_2d_iso_diameter_mm``: The 2D isocenter diameter **of the collimator axis only** as determined by the collimator images in mm.
+* ``max_coll_rms_deviation_mm``: The maximum RMS deviation of the field CAX to BB for the collimator axis images in mm. This is an alternative to the max/mean/median calculations.
+* ``max_couch_rms_deviation_mm``: The maximum RMS value of the field CAX to BB for the couch axis images in mm. This is an alternative to the max/mean/median calculations.
   This uses backprojection lines of the field center to the source and minimizes a sphere that touches all the backprojection lines.
 
   .. note::
 
       This value is independent of the BB position.
 
-* ``coll_2d_iso_diameter_mm``: The 2D isocenter diameter **of the collimator axis only** as determined by the collimator images in mm.
 * ``couch_2d_iso_diameter_mm``: The 2D isocenter diameter **of the couch axis only** as determined by the couch images in mm.
 * ``bb_shift_vector``: The Cartesian vector that would move the BB to the radiation isocenter. Each value is in mm. See also :ref:`wl_virtual_shift`, :ref:`winston-lutz-couch-shift-algorithm`
 * ``image_details``: A list of the individual image results. Each item has the following:
@@ -608,6 +608,7 @@ This is also what is given in RadMachine image analysis results and is explained
   * ``cax2epid_vector``: The vector (in Cartesian coordinates) from the field CAX to the EPID center in mm.
   * ``cax2epid_distance``: The distance from the field CAX to the EPID center in mm.
   * ``cax2bb_vector``: The vector (in Cartesian coordinates) from the field CAX to the BB in mm.
+  * ``cax2bb_distance``: The scalar distance from the field CAX to the BB in mm.
   * ``field_cax``: The location of the field CAX in the image as a Point in pixels.
 * ``keyed_image_details``: A **dictionary** of the individual image results. This is the same as ``image_details`` but keyed by the images
   using the axes values as the key. E.g. ``G0B45P0``. This can be used to identify individual