getIsoEffD: Isoeffective dose calculation

Description Usage Arguments Details Value References See Also Examples

View source: R/getIsoEffD.R

Description

Convert given (fractional) dose into a corresponding (fractional) dose for a different total dose / fractionation schedule according to the linear-quadratic model.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
getIsoEffD(D1=NULL, D2=NULL, fd1=NULL, fd2=NULL, ab=NULL)

## Default S3 method:
getIsoEffD(D1=NULL, D2=NULL, fd1=NULL, fd2=NULL, ab=NULL)

## S3 method for class 'DVHs'
getIsoEffD(D1=NULL, D2=NULL, fd1=NULL, fd2=NULL, ab=NULL)

## S3 method for class 'DVHLst'
getIsoEffD(D1=NULL, D2=NULL, fd1=NULL, fd2=NULL, ab=NULL)

## S3 method for class 'DVHLstLst'
getIsoEffD(D1=NULL, D2=NULL, fd1=NULL, fd2=NULL, ab=NULL)

Arguments

D1

Default: numeric vector. Total dose 1. Alternative: One cumulative DVH (object of class DVHs, multiple cumulative DVHs from one patient with multiple structures (object of class DVHLst), or multiple cumulative DVHs from many patients, each with multiple structures (object of class DVHLstLst). See readDVH.

D2

numeric vector. Total dose 2. Ignored if D is some kind of DVH object.

fd1

numeric vector. Fractional dose 1. If D is some kind of DVH object, only the first element will be used.

fd2

numeric vector. Fractional dose 2. If D is some kind of DVH object, only the first element will be used.

ab

numeric vector. alpha/beta ratio for the relevant tissue in the linear-quadatic model. If D is some kind of DVH object, only the first element will be used.

Details

DVH methods: Calculate D2 based on D1, fd1, fd2, and ab. The default method can also calculate fd2 based on D1, D2, fd1, and ab.

Value

The (vector of) corresponding (fractional) dose value(s). If D is some kind of DVH object, the same kind of object is returned with the individual dose values converted to D2.

References

IAEA, & ICRU. (2008). Relative biological effectiveness in ion-beam therapy (Tech. Rep. No. IAEA-TR 461). Vienna, Austria: IAEA (International Atomic Energy Agency) and ICRU (International Commission on Radiation Units and Measurements).

See Also

getBED, getEQD2

Examples

1
2
3
4
5
6
# reference: 70Gy in 2Gy fractions
# new fractionation: 3Gy fractions
# calculate corresponding dose
(D2 <- getIsoEffD(D1=70, fd1=2, fd2=3, ab=c(3.5, 10)))

getIsoEffD(D1=dataMZ[[c(1, 1)]], fd1=1.8, fd2=2, ab=3.5)

Example output

[1] 59.23077 64.61538
DVH: Patient 'John Doe' (ID P123), structure 'HEART' (600 CC), Dose: 0.096-59GY
Warning message:
In getIsoEffD.default(D1 = D1$dvh[, "dose"], fd1 = fd1, fd2 = fd2,  :
  'D1' must be > 0

DVHmetrics documentation built on April 16, 2021, 9:06 a.m.