relative_dose_1d

Python package to read 1-dimensional dose profile from text file to perform subtraction and gamma analysis.

Documentation

Features

For gamma analysis

• Interpolation between points
• Profile positions does not require to be equal

* The gamma analysis algorithm is limited to absolute normalization  relative to the maximum dose.

For data import

• PTW (R) and Varian (R) data formats suported.

Format specifications

Data should be in a numpy array with two columns, corresponding to positions and dose values, respectively.

The package has been tested with the following examples:

• File in w2CAD format (used by the TPS Eclipse 16.1, from the Varian(R) company). In the algorithm, the start of the data is identified by the words: 'STOM' or 'STOD' Physical unit assumed to be in mm.

• File in mcc format (used by Verisoft 7.1.0.199 software, from PTW(R) company). In the algorithm, the beginning of the data is identified by the word: 'BEGIN_DATA' Physical unit assumed to be in mm.

• File in text format The data must be distributed in M ​​rows by 2 columns and separated for a blank space. The script ask for a word to identify the beginning of the data in the text file, a number to add to the positions, and a factor for distance dimension conversion.

Installation

Linux
The easiest method of installation is by typing in a terminal:

pip install relative_dose_1d

Windows

Prior to installation, it is necessary to have a python package manager. If you are not familiar with Python packages, it is recommended to use ANACONDA. After ANACONDA has been installed, open Anaconda Prompt. Once inside the terminal (window with a black background), follow the indication described for Linux (previous paragraph).

Usage

Once the installation is complete, open a terminal (or Anaconda Prompt in the case of Windows) and type the command python:

python

Finally, write:

import relative_dose_1d.GUI

Contributing

Submitting bugs

The easiest way to contribute is to report bugs. Submit bugs via a Github issue here.

Suggesting ideas Ideas are always welcome (though they might not get implemented). You can submit new ideas here.

Changelog

April-2023 Versión 0.0.3

• relative_dose_1d is added to PyPi

May-2023 Version 0.1.0

• It is now possible to perform unit transformation for distance using a multiplication factor, and move the origin of the coordinate system.

May-2023 Version 0.1.2

• New web page for documentation, following PEP 287 – reStructuredText Docstring Format and napoleon extension

May-2023 Version 0.1.3

• Interpolation error solved.

Jul-2023 Version 0.1.4 - 0.1.6

• Two new functions, build_from_array_and_step to add physical positions, and plot to show a GUI.
• New GUI_tool module.
• Now it is possible to change tolerance parameter for gamma evaluation.
• Pass rate, total and evaluated points are now displayed on the GUI.
• gamma_1d function returns the number of evaluated points.

Aug-2023 Version 0.1.7

• The plot function can be called outside relative_dose_1d application.