rt-utils 1.2.6__tar.gz → 1.3.1__tar.gz

{rt-utils-1.2.6 → rt_utils-1.3.1}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2021 Qurit
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2021 Qurit
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

rt_utils-1.3.1/MANIFEST.in

@@ -0,0 +1,10 @@
+include LICENSE
+include README.md
+include RELEASING.md
+
+prune tests
+prune Paper
+prune src
+exclude NIFTI_conversion.py
+exclude nifti2rt.py
+exclude RTUTILS_read_world_example_for_PET.ipynb

{rt-utils-1.2.6/rt_utils/rt_utils.egg-info → rt_utils-1.3.1}/PKG-INFO

@@ -1,160 +1,241 @@
-Metadata-Version: 2.1
-Name: rt-utils
-Version: 1.2.6
-Summary: A small library for handling masks and RT-Structs
-Home-page: https://github.com/qurit/rtutils
-Author: Asim Shrestha
-Author-email: asim.shrestha@hotmail.com
-Keywords: RTStruct,Dicom,Pydicom
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Typing :: Typed
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Topic :: Software Development :: Libraries
-Classifier: Topic :: Utilities
-Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
-Classifier: Topic :: Scientific/Engineering :: Image Processing
-Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
-Classifier: Topic :: Scientific/Engineering :: Physics
-Classifier: Intended Audience :: Healthcare Industry
-Classifier: Intended Audience :: Science/Research
-Classifier: Intended Audience :: Developers
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
-License-File: LICENSE
-
-<p align="center">
-  <img src="https://raw.githubusercontent.com/qurit/rt-utils/main/src/rt-utils-logo.png" height="300"/>
-</p>
-<p align="center">
-  <em>A minimal Python library for RT Struct manipulation</em>
-</p>
-<p align="center">
-    <img src="https://github.com/qurit/rt-utils/workflows/Python%20application/badge.svg" height="18">
-    <img src="https://img.shields.io/pypi/pyversions/rt-utils" alt="Python version" height="18">
-    <a href="https://pypi.org/project/rt-utils"><img src="https://badge.fury.io/py/rt-utils.svg" alt="PyPI version" height="18"></a>  
-    <img alt="PyPI - License" src="https://img.shields.io/github/license/qurit/rt-utils?color=g" height="18" />
-</p>
- 
----
- 
-RT-Utils is motivated to allow physicians and other users to view the results of segmentation performed on a series of DICOM images. RT-Utils allows you to create or load RT Structs, extract 3d masks from RT Struct ROIs, easily add one or more regions of interest, and save the resulting RT Struct in just a few lines!
-
-## How it works
-RT-Utils provides a builder class to faciliate the creation and loading of an RT Struct. From there, you can add ROIs through binary masks and optionally input the colour of the region along with the region name.
-
-The format for the ROI mask is an nd numpy array of type bool. It is an array of 2d binary masks, one plane for each slice location within the DICOM series. The slices should be sorted in ascending order within the mask. Through these masks, we extract the contours of the regions of interest and place them within the RT Struct file. Note that there is currently only support for the use of one frame of reference UID and structered set ROI sequence. Also note that holes within the ROI may be handled poorly.
-
-## Installation
-```
-pip install rt_utils
-```
-
-## Creating new RT Structs
-```Python
-from rt_utils import RTStructBuilder
-
-# Create new RT Struct. Requires the DICOM series path for the RT Struct.
-rtstruct = RTStructBuilder.create_new(dicom_series_path="./testlocation")
-
-# ...
-# Create mask through means such as ML
-# ...
-
-# Add the 3D mask as an ROI.
-# The colour, description, and name will be auto generated
-rtstruct.add_roi(mask=MASK_FROM_ML_MODEL)
-
-# Add another ROI, this time setting the color, description, and name
-rtstruct.add_roi(
-  mask=MASK_FROM_ML_MODEL, 
-  color=[255, 0, 255], 
-  name="RT-Utils ROI!"
-)
-
-rtstruct.save('new-rt-struct')
-```
-
-## Adding to existing RT Structs
-```Python
-from rt_utils import RTStructBuilder
-import matplotlib.pyplot as plt
-
-# Load existing RT Struct. Requires the series path and existing RT Struct path
-rtstruct = RTStructBuilder.create_from(
-  dicom_series_path="./testlocation", 
-  rt_struct_path="./testlocation/rt-struct.dcm"
-)
-
-# Add ROI. This is the same as the above example.
-rtstruct.add_roi(
-  mask=MASK_FROM_ML_MODEL, 
-  color=[255, 0, 255], 
-  name="RT-Utils ROI!"
-)
-
-rtstruct.save('new-rt-struct')
-```
-
-## Creation Results
-<p align="center">
-  <img src="https://raw.githubusercontent.com/qurit/rt-utils/main/src/contour.png" width="1000"/>
-</p>
-<p align="center">
-  The results of a generated ROI with a dummy mask, as viewed in Slicer.
-</p>
-
-<p align="center">
-  <img src="https://raw.githubusercontent.com/qurit/RT-Utils/main/src/liver-contour.png" width="1000"/>
-</p>
-<p align="center">
-  The results of a generated ROI with a liver segmentation model, as viewed in Slicer. (Note the underlying patient data has been hidden)
-</p>
-
-## Loading an existing RT Struct contour as a mask
-```Python
-from rt_utils import RTStructBuilder
-import matplotlib.pyplot as plt
-
-# Load existing RT Struct. Requires the series path and existing RT Struct path
-rtstruct = RTStructBuilder.create_from(
-  dicom_series_path="./testlocation", 
-  rt_struct_path="./testlocation/rt-struct.dcm"
-)
-
-# View all of the ROI names from within the image
-print(rtstruct.get_roi_names())
-
-# Loading the 3D Mask from within the RT Struct
-mask_3d = rtstruct.get_roi_mask_by_name("ROI NAME")
-
-# Display one slice of the region
-first_mask_slice = mask_3d[:, :, 0]
-plt.imshow(first_mask_slice)
-plt.show()
-```
-
-## Loading Results
-<p align="center">
-  <img src="https://raw.githubusercontent.com/qurit/rt-utils/main/src/loaded-mask.png" height="300"/>
-</p>
-<p align="center">
-  The results of a loading an exisiting ROI as a mask, as viewed in Python.
-</p>
-
-## Additional Parameters
-The add_roi method of our RTStruct class has a multitude of optional parameters available. Below is a comprehensive list of all these parameters and what they do.
-- <b>color</b>: This parameter can either be a colour string such as '#ffffff' or a RGB value as a list such as '[255, 255, 255]'. This parameter will dictate the colour of your ROI when viewed in a viewing program. If no colour is provided, RT Utils will pick from our internal colour palette based on the ROI Number of the ROI.
-- <b>name</b>: A str value that defaults to none. Used to set the name of the ROI within the RT Struct. If the name is none, RT Utils will set a name of ROI-{ROI Number}.
-- <b>description</b>: A str value that sets the description of the ROI within the RT Struct. If no value is provided, the description is just left blank.
-- <b>use_pin_hole</b>: A boolean value that defaults to false. If set to true, lines will be erased through your mask such that each separate region within your image can be encapsulated via a single contour instead of contours nested within one another. Use this if your RT Struct viewer of choice does not support nested contours / contours with holes.
-- <b>approximate_contours</b>: A boolean value that defaults to True which defines whether or not approximations are made when extracting contours from the input mask. Setting this to false will lead to much larger contour data within your RT Struct so only use this if as much precision as possible is required.
-- <b>roi_generation_algorithm</b>: An enum value that defaults to 0 which defines what ROI generation algorithm will be used. 0=\'AUTOMATIC\', 1=\'SEMIAUTOMATIC\', or 2=\'MANUAL\'.
+Metadata-Version: 2.4
+Name: rt-utils
+Version: 1.3.1
+Summary: A small library for handling masks and RT-Structs
+Author-email: Asim Shrestha <asim.shrestha@hotmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/qurit/rt-utils
+Project-URL: Repository, https://github.com/qurit/rt-utils
+Project-URL: Issues, https://github.com/qurit/rt-utils/issues
+Keywords: RTStruct,Dicom,Pydicom
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Utilities
+Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
+Classifier: Topic :: Scientific/Engineering :: Image Processing
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Intended Audience :: Healthcare Industry
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydicom
+Requires-Dist: numpy
+Requires-Dist: opencv-python>=4.0.0
+Provides-Extra: nifti
+Requires-Dist: SimpleITK; extra == "nifti"
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Dynamic: license-file
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/qurit/rt-utils/main/src/RTUtils_logo.png" height="300"/>
+</p>
+<p align="center">
+  <em>A minimal Python library for RT Struct manipulation</em>
+</p>
+<p align="center">
+    <img src="https://github.com/qurit/rt-utils/workflows/Python%20application/badge.svg" height="18">
+    <img src="https://img.shields.io/pypi/pyversions/rt-utils" alt="Python version" height="18">
+    <a href="https://pypi.org/project/rt-utils"><img src="https://badge.fury.io/py/rt-utils.svg" alt="PyPI version" height="18"></a>  
+    <img alt="PyPI - License" src="https://img.shields.io/github/license/qurit/rt-utils?color=g" height="18" />
+  
+</p>
+ 
+---
+
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14902966.svg)](https://doi.org/10.5281/zenodo.14902966)
+
+
+RT-Utils is motivated to allow physicians and other users to view the results of segmentation performed on a series of DICOM images. RT-Utils allows you to create or load RT Structs, extract 3d masks from RT Struct ROIs, easily add one or more regions of interest, and save the resulting RT Struct in just a few lines!
+You can also use the RT-Utils for merging two existing RT Structs to one file.
+
+## How it works
+RT-Utils provides a builder class to faciliate the creation and loading of an RT Struct. From there, you can add ROIs through binary masks and optionally input the colour of the region along with the region name.
+
+The format for the ROI mask is an nd numpy array of type bool. It is an array of 2d binary masks, one plane for each slice location within the DICOM series. The slices should be sorted in ascending order within the mask. Through these masks, we extract the contours of the regions of interest and place them within the RT Struct file. Note that there is currently only support for the use of one frame of reference UID and structered set ROI sequence. Also note that holes within the ROI may be handled poorly.
+
+## Installation
+```
+pip install rt_utils
+```
+##
+**libGL**  
+   libGL is a required system dependency. Install it on Linux using:
+   ```
+   ```bash
+   sudo apt install libgl1
+```
+## Installation in editable mode
+```
+git clone https://github.com/qurit/rt-utils.git
+cd rt-utils
+pip install -e .
+```
+
+
+## Creating new RT Structs
+```Python
+from rt_utils import RTStructBuilder
+
+# Create new RT Struct. Requires the DICOM series path for the RT Struct.
+rtstruct = RTStructBuilder.create_new(dicom_series_path="./testlocation")
+
+# ...
+# Create mask through means such as ML
+# ...
+
+# Add the 3D mask as an ROI.
+# The colour, description, and name will be auto generated
+rtstruct.add_roi(mask=MASK_FROM_ML_MODEL)
+
+# Add another ROI, this time setting the color, description, and name
+rtstruct.add_roi(
+  mask=MASK_FROM_ML_MODEL, 
+  color=[255, 0, 255], 
+  name="RT-Utils ROI!"
+)
+
+# By default contours pass through the centres of boundary voxels, preserving
+# historical behavior. To place contours on the outer voxel edges instead:
+rtstruct.add_roi(
+  mask=MASK_FROM_ML_MODEL,
+  name="Voxel-edge ROI",
+  contour_mode="voxel_edge"
+)
+
+rtstruct.save('new-rt-struct')
+```
+
+## Adding to existing RT Structs
+```Python
+from rt_utils import RTStructBuilder
+import matplotlib.pyplot as plt
+
+# Load existing RT Struct. Requires the series path and existing RT Struct path
+rtstruct = RTStructBuilder.create_from(
+  dicom_series_path="./testlocation", 
+  rt_struct_path="./testlocation/rt-struct.dcm"
+)
+
+# Add ROI. This is the same as the above example.
+rtstruct.add_roi(
+  mask=MASK_FROM_ML_MODEL, 
+  color=[255, 0, 255], 
+  name="RT-Utils ROI!"
+)
+
+rtstruct.save('new-rt-struct')
+```
+
+## Creation Results
+<p align="center">
+  <img src="https://raw.githubusercontent.com/qurit/rt-utils/main/src/contour.png" width="1000"/>
+</p>
+<p align="center">
+  The results of a generated ROI with a dummy mask, as viewed in Slicer.
+</p>
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/qurit/RT-Utils/main/src/liver-contour.png" width="1000"/>
+</p>
+<p align="center">
+  The results of a generated ROI with a liver segmentation model, as viewed in Slicer. (Note the underlying patient data has been hidden)
+</p>
+
+## Loading an existing RT Struct contour as a mask
+```Python
+from rt_utils import RTStructBuilder
+import matplotlib.pyplot as plt
+
+# Load existing RT Struct. Requires the series path and existing RT Struct path
+rtstruct = RTStructBuilder.create_from(
+  dicom_series_path="./testlocation", 
+  rt_struct_path="./testlocation/rt-struct.dcm"
+)
+
+# View all of the ROI names from within the image
+print(rtstruct.get_roi_names())
+
+# Loading the 3D Mask from within the RT Struct
+mask_3d = rtstruct.get_roi_mask_by_name("ROI NAME")
+
+# Display one slice of the region
+first_mask_slice = mask_3d[:, :, 0]
+plt.imshow(first_mask_slice)
+plt.show()
+```
+
+## Loading Results
+<p align="center">
+  <img src="https://raw.githubusercontent.com/qurit/rt-utils/main/src/loaded-mask.png" height="300"/>
+</p>
+<p align="center">
+  The results of a loading an exisiting ROI as a mask, as viewed in Python.
+</p>
+
+## Merging two existing RT Structs
+To be able to merge two RT Structs it is important that both RT Structs have to belong to the same image series,
+e.g. if there is one set for the organs at risk and one set for the target volume(s).
+```Python
+from rt_utils import RTStructMerger
+
+# Load existing RT Structs and corresponding image series and merge them into one RTStruct
+merged_rt_struct = RTStructMerger.merge_rtstructs(
+  dicom_series_path="./testlocation",
+  rt_struct_path1="./testlocation/rt-struct1.dcm",
+  rt_struct_path2="./testlocation/rt-struct2.dcm"
+  )
+merged_rt_struct.save('merged-rt-struct')
+```
+
+## Additional Parameters
+The add_roi method of our RTStruct class has a multitude of optional parameters available. Below is a comprehensive list of all these parameters and what they do.
+- <b>color</b>: This parameter can either be a colour string such as '#ffffff' or a RGB value as a list such as '[255, 255, 255]'. This parameter will dictate the colour of your ROI when viewed in a viewing program. If no colour is provided, RT Utils will pick from our internal colour palette based on the ROI Number of the ROI.
+- <b>name</b>: A str value that defaults to none. Used to set the name of the ROI within the RT Struct. If the name is none, RT Utils will set a name of ROI-{ROI Number}.
+- <b>description</b>: A str value that sets the description of the ROI within the RT Struct. If no value is provided, the description is just left blank.
+- <b>use_pin_hole</b>: A boolean value that defaults to false. If set to true, lines will be erased through your mask such that each separate region within your image can be encapsulated via a single contour instead of contours nested within one another. Use this if your RT Struct viewer of choice does not support nested contours / contours with holes.
+- <b>approximate_contours</b>: A boolean value that defaults to True which defines whether or not approximations are made when extracting contours from the input mask. Setting this to false will lead to much larger contour data within your RT Struct so only use this if as much precision as possible is required.
+- <b>roi_generation_algorithm</b>: An enum value that defaults to 0 which defines what ROI generation algorithm will be used. 0=\'AUTOMATIC\', 1=\'SEMIAUTOMATIC\', or 2=\'MANUAL\'.
+
+## 🚀 New features
+- nifti to rtstruct conversion has been added.
+- conversion from DICOM to NIFTI for PET and corresponding RT-struct file has been added as an example usage with no issues of shift or mismatch between the masks.
+
+## Examples
+You can find the comparison between RT-utils and other conversion techniques in this public repository: https://github.com/qurit/dicom_nifti_conversion_project 
+
+## Examples
+You can find the comparison between RT-utils and other conversion techniques in this public repository: https://github.com/qurit/dicom_nifti_conversion_project.
+
+The real-world example in the JOSS paper under review was generated using the code provided in the [RTUTILS_read_world_example_for_PET.ipynb](https://github.com/qurit/rt-utils/blob/development/RTUTILS_read_world_example_for_PET.ipynb).
+
+## Contributing
+We welcome contributions to this project! Please review our [CONTRIBUTING guidelines](./CONTRIBUTING.md) for more details.
+
+
+## How to Cite
+
+If you are incorporating RT-Utils into your projects, kindly include the following citation:
+
+[![DOI](https://joss.theoj.org/papers/10.21105/joss.07361/status.svg)](https://doi.org/10.21105/joss.07361)
+
+For citation please use: 
+Shrestha, A., A. Watkins, F. Yousefirizi, A. Rahmim, C. Uribe, "RT-utils: A minimal python library for RT-struct manipulation." Journal of Open Source Software, Vol. 10 (No. 107), pp. 7361, (2025). doi:10.21105/joss.07361.
+  
+Read the full paper: Asim Shrestha, Adam Watkins, Fereshteh Yousefirizi, Arman Rahmim, and Carlos Uribe [RT-utils: A Minimal Python Library for RT-struct Manipulation](https://joss.theoj.org/papers/10.21105/joss.07361)