Learn R Programming

DVHmetrics (version 0.3.1)

convertDVH: Convert between differential and cumulative DVH

Description

Convert between differential and cumulative DVH as well as between dose units.

Usage

convertDVH(x, toType=c("asis", "cumulative", "differential"),
           toDoseUnit=c("asis", "GY", "CGY"),
           interp=c("asis", "linear", "spline", "ksmooth", "smoothSpl"),
           nodes=NULL, perDose=TRUE)

## S3 method for class 'matrix':
convertDVH(x, toType=c("asis", "cumulative", "differential"),
           toDoseUnit=c("asis", "GY", "CGY"),
           interp=c("asis", "linear", "spline", "ksmooth", "smoothSpl"),
           nodes=NULL, perDose=TRUE)

## S3 method for class 'DVHs':
convertDVH(x, toType=c("asis", "cumulative", "differential"),
           toDoseUnit=c("asis", "GY", "CGY"),
           interp=c("asis", "linear", "spline", "ksmooth", "smoothSpl"),
           nodes=NULL, perDose=TRUE)

## S3 method for class 'DVHLst':
convertDVH(x, toType=c("asis", "cumulative", "differential"),
           toDoseUnit=c("asis", "GY", "CGY"),
           interp=c("asis", "linear", "spline", "ksmooth", "smoothSpl"),
           nodes=NULL, perDose=TRUE)

## S3 method for class 'DVHLstLst':
convertDVH(x, toType=c("asis", "cumulative", "differential"),
           toDoseUnit=c("asis", "GY", "CGY"),
           interp=c("asis", "linear", "spline", "ksmooth", "smoothSpl"),
           nodes=NULL, perDose=TRUE)

Arguments

x
One DVH (object of class matrix or 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 (obj
toType
character. Convert the DVH to this type. "asis" keeps the current DVH type.
toDoseUnit
character. Convert the DVH to this dose unit. "asis" keeps the current dose unit.
interp
character. Interpolation method for the differential DVH. "asis" and "linear" for no interpolation. "spline" for FMM spline interpolation using splinefun<
nodes
numeric. Minimum number of nodes to use in interpolation. Number of nodes is kept as is for NULL or if larger than nodes.
perDose
logical. Are the differential DVH volume values per unit dose?

Value

  • Depending on the input, an object of class matrix, DVHs, DVHLst, or DVHLstLst.

See Also

dpill, locpoly, splinefun, smooth.spline, readDVH, showDVH

Examples

Run this code
res <- convertDVH(dataMZ[[c(1, 1)]],
                  toType="cumulative",
                  toDoseUnit="CGY")

Run the code above in your browser using DataLab