DVH.extract: Extracts a DVH from a vector of dose bins

In robertogattabs/MV2:

Description

Function that given a vector of dose bins (either a vector got from sampling a 3D mesh or a vector of simple values of dose) extracts the DVH that summarizes that vector. Either volbin.side, voxel.volume or total.volume have to be not NULL values. The priority list for computing the volume (if more than one argument is not NULL) is total.volume -> voxel.volume -> volbin.side.

Usage

DVH.extract(
  x,
  max.dose = NULL,
  dose.bin = 0.25,
  dvh.type = c("differential", "cumulative"),
  vol.distr = c("relative", "absolute"),
  createObj = TRUE,
  volbin.side = NULL,
  voxel.volume = NULL,
  total.volume = NULL
)

Arguments

x	vector of dose bins.
max.dose	Upper dose bound for limiting the DVH computation.
dose.bin	The dose bin for DVH computation in Gy.
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).
createObj	if TRUE returns a dvhmatrix class object.
volbin.side	The value of the side of each cube (in cm) that builds the final volume of the structure.
voxel.volume	The value of the volume of a single voxel (in cc) to compute the ROI total volume
total.volume	The value of the total volume of the ROI (in cc)

Value

Either an object of class dvhmatrix or a matrix according the argument dvh type.

Examples

## simulate a vector of dose bins
doses <- c(rnorm(n = 10000, mean = 45, sd = 3), rnorm(n = 7000, mean = 65, sd = 2.5))

## creates a dvhmatrix class object
DVH<-DVH.extract(x = doses)

robertogattabs/MV2 documentation built on May 17, 2021, 4:11 p.m.