diff --git a/README.md b/README.md index 7920fb5..3ffce01 100644 --- a/README.md +++ b/README.md @@ -1,153 +1,10 @@ -

- -

-

- A minimal Python library for RT Struct manipulation -

-

- - Python version - PyPI version - PyPI - License -

- ---- - -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 -``` - -## 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!" -) - -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') +# Installation ``` - -## Creation Results -

- -

-

- The results of a generated ROI with a dummy mask, as viewed in Slicer. -

- -

- -

-

- The results of a generated ROI with a liver segmentation model, as viewed in Slicer. (Note the underlying patient data has been hidden) -

- -## 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 -

- -

-

- The results of a loading an exisiting ROI as a mask, as viewed in Python. -

- -## 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') +pip install rt-utils-raystation ``` -## 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. -- color: 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. -- name: 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}. -- description: 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. -- use_pin_hole: 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. -- approximate_contours: 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. -- roi_generation_algorithm: An enum value that defaults to 0 which defines what ROI generation algorithm will be used. 0=\'AUTOMATIC\', 1=\'SEMIAUTOMATIC\', or 2=\'MANUAL\'. +# Credits -#To be added -nifti to rtstruct +This work is a clone of the following repo: https://github.com/qurit/rt-utils +For a full documentation, please check it out. +We just adpot this repo and introduces fixes regarding the SeriesInstanceUID to match resulting rt-struct.dcm files with corresponding MRI series. \ No newline at end of file diff --git a/rt_utils/ds_helper.py b/rt_utils/ds_helper.py index 36c4db7..42ffddc 100644 --- a/rt_utils/ds_helper.py +++ b/rt_utils/ds_helper.py @@ -80,7 +80,7 @@ def add_study_and_series_information(ds: FileDataset, series_data): ds.StudyDescription = getattr(reference_ds, "StudyDescription", "") ds.SeriesDescription = getattr(reference_ds, "SeriesDescription", "") ds.StudyInstanceUID = reference_ds.StudyInstanceUID - ds.SeriesInstanceUID = generate_uid() # TODO: find out if random generation is ok + ds.SeriesInstanceUID = reference_ds.SeriesInstanceUID ds.StudyID = reference_ds.StudyID ds.SeriesNumber = "1" # TODO: find out if we can just use 1 (Should be fine since its a new series) @@ -98,7 +98,7 @@ def add_patient_information(ds: FileDataset, series_data): def add_refd_frame_of_ref_sequence(ds: FileDataset, series_data): refd_frame_of_ref = Dataset() - refd_frame_of_ref.FrameOfReferenceUID = getattr(series_data[0], 'FrameOfReferenceUID', generate_uid()) + refd_frame_of_ref.FrameOfReferenceUID = getattr(series_data[0], 'FrameOfReferenceUID', generate_uid()) refd_frame_of_ref.RTReferencedStudySequence = create_frame_of_ref_study_sequence(series_data) # Add to sequence diff --git a/setup.py b/setup.py index 5d525ed..32603ef 100644 --- a/setup.py +++ b/setup.py @@ -1,22 +1,22 @@ import setuptools -VERSION = "1.2.6" +VERSION = "1.0.1" with open("README.md", "r", encoding="utf-8") as fh: long_description = fh.read() with open("requirements.txt") as f: required = f.read().splitlines() setuptools.setup( - name="rt-utils", + name="rt-utils-raystation", version=VERSION, - author="Asim Shrestha", - author_email="asim.shrestha@hotmail.com", - description="A small library for handling masks and RT-Structs", + author="Lukas Heine, Fabian Hörst", + author_email="fabian.hoerst@uk-essen.de", + description="A small library for handling masks and RT-Structs, with fixed for using with RayStation", long_description=long_description, long_description_content_type="text/markdown", - url="https://github.com/qurit/rtutils", - package_dir={'':"rt_utils"}, - packages=setuptools.find_packages("rt_utils", exclude="tests"), + url="https://github.com/code-lukas/rt-utils", + #package_dir={'':"rt_utils"}, + packages=setuptools.find_packages(exclude="tests"), keywords=["RTStruct", "Dicom", "Pydicom"], classifiers=[ "Operating System :: OS Independent",