cerr.roe package

Submodules

cerr.roe.dosimetric_models module

cerr.roe.dosimetric_models.linearFn(paramDict, doseBinsV, volHistV)

Evaluate linear dosimetric model. :param paramDict: Dictionary specifying slope and intercept. :param doseBinsV: Vector of dose bins. :param volHistV: Vector of volumes corresponding to dose bins.

Returns:

NTCP using linear model.

cerr.roe.dosimetric_models.LKBFn(paramDict, doseBinsV, volHistV)

Evaluate LKB model. :param paramDict: Dictionary specifying D50, m, and n. :param doseBinsV: Vector of dose bins. :param volHistV: Vector of volumes corresponding to dose bins.

Returns:

NTCP using LKB model.

cerr.roe.dosimetric_models.logitFn(paramDict, doseBinList, volHistList)

Evaluate logistic dosimetric model. :param paramDict: Dictionary specifying predictors and coefficients. :param doseBinList: List of dose bins for input structures. :param volHistList: List of volumes corresponding to dose bins.

Returns:

NTCP using logistic model.

cerr.roe.dosimetric_models.appeltLogit(paramDict, doseBinList, volHistList)

Evaluate appelt-corrected logistic model.

Ref: Ane L. Appelt, Ivan R. Vogelius, Katherina P. Farr, Azza A. Khalil & Søren M. Bentzen (2014) Towards individualized dose constraints: Adjusting the QUANTEC radiation pneumonitis model for clinical risk factors, Acta Oncologica, 53:5, 605-612. :param paramDict: Dictionary specifying predictors and associated coefficients. :param doseBinList: List of dose bins. :param volHistList: List of volumes corresponding to dose bins.

Returns:

NTCP using logistic model, following Appelt correction.

cerr.roe.dosimetric_models.coxFn(paramDict, doseBinList, volHistList)

Evaluate Cox Proportional Hazards model. :param paramDict: Dictionary specifying baseline hazard, predictors and coefficients. :param doseBinList: List of dose bins for input structures. :param volHistList: List of volumes corresponding to dose bins.

Returns:

Actuarial probability or NTCP using Cox model.

cerr.roe.dosimetric_models.biexpFn(paramDict, doseBinList, volHistList)

Evaluate bi-exponential model. :param paramDict: Dictionary specifying clear :param predictors and coefficients.: :param doseBinList: List of dose bins for input structures. :param volHistList: List of volumes corresponding to dose bins.

Returns:

NTCP using biexponential model.

cerr.roe.dosimetric_models.lungBED(paramDict, doseBinsV, volHistV)

Function to compute lung BED. Ref. Comparison Between Mechanistic Radiobiological Modeling vs. Fowler BED Equation in Evaluating Lung Cancer Radiotherapy Outcome for a Broad Range of Fractionation, J Jeong et al., AAPM 2017.

Parameters:

• paramDict – Dictionary specifying D50, m, and n.

• doseBinsV – Vector of dose bins.

• volHistV – Vector of volumes corresponding to dose bins.

Returns:

Lung BED.

cerr.roe.dosimetric_models.lungTCP(paramDict, doseBinsV, volHistV)

Function to compute lung TCP. Ref. Jeong J. et al. Modeling the cellular response of lung cancer to radiation therapy for a broad range of fractionation schedules. Clin. Cancer Res. 2017; 23: pp. 5469-5479. :param paramDict: Dictionary specifying D50, m, and n. :param doseBinsV: Vector of dose bins. :param volHistV: Vector of volumes corresponding to dose bins.

Returns:

Lung TCP.

cerr.roe.dosimetric_models.getTreatmentSchedule(nFrx, scheduleType)

Return RT treatment days for a given no. of fractions and schedule type. :param nFrx: No. of fractions :param scheduleType: Supported values: ‘weekday’ ,’primershot’,’primershotopt’.

Returns:

Treatment days

cerr.roe.dosimetric_models.get_corrected_dvbins(modelFile, doseNum, planC, fSizeIn=None, fNumIn=None, binWidth=0.05, mode=None)

Returns corrected dose bins and associated vol. histograms for structures involved. :param modelFile: Path to JSON file describing model parameters OR

Dictionary of model parameters

Parameters:

• doseNum – Index of dose in planC

• planC – plan container object

• fSizeIn – Fraction size of input plan

• fNumIn – Fraction no. of input plan

• binWidth (float) – Bin width for DVH calculation. Default:0.05

• mode – Set to ‘test’ for unit tests using single-voxel structures.

Returns:

Model-based NTCP.

cerr.roe.dosimetric_models.run(modelFile, doseNum, planC, fSizeIn=None, fNumIn=None, binWidth=0.05, mode=None)

Evaluate dosimetric model including fractionation correction where applicable. :param modelFile: Path to JSON file describing model parameters OR

Dictionary of model parameters

Parameters:

• doseNum – Index of dose in planC

• planC – plan container object

• fSizeIn – Fraction size of input plan

• fNumIn – Fraction no. of input plan

• binWidth (float) – Bin width for DVH calculation. Default:0.05

• mode – Set to ‘test’ for unit tests using single-voxel structures.

Returns:

Model-based NTCP.

Module contents