Skip to main content

A small library for handling masks and RT-Structs

Project description

A minimal Python library for RTStruct manipulation

PyPI version


Motivated to allow physicians and other users to view the results of ML segmentation, rt-utils allows you to create new RTStructs, easily add one or more regions of interest, and save the resulting RTStruct in just a few lines! There will also be support

How it works

RT-Utils provides a builder class to faciliate the creation or loading of an RTStruct. From there you can add ROIs through masks and optinally input the colour of the region along with the name.

The format for the ROI mask is an nd numpy array. We expect 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 RTStruct 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 RTStructs

from rt_utils import RTStructBuilder

rtstruct = RTStructBuilder.create_new(dicom_series_path="./testlocation")
rtstruct.add_roi(mask=MASK_FROM_ML_MODEL, color=[255, 0, 255], name="RT-Utils ROI!")
rtstruct.save("test-rt-struct.dcm")

Loading existing RTStructs

from rt_utils import RTStructBuilder

rtstruct = RTStructBuilder.create_from(dicom_series_path="./testlocation", rt_struct_path="./testlocation/rt-struct.dcm")
rtstruct.add_roi(mask=MASK_FROM_ML_MODEL, color=[255, 0, 255], name="RT-Utils ROI!")
rtstruct.save("updated-rt-struct.dcm")

Results

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rt-utils-0.0.3.tar.gz (7.8 kB view details)

Uploaded Source

Built Distribution

rt_utils-0.0.3-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

Details for the file rt-utils-0.0.3.tar.gz.

File metadata

  • Download URL: rt-utils-0.0.3.tar.gz
  • Upload date:
  • Size: 7.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.3.3 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

File hashes

Hashes for rt-utils-0.0.3.tar.gz
Algorithm Hash digest
SHA256 749d0c6fcdf2162a79314edf8c7caed63447cf78bd1b4d79150859d492a98777
MD5 828de6a30a271749757721345193d768
BLAKE2b-256 b9ebee8e750fa7484eaf18261488f17f5f80da0730707cc83651e6f9af040882

See more details on using hashes here.

File details

Details for the file rt_utils-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: rt_utils-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 14.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.3.3 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

File hashes

Hashes for rt_utils-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 db65a44f2759c03d4005412e514c14f14523e90c214c3424f51ed2564717af11
MD5 e2d39441d854f43a1155b82c568ff48c
BLAKE2b-256 05dc36ec68e73b2459f7166501a2babec398b017aa9633e54120c7520bdcafd1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page