create.beam: Create an empty beam(s) object

In planit-group/Rplanit: Radiotherapy with ion beams - planning, simulations and analysis

Create an empty beam(s) object

Description

The beam(s) object is a dataframe with columns:

• "x_iso, y_iso, z_iso"Stuff

• "parameter 2"Stuff

Usage

create.beam(particle = "1H", beamLine = "simpleProtons", x_iso = 0,
  y_iso = 0, z_iso = 0, gantryAngle = 0, patientAngle = 0,
  fluence = 1, energy = 0, deflX = 0, deflY = 0, x_s = 0,
  y_s = 0, z_s = 0)

Arguments

particle	particle name
beamLine	the beamLine name (i.e. the corresponding LUT to use).
x_iso, y_iso, z_iso	Coordinates of the isocenter (mm).
gantryAngle, patientAngle	Gantry and patient support angles (degree).
fluence	The number of particles for the beam(s).
energy	The kinetic energy of the particles (MeV/u).
deflX, deflY	Deflections on the plane normal to the beam direction and passing through the isocenter (mm).
x_s, y_s, z_s	Spot coordinates, i.e. the position of the Bragg peak (mm).
nbeams	The number of the beams

See Also

Other Beams: add.field, convert.fluence2mu, convert.mu2fluence, create.field, display.beamports, display.beams, get.beams, get.ct.entrance.point, get.isocenter, get.rays, read.beams, write.beams

planit-group/Rplanit documentation built on July 4, 2025, 2:17 p.m.