HITXML: Planning tools for ion beam therapy
Version 0.9.8

Code to create simple XML-based irradiation plans and forward-calculate plans or beam records. The functionality is consider to be used withs sscript distributed with this package (in /exec). The package is tailored to use with the scanning ion beam at the Heidelberg Ion-beam Therapy center (HIT) but might be useful for generic application as well.

Browse man pages Browse package API and functions Browse package files

AuthorSteffen Greilich, Sarah Stefanowicz, Grischa Klimpki, Tina Pfeiler, Eduardo Yukihara and others
Date of publication2016-11-07 14:28:19
MaintainerSteffen Greilich <s.greilich@dkfz.de>
LicenseGPL (>=3)
Version0.9.8
Package repositoryView on R-Forge
InstallationInstall the latest version of this package by entering the following in R:
install.packages("HITXML", repos="http://R-Forge.R-project.org")

Man pages

beam.spot.grid: beam.spot.grid
dataSIS-class: dataSIS structure
dataSPC: Class for SPC
dataSpectrum: Constructor for 'dataSpectrum' class
dataSpectrum-class: Class for particle spectra
dose.Gy: Dose for a spectrum
get.multivariate.weighted.histogram: Multivariate histogram from weighted variable
HITXML-package: Package to create XML plans for HIT.
HT.cost.function: HX.cost.function
HT.optimize.field: HX.optimize.field
HX.compute.field: HX.compute.field
Mass.Stopping.Power.MeV.cm2.g: Mass stopping power for all energy bins in a spectrum
plot-dataSpectrum-method: Method plot
read.FLUKA.phase.space: Import of phase space files scored with FLUKA
spectrum: Create empty spectrum
spectrum.at.depth.g.cm2: R function for interpolation of spc files with depth, was in...
total.n.particles: Total number of particles in a spectrum

Functions

D.cut.Gy Source code
HITXML Man page Source code
HITXML-package Man page
HX.RBE.LEM Source code
HX.compute.field Man page Source code
HX.construct.field Source code
HX.construct.field.circle Source code
HX.construct.field.shells Source code
HX.construct.field.square Source code
HX.correct.user.input Source code
HX.cost.function Man page Source code
HX.custom.menu Source code
HX.get.BP.depth Source code
HX.get.available.energies Source code
HX.get.user.input.IES Source code
HX.get.user.input.basic Source code
HX.getMinAndMax Source code
HX.optimize.field Man page Source code
HX.prompt.user Source code
HX.read.PBR Source code
HX.read.defaults Source code
HX.save.defaults Source code
Mass.Stopping.Power.MeV.cm2.g Man page
RBE.LEM.single Source code
RBE.initial Source code
SPC.interpolate Source code
SPC.read Source code
SPC.tapply Source code
alpha.X Source code
alpha.ion Source code
beam.spot.grid Man page
beta.X Source code
beta.ion Source code
clan.create.latex.table Source code
clan.txtplot Source code
dataDDD Source code
dataDDDset Source code
dataRBE Source code
dataSIS Source code
dataSIS-class Man page
dataSPC Source code
dataSPCset Source code
dataSpectrum Man page Source code
dataSpectrum-class Man page
dddSPC Man page
depth.dose Source code
dose.Gy Man page
get.IES.index Source code
get.clostest.beam.energy.MeV.u Source code
get.ddd Source code
get.dose.Gy Source code
get.dose.Gy.from.set Source code
get.foci Source code
get.focus.FWHM.mm Source code
get.intensities Source code
get.intensity.N.s Source code
get.multivariate.weighted.histogram Man page Source code
get.spc Source code
leading.blanks Source code
onLoad Source code
onUnload Source code
plot,dataSpectrum-method Man page
plot.SOBP Source code
r.nucleus.um Source code
read.FLUKA.phase.space Man page Source code
read.item.character Source code
read.item.numeric Source code
redistribute.spc Source code
s.max Source code
spectra Source code
spectrum Man page Source code
spectrum.Mass.Stopping.Power.MeV.cm2.g Source code
spectrum.at.depth.g.cm2 Man page Source code
spectrum.dLET Source code
spectrum.dose.Gy Source code
spectrum.fLET Source code
spectrum.get.depth.g.cm2 Source code
spectrum.total.n.particles Source code
total.n.particles Man page
writeDDD Source code

Files

