get.values.for.beam: Evaluate BeamLUT (obsolete)

View source: R/lut-functions.R

get.values.for.beamR Documentation

Evaluate BeamLUT (obsolete)

Description

Evaluate from scratch the beamLUT of the selected beam(s) for the specific plan. The beam(s) can be one or more (by using a vector of indices). If the beams are more than one, the corresponding beamLUT is given by the net contribution of all the specified beams Optionally it is possible to specify also the fluences (i.e. the number of particles) for each beam.

Usage

## S3 method for class 'for.beam'
get.values(beams = NULL, beam.index, fluence = NULL,
  plan, variables = "Dose[Gy]", temp.name = "temp",
  remove.temp = TRUE)

Arguments

beam.index

index of the beam (it can be a vector if indices)

fluence

the fluence (number of particles) for the beam(s). It can be a vector

plan

the plan object

temp.name

temporary prefix of the plan name used during the evaluation

remove.temp

TRUE to remove temporary files after the evaluation

variable

string specifing the variable to be evaluated. It can be a vecor of variables

Value

a values object

See Also

Other BeamLUT: combine.beamLUTs, get.alpha.beta.beamLUT, get.bdose.beamLUT, get.beamLUTs, get.dose.beamLUT, get.letd.beamLUT, get.rbe.beamLUT, read.beamLUTs, read.beamLUT, write.beamLUT


planit-group/Rplanit documentation built on Dec. 5, 2022, 11:10 p.m.