Skip to content

Commit

Permalink
Dave's surname name is Rogers not Rodgers
Browse files Browse the repository at this point in the history
  • Loading branch information
randlet committed Oct 30, 2020
1 parent 14a5296 commit 4527f49
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
8 changes: 4 additions & 4 deletions docs/source/calibration_docs.rst
Expand Up @@ -108,9 +108,9 @@ Equation definitions are as follows:
Where A, B, and C are chamber-specific fitting values as given in Table I.
Pylinac automatically retrieves values based on the chamber model passed to the function.

* kQ for Electrons (cylindrical chamber-specific quality conversion factor) - `Muir & Rodgers 2014`_
* kQ for Electrons (cylindrical chamber-specific quality conversion factor) - `Muir & Rogers 2014`_

The study of Muir & Rodgers was to find kecal values that could be determined soley from R50. Through
The study of Muir & Rogers was to find kecal values that could be determined soley from R50. Through
Monte Carlo experiments, the optimal Pgradient was determined as well as fitting parameters for numerous
common ion chambers. That study eliminates the need for Pgradient measurements. These kecal values will
very likely be incorporated into the next TG-51 addendum (as has their kQ values for photons in the first
Expand All @@ -137,7 +137,7 @@ Equation definitions are as follows:
.. math::
M*P^Q_{gr}*k'_{R_{50}}*k_{ecal}*N^{60Co}_{D,w} (Gy)
.. _Muir & Rodgers 2014: http://onlinelibrary.wiley.com/doi/10.1118/1.4893915/abstract
.. _Muir & Rogers 2014: http://onlinelibrary.wiley.com/doi/10.1118/1.4893915/abstract


Function-based Use
Expand All @@ -152,7 +152,7 @@ values.
.. note::
The Photon class uses kQ values from the TG-51 addendum.
The Legacy Electron class will make the user specify a kecal value and measure Pgradient.
The Modern Electron class will calculate kQ completely from R50 and the chamber from Muir & Rodgers 2014 paper,
The Modern Electron class will calculate kQ completely from R50 and the chamber from Muir & Rogers 2014 paper,
no kecal or Pgradient needed.


Expand Down
6 changes: 3 additions & 3 deletions docs/source/changelog.rst
Expand Up @@ -481,10 +481,10 @@ Winston-Lutz
TG-51
^^^^^

* The Electron class has been adjusted to reflect the `Muir & Rodgers 2014`_ kecal data which allows the user to calculate kQ from just R50 data.
* The Electron class has been adjusted to reflect the `Muir & Rogers 2014`_ kecal data which allows the user to calculate kQ from just R50 data.
* The `kq` function now accepts an `r_50` parameter to calculate kQ based on the above data.

.. _Muir & Rodgers 2014: http://onlinelibrary.wiley.com/doi/10.1118/1.4893915/abstract
.. _Muir & Rogers 2014: http://onlinelibrary.wiley.com/doi/10.1118/1.4893915/abstract

Core Modules
^^^^^^^^^^^^
Expand Down Expand Up @@ -1414,4 +1414,4 @@ This is the initial release of Pylinac. It includes two modules for doing TG-142
Starshot & VMAT QA

Versioning mostly follows standard semantic revisioning. However, each new module will result in a bump in minor release, while bug fixes
will bump patch number.
will bump patch number.
16 changes: 8 additions & 8 deletions pylinac/calibration/tg51.py
@@ -1,9 +1,9 @@
"""
The TG-51 module contains a number of helper functions and classes that can calculate parameters for performing the
TG-51 absolute linac dose calibration although there are some modifications from the original TG-51. The modifications
include updated kQ and kecal values from Muir and Rodgers' set of papers.
include updated kQ and kecal values from Muir and Rogers' set of papers.
Functions include all relevant calculations for TG-51 including PDDx, kQ,
Dref, and chamber reading corrections. Where Muir & Rodgers' values/equations are used they are specified in the documentation.
Dref, and chamber reading corrections. Where Muir & Rogers' values/equations are used they are specified in the documentation.
Classes include photon and electron calibrations using cylindrical chambers. Pass all the relevant raw measurements
and the class will compute all corrections and corrected readings and dose at 10cm and dmax/dref.
Expand Down Expand Up @@ -299,7 +299,7 @@ def kq_photon_pddx(*, chamber: str, pddx: float) -> float:
----------
chamber : str
The chamber of the chamber. Valid values are those listed in
Table III of Muir and Rodgers and Table I of the TG-51 Addendum.
Table III of Muir and Rogers and Table I of the TG-51 Addendum.
pddx : {>63.0, <86.0}
The **PHOTON-ONLY** PDD measurement at 10cm depth for a 10x10cm2 field.
Expand All @@ -322,7 +322,7 @@ def kq_photon_tpr(*, chamber: str, tpr: float) -> float:
----------
chamber : str
The chamber of the chamber. Valid values are those listed in
Table III of Muir and Rodgers and Table I of the TG-51 Addendum.
Table III of Muir and Rogers and Table I of the TG-51 Addendum.
tpr : {>0.630, <0.860}
The TPR(20,10) value.
Expand All @@ -336,13 +336,13 @@ def kq_photon_tpr(*, chamber: str, tpr: float) -> float:
@argue.options(chamber=KQ_ELECTRONS.keys())
def kq_electron(*, chamber: str, r_50: float) -> float:
"""Calculate kQ based on the chamber and clinical measurements. This will calculate kQ for electrons
for *CYLINDRICAL* chambers only according to Muir & Rodgers.
for *CYLINDRICAL* chambers only according to Muir & Rogers.
Parameters
----------
chamber : str
The chamber of the chamber. Valid values are those listed in
Tables VI and VII of Muir and Rodgers 2014.
Tables VI and VII of Muir and Rogers 2014.
r_50 : float
The R50 value in cm of an electron beam.
"""
Expand Down Expand Up @@ -788,7 +788,7 @@ class TG51ElectronModern(TG51Base):
"""Class for calculating absolute dose to water using a cylindrical chamber in an electron beam.
.. warning::
This class uses the values of Muir & Rodgers. These values are likely to be included in the new TG-51
This class uses the values of Muir & Rogers. These values are likely to be included in the new TG-51
addendum, but are not official. The results can be up to 1% different. Physicists should use their own
judgement when deciding which class to use. To use a manual kecal value, Pgradient and the classic TG-51 equations use
the :class:`~pylinac.calibration.tg51.TG51ElectronLegacy` class.
Expand Down Expand Up @@ -879,7 +879,7 @@ def dref(self) -> float:

@property
def kq(self) -> float:
"""The kQ value using the updated Muir & Rodgers values from their 2014 paper, equation 11, or classically
"""The kQ value using the updated Muir & Rogers values from their 2014 paper, equation 11, or classically
if kecal is passed."""
return kq_electron(chamber=self.chamber, r_50=self.r_50)

Expand Down

0 comments on commit 4527f49

Please sign in to comment.