toy.load.patient {espadon}R Documentation

Load a toy patient for test

Description

The toy.load.patient creates a dummy "patient" class object. It is used for the test.

Usage

toy.load.patient(
  modality = c("ct", "mr", "rtdose", "rtstruct"),
  roi.name = c("eye", "optical nerve", "brain", "labyrinth processing unit",
    "energy unit", "gizzard", "ghost container", "exhaust valve"),
  dxyz = c(1, 1, 1),
  beam.nb = 7
)

Arguments

modality

String vector, whose elements are chosen among the modalities "ct", "mr", "rtstruct" and "rtdose".

roi.name

String vector, whose elements are chosen among the regions of interest (RoI) "eye", "optical nerve", "brain", "labyrinth processing unit", "energy unit", "gizzard", "ghost container" and "exhaust valve". Note that the RoI "couch", "patient" and "ptv" are still present.

dxyz

Vector of length 3, representing the x, y, z steps in mm, between ct, mr and rtdose voxels.

beam.nb

Positive integer. Number of radiotherapy beams in rtdose modality.

Value

Returns an toy object of "patient" class, containing the modalities defined in modality. See espadon.class for class definitions.

Examples

# loading of toy-patient objects (decrease dxyz for  better result)
step <- 5
pat <- toy.load.patient (dxyz = rep (step, 3), beam.nb = 2)
str (pat, max.level = 2)

[Package espadon version 1.2.0 Index]