# relative_dose_1d
Python package to read 1-dimensional dose profile from text file to perform subtraction and gamma analysis.
## [Documentation](https://relative-dose-1d.readthedocs.io/en/latest/intro.html)
## Features
### For gamma analysis
* Interpolation between points
* Profile positions does not require to be equal
```{note}
* 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**<br/>
The easiest method of installation is by typing in a terminal:
```bash
pip install relative_dose_1d
```
**Windows**<br/>
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](https://www.anaconda.com/products/individual).
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**:
```bash
python
```
Finally, write:
```python
import relative_dose_1d.GUI
```
## Contributing
### Submitting bugs
The easiest way to contribute is to report bugs. Submit bugs via a Github issue [here](https://github.com/LuisOlivaresJ/relative_dose_1d/issues).
###
Suggesting ideas
Ideas are always welcome (though they might not get implemented). You can submit new ideas [here](https://github.com/LuisOlivaresJ/relative_dose_1d/issues).
## Changelog
April-2023 Versión 0.0.3
* *relative_dose_1d* is added to [PyPi](https://pypi.org/)
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](https://peps.python.org/pep-0287/) and [napoleon extension](https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html#module-sphinx.ext.napoleon)
May-2023 Version 0.1.3
* [Interpolation error](https://github.com/LuisOlivaresJ/relative_dose_1d/issues/1) solved.
Jul-2023 Version 0.1.4 - 0.1.6
* Two new functions, [build_from_array_and_step](Tools_module_label) to add physical positions, and [plot](GUI_tool_module_label) to show a GUI.
* [New GUI_tool module](GUI_tool_module_label).
* 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.
Raw data
{
"_id": null,
"home_page": "",
"name": "relative-dose-1d",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "Radiotherapy,Relative dose distribution,gamma index,python,w2CAD,mcc",
"author": "",
"author_email": "Luis Alfonso Olivares Jimenez <alfonso.cucei.udg@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/30/35/3464598b2737bff99cb7bd558521b64193cc66f9c21c23ffaed5436f1a89/relative_dose_1d-0.1.7.tar.gz",
"platform": null,
"description": "# relative_dose_1d\r\n\r\nPython package to read 1-dimensional dose profile from text file to perform subtraction and gamma analysis.\r\n\r\n\r\n\r\n## [Documentation](https://relative-dose-1d.readthedocs.io/en/latest/intro.html)\r\n\r\n## Features\r\n\r\n### For gamma analysis\r\n* Interpolation between points\r\n* Profile positions does not require to be equal\r\n```{note}\r\n* The gamma analysis algorithm is limited to absolute normalization relative to the maximum dose.\r\n```\r\n\r\n### For data import\r\n* PTW (R) and Varian (R) data formats suported.\r\n\r\n## Format specifications\r\nData should be in a numpy array with two columns, corresponding to positions and\r\ndose values, respectively.\r\n\r\nThe package has been tested with the following examples:\r\n\r\n* File in w2CAD format (used by the TPS Eclipse 16.1, from the Varian(R) company).\r\n In the algorithm, the start of the data is identified by the words: 'STOM' or 'STOD'\r\n Physical unit assumed to be in mm.\r\n\r\n* File in mcc format (used by Verisoft 7.1.0.199 software, from PTW(R) company).\r\n In the algorithm, the beginning of the data is identified by the word: 'BEGIN_DATA'\r\n Physical unit assumed to be in mm.\r\n\r\n* File in text format\r\n The data must be distributed in M \u200b\u200brows by 2 columns and separated\r\n for a blank space.\r\n The script ask for a word to identify the beginning of the data in the text file, \r\n a number to add to the positions, and a factor for distance dimension conversion.\r\n\r\n## Installation\r\n**Linux**<br/>\r\nThe easiest method of installation is by typing in a terminal:\r\n```bash\r\npip install relative_dose_1d\r\n```\r\n**Windows**<br/>\r\n\r\nPrior 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](https://www.anaconda.com/products/individual).\r\nAfter ANACONDA has been installed, open *Anaconda Prompt*. Once inside the terminal (window with a black background), follow the indication described for Linux (previous paragraph).\r\n\r\n## Usage\r\n\r\nOnce the installation is complete, open a terminal (or Anaconda Prompt in the case of Windows) and type the command **python**:\r\n\r\n```bash\r\npython\r\n```\r\nFinally, write:\r\n\r\n```python\r\nimport relative_dose_1d.GUI\r\n```\r\n\r\n## Contributing\r\n\r\n### Submitting bugs\r\nThe easiest way to contribute is to report bugs. Submit bugs via a Github issue [here](https://github.com/LuisOlivaresJ/relative_dose_1d/issues).\r\n\r\n### \r\nSuggesting ideas\r\nIdeas are always welcome (though they might not get implemented). You can submit new ideas [here](https://github.com/LuisOlivaresJ/relative_dose_1d/issues).\r\n\r\n## Changelog\r\nApril-2023 Versi\u00f3n 0.0.3\r\n * *relative_dose_1d* is added to [PyPi](https://pypi.org/)\r\n\r\nMay-2023 Version 0.1.0\r\n * It is now possible to perform unit transformation for distance using a multiplication factor, and move the origin of the coordinate system.\r\n\r\nMay-2023 Version 0.1.2\r\n * New web page for documentation, following [PEP 287 \u2013 reStructuredText Docstring Format](https://peps.python.org/pep-0287/) and [napoleon extension](https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html#module-sphinx.ext.napoleon)\r\n\r\nMay-2023 Version 0.1.3\r\n * [Interpolation error](https://github.com/LuisOlivaresJ/relative_dose_1d/issues/1) solved.\r\n\r\nJul-2023 Version 0.1.4 - 0.1.6\r\n* Two new functions, [build_from_array_and_step](Tools_module_label) to add physical positions, and [plot](GUI_tool_module_label) to show a GUI. \r\n* [New GUI_tool module](GUI_tool_module_label).\r\n* Now it is possible to change tolerance parameter for gamma evaluation.\r\n* Pass rate, total and evaluated points are now displayed on the GUI.\r\n* gamma_1d function returns the number of evaluated points.\r\n\r\nAug-2023 Version 0.1.7\r\n* The plot function can be called outside relative_dose_1d application.\r\n",
"bugtrack_url": null,
"license": "",
"summary": "Python package to read 1-dimensional dose profile from a text file to perform subtraction and gamma analysis.",
"version": "0.1.7",
"project_urls": {
"Bug-Tracker": "https://github.com/LuisOlivaresJ/relative_dose_1d/issues",
"homepage": "https://relative-dose-1d.readthedocs.io/en/latest/intro.html",
"repository": "https://github.com/LuisOlivaresJ/relative_dose_1d"
},
"split_keywords": [
"radiotherapy",
"relative dose distribution",
"gamma index",
"python",
"w2cad",
"mcc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3025edf16d915ee3330041d8fa17b127e4ec52e54a75d33202a3a15a19bd49a8",
"md5": "9790e08605620ec8a336ebe34be74d7c",
"sha256": "7ceb3fb0d8a665dfb1e83d44cb78b0ef5abccc14db7f22a1a592f98de4929708"
},
"downloads": -1,
"filename": "relative_dose_1d-0.1.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9790e08605620ec8a336ebe34be74d7c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 12408,
"upload_time": "2023-08-02T17:16:22",
"upload_time_iso_8601": "2023-08-02T17:16:22.037167Z",
"url": "https://files.pythonhosted.org/packages/30/25/edf16d915ee3330041d8fa17b127e4ec52e54a75d33202a3a15a19bd49a8/relative_dose_1d-0.1.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "30353464598b2737bff99cb7bd558521b64193cc66f9c21c23ffaed5436f1a89",
"md5": "12c8a35777699648df7bc1d792ffb618",
"sha256": "fd38faef2d69e7e4e9aa1d7acbcfb43624970a96dd739a050d58c22a00069bff"
},
"downloads": -1,
"filename": "relative_dose_1d-0.1.7.tar.gz",
"has_sig": false,
"md5_digest": "12c8a35777699648df7bc1d792ffb618",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 12066,
"upload_time": "2023-08-02T17:16:24",
"upload_time_iso_8601": "2023-08-02T17:16:24.329841Z",
"url": "https://files.pythonhosted.org/packages/30/35/3464598b2737bff99cb7bd558521b64193cc66f9c21c23ffaed5436f1a89/relative_dose_1d-0.1.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-02 17:16:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "LuisOlivaresJ",
"github_project": "relative_dose_1d",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "relative-dose-1d"
}
JSON
