DVH.generate: Function that creates a 'dvhmatrix' class object

Description Usage Arguments Details Value References Examples

View source: R/dvh_mod.R

Description

Creates an object of class dvhmatrix.

Usage

1
2
3
4
DVH.generate(dvh.number, type = c("random", "convex", "concave", "mix"),
  dvh.type = c("differential", "cumulative"), vol.distr = c("relative",
  "absolute"), max.dose = 75, dose.bin = 0.5, volbin.side = 2.5,
  min.vol = 180, max.vol = 220)

Arguments

dvh.number

The number of DVHs to be generated

type

The type of DVH to be generated: random generates all possible variation in dose distribution, convex for DVH similar to PTV structures with good dose homogeneity to high levels, concave for DVH with low level of dose delivered to the volume as a spared structure, mix for DVH where dose distribution is averaged in the whole volume spectrum.

dvh.type

The type of volume distribution to be created: differential or cumulative.

vol.distr

Defines if the volume bins have to be divided by the total volume of the structure (relative) or not (absolute).

max.dose

The upper bound of the dose distribution to be simulated.

dose.bin

The dose bin in Gy to compute the value of volume parts in the final DVH.

volbin.side

The value of the side of each cube (in mm) that builds the final volume of the simulated structure.

min.vol

The minimum volume of the range to be simulated.

max.vol

The maximum volume of the range to be simulated.

Details

Dose Volume Histograms (DVH) are the basic representation of how the radiation doses distribute inside structures. Usually they are shown in two forms: differential or cumulative being related each other because cumultive DVHs are the integral form of "differential" ones. This function provides a siumlated series of structures with the features defined by function parameters. The simulated series are useful for producing simulated Dose/Response models using the modeling functions defined in this package. class objects.

Value

An object of dvhmatrix class.

References

Van den Heuvela F. Decomposition analysis of differential dose volume histograms. Med Phys. 2006 Feb;33(2):297-307. PubMed PMID: 16532934.

Examples

1
2
3
4
5
6
## creates a dvhmatrix object with 200 differential - relative histograms
a<-DVH.generate(dvh.number=200, dvh.type="differential", vol.distr="relative")

## creates a dvhmatrix object containing 150 cumulative - absolute histograms
## maximum dose in simulated series is 60 Gy
b<-DVH.generate(dvh.number=150, dvh.type="cumulative", vol.distr="absolute", max.dose=60)

robertogattabs/RadAgent documentation built on June 30, 2018, 12:02 a.m.