Raidionics reporting and data system backend (RADS)
Project description
Raidionics processing backend for performing segmentation and computation of standardized report (RADS)
The code corresponds to the Raidionics backend for running processing pipelines over MRI/CT scans. The segmentation of
a few organs or tumor types, as well as the generation of standardized reports are included.
The module can either be used as a Python library, as CLI, or as Docker container.
Installation
pip install raidionicsrads
or
pip install git+https://github.com/dbouget/raidionics_rads_lib.git
Getting started
Notebooks
Below are Jupyter Notebooks including different examples on how to get started with the segmentation and reporting tasks, either over the brain or mediastinal area.
CLI
raidionicsrads -c CONFIG (-v debug)
CONFIG should point to a configuration file (*.ini), specifying all runtime parameters, according to the pattern from blank_main_config.ini.
Python module
from raidionicsrads.compute import run_rads
run_rads(config_filename="/path/to/main_config.ini")
Docker
When calling Docker images, the --user flag must be properly used in order for the folders and files created inside the container to inherit the proper read/write permissions. The user ID is retrieved on-the-fly in the following examples, but it can be given in a more hard-coded fashion if known by the user.
:warning: The Docker image can only perform inference using the CPU, there is no GPU support at this stage.
docker pull dbouget/raidionics-rads:v1.3-py39-cpu
For opening the Docker image and interacting with it, run:
docker run --entrypoint /bin/bash -v /home/<username>/<resources_path>:/workspace/resources -t -i --runtime=nvidia --network=host --ipc=host --user $(id -u) dbouget/raidionics-rads:v1.3-py39-cpu
The /home/<username>/<resources_path> before the column sign has to be changed to match a directory on your local
machine containing the data to expose to the docker image. Namely, it must contain folder(s) with images you want to
run inference on, as long as a folder with the trained models to use, and a destination folder where the results will
be placed.
For launching the Docker image as a CLI, run:
docker run -v /home/<username>/<resources_path>:/workspace/resources -t -i --runtime=nvidia --network=host --ipc=host --user $(id -u) dbouget/raidionics-rads:v1.3-py39-cpu -c /workspace/resources/<path>/<to>/main_config.ini -v <verbose>
The <path>/<to>/main_config.ini must point to a valid configuration file on your machine, as a relative path to the /home/<username>/<resources_path> described above.
For example, if the file is located on my machine under /home/myuser/Data/RADS/main_config.ini,
and that /home/myuser/Data is the mounted resources partition mounted on the Docker image, the new relative path will be RADS/main_config.ini.
The <verbose> level can be selected from [debug, info, warning, error].
How to cite
If you are using Raidionics in your research, please cite the following references.
The final software including updated performance metrics for preoperative tumors and introducing postoperative tumor segmentation:
@article{bouget2023raidionics,
author = {Bouget, David and Alsinan, Demah and Gaitan, Valeria and Holden Helland, Ragnhild and Pedersen, André and Solheim, Ole and Reinertsen, Ingerid},
year = {2023},
month = {09},
pages = {},
title = {Raidionics: an open software for pre-and postoperative central nervous system tumor segmentation and standardized reporting},
volume = {13},
journal = {Scientific Reports},
doi = {10.1038/s41598-023-42048-7},
}
For the preliminary preoperative tumor segmentation validation and software features:
@article{bouget2022preoptumorseg,
title={Preoperative Brain Tumor Imaging: Models and Software for Segmentation and Standardized Reporting},
author={Bouget, David and Pedersen, André and Jakola, Asgeir S. and Kavouridis, Vasileios and Emblem, Kyrre E. and Eijgelaar, Roelant S. and Kommers, Ivar and Ardon, Hilko and Barkhof, Frederik and Bello, Lorenzo and Berger, Mitchel S. and Conti Nibali, Marco and Furtner, Julia and Hervey-Jumper, Shawn and Idema, Albert J. S. and Kiesel, Barbara and Kloet, Alfred and Mandonnet, Emmanuel and Müller, Domenique M. J. and Robe, Pierre A. and Rossi, Marco and Sciortino, Tommaso and Van den Brink, Wimar A. and Wagemakers, Michiel and Widhalm, Georg and Witte, Marnix G. and Zwinderman, Aeilko H. and De Witt Hamer, Philip C. and Solheim, Ole and Reinertsen, Ingerid},
journal={Frontiers in Neurology},
volume={13},
year={2022},
url={https://www.frontiersin.org/articles/10.3389/fneur.2022.932219},
doi={10.3389/fneur.2022.932219},
issn={1664-2295}
}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file raidionicsrads-1.3.2.tar.gz.
File metadata
- Download URL: raidionicsrads-1.3.2.tar.gz
- Upload date:
- Size: 45.2 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e0885414342f89135245e0825b1af83c5cfe02d70bdfad7a049e875089de9021
|
|
| MD5 |
605e67d36374e9ea99463ec3a7a1a25f
|
|
| BLAKE2b-256 |
8c9e3ffbce083544dd92de314164a6e3ca0b3cca8d38d5cfc66ecf4238423f3c
|
File details
Details for the file raidionicsrads-1.3.2-py3-none-any.whl.
File metadata
- Download URL: raidionicsrads-1.3.2-py3-none-any.whl
- Upload date:
- Size: 45.3 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
452463b968bac0ce768f67b8dba55ec8377c9f0562db6a7261dd337a7a9bc6fc
|
|
| MD5 |
874c1aae95ea54bece6ea3cb5c02ff0c
|
|
| BLAKE2b-256 |
fc6b4a0b7ac2a55239ce82f80c62fbc4f3737b5ff78b5ae74ca0baba2650aac4
|