HITXML-package: Package to create XML plans for HIT.
In HITXML: Planning tools for ion beam therapy

Description Details Author(s) See Also Examples

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.

Command line scripts are distributed with this package and can be started using Rscript or R as an interpreter (Linux, Max). The use is explained in the 'example' section below. The package needs data on accelerator setting that are proprietary data to HIT (libC) and are therefore NOT distributed with the package. Users of DKFZ / HIT contact s.greilich@dkfz.de for more information.

In case you encounter an error message like 'bad interpreter /usr/bin/Rscript^M' the Unix line-ends (default) have been accidentally changed to Windows style. You can fix this by 'dos2unix' for all '.R'-files.

If run successful, output will be a request and a plan file with a path ready to be copied onto the control machine as well as a pdf showing the field shape etc.

For the latter, we recommend a pdf viewer capable of reloading updating files (i.e. evince, Sumatra, ... *not* Acrobat reader).

Suggestion for prompt under Windows $P$_$G$S

The fluence to dose conversion uses tabulated stopping power data for liquid water from ICRU49/73 reports from the R-package libamtrack.

HIT_XML uses the txtplot function from Claus E. Andersen, DTU Risoe.

!!IMPORTANT!!: If your plan should not work at HIT, esp. when successfully applied before or with only one ion species double check with accelerator team if MD checksums for the control system have been updated after any kind of system maintainance. This is the most likely cause for HITXML plans to fail.

Steffen Greilich, Sarah Stefanowicz and others

Maintainer: Steffen Greilich <s.greilich@dkfz.de>

XML

## Not run: 
## To start the default planning tool, enter (using command line):
Rscript -e "HITXML::HITXML()"

# This will start the interactive HIT_XML.Create_Plan.R which
# allows to create simple 2D plans of homogenous square or annular fields

# Other (non-interactive) scripts that all can be found in the exec-folder are:
HIT_XML.Create_SOBP.R           - Creates weighted fluences to form an SOBP either physically
                                  or biologically weighted on the central axis, stores weights
                                  in SOBP.dat which can turn read in by FLUKA
HIT_XML.Create_Plan_from_SOBP.R - Creates full 3D plan from SOBP.dat (i.e. energy weights plus
                                  2D homogenous fields for each energy layer)
HIT_XML.Forward_Compute_PBR.R   - forward-caculate fields from plans or beam records (PBR files)
HIT_XML.Forward_Compute_SOBP.R  - forward-caculate fields from SOBP.dat files (Fluka input format)

## End(Not run)