DESCRIPTION
NAMESPACE
R
R/HX.RBE.LEM.R
R/HX.compute.field.R
R/HX.construct.field.R
R/HX.construct.field.circle.R
R/HX.construct.field.shells.R
R/HX.construct.field.square.R
R/HX.correct.user.input.R
R/HX.cost.function.R
R/HX.custom.menu.R
R/HX.get.BP.depth.R
R/HX.get.available.energies.R
R/HX.get.user.input.IES.R
R/HX.get.user.input.basic.R
R/HX.getMinAndMax.R
R/HX.optimize.field.R
R/HX.prompt.user.R
R/HX.read.PBR.R
R/HX.read.defaults.R
R/HX.routines.R
R/HX.save.defaults.R
R/clan.create.latex.table.R
R/clan.leading.blanks.R
R/clan.txtplot.R
R/dataDDD.R
R/dataDDDset.R
R/dataRBE.R
R/dataSIS.R
R/dataSPC.R
R/dataSPCset.R
R/dataSpectrum.R
R/get.multivariat.weighted.histogram.R
R/plot.SOBP.R
R/read.FLUKA.phase.space.R
R/read.item.character.R
R/read.item.numeric.R
R/zzz.R
README
exec
exec/Extract.Spectra.HITXML.R
exec/HIT_XML.Create_Plan.R
exec/HIT_XML.Create_Plan_from_SOBP.R
exec/HIT_XML.Create_SOBP.R
exec/HIT_XML.Forward_Compute_PBR.R
exec/HIT_XML.Forward_Compute_SOBP.R
exec/HIT_XML.defaults
exec/HIT_XML.defaults.DEFAULT
inst
inst/extdata
inst/extdata/FLUKA
inst/extdata/FLUKA/sg73000_SOBP_spectra
inst/extdata/FLUKA/sg73000_SOBP_spectra/README.txt
inst/extdata/FLUKA/sg73000_SOBP_spectra/SOBP_sg73000.dat
inst/extdata/FLUKA/sg73000_SOBP_spectra/mgdraw_sg73000.f
inst/extdata/FLUKA/sg73000_SOBP_spectra/sg73000.flair
inst/extdata/FLUKA/sg73000_SOBP_spectra/sg73000.inp
inst/extdata/FLUKA/sg73000_SOBP_spectra/sg73000_GrischaPhaseSpace_SOBP.R
inst/extdata/FLUKA/sg73000_SOBP_spectra/sg73001.flair
inst/extdata/FLUKA/sg73000_SOBP_spectra/sg73001.inp
inst/extdata/FLUKA/sg73000_SOBP_spectra/sg73001_GrischaPhaseSpace_RisingFlank.R
inst/extdata/FLUKA/sg73000_SOBP_spectra/source_sg73000.f
inst/extdata/FLUKA/sg74000_SPC
inst/extdata/FLUKA/sg74000_SPC/12C_generic_270_3MM.Rda
inst/extdata/FLUKA/sg74000_SPC/README.txt
inst/extdata/FLUKA/sg74000_SPC/mgdraw_sg74000.f
inst/extdata/FLUKA/sg74000_SPC/sg74000_GeneralSPC_template.flair
inst/extdata/FLUKA/sg74000_SPC/sg74000_GeneralSPC_template.inp
inst/extdata/FLUKA/sg74000_SPC/sg74000_GeneralSPCs.R
inst/extdata/FLUKA/sg74001_DEDX
inst/extdata/FLUKA/sg74001_DEDX/README.txt
inst/extdata/FLUKA/sg74001_DEDX/dEdX_FLUKA_WATER.Rda
inst/extdata/FLUKA/sg74001_DEDX/mgdraw_sg74001.f
inst/extdata/FLUKA/sg74001_DEDX/sg74001_DEDX.R
inst/extdata/FLUKA/sg74001_DEDX/sg74001_DEDX_template-1001_dEdx
inst/extdata/FLUKA/sg74001_DEDX/sg74001_DEDX_template-2001_dEdx
inst/extdata/FLUKA/sg74001_DEDX/sg74001_DEDX_template-3001_dEdx
inst/extdata/FLUKA/sg74001_DEDX/sg74001_DEDX_template-4001_dEdx
inst/extdata/FLUKA/sg74001_DEDX/sg74001_DEDX_template-5001_dEdx
inst/extdata/FLUKA/sg74001_DEDX/sg74001_DEDX_template-6001_dEdx
inst/extdata/FLUKA/sg74001_DEDX/sg74001_DEDX_template.flair
inst/extdata/FLUKA/sg74001_DEDX/sg74001_DEDX_template.inp
inst/extdata/SOBP_sg73002.dat
man
man/HITXML-package.Rd
man/HT.cost.function.Rd
man/HT.optimize.field.Rd
man/HX.compute.field.Rd
man/Mass.Stopping.Power.MeV.cm2.g.Rd
man/beam.spot.grid.Rd
man/dataSIS-class.Rd
man/dataSPC.Rd
man/dataSpectrum-class.Rd
man/dataSpectrum.Rd
man/dose.Gy.Rd
man/get.multivariate.weighted.histogram.Rd
man/plot-dataSpectrum-method.Rd
man/read.FLUKA.phase.space.Rd
man/spectrum.Rd
man/spectrum.at.depth.g.cm2.Rd
man/total.n.particles.Rd
src
src/HITXML.cpp
HITXML documentation built on May 21, 2017, 12:18 a.m.