Skip to main content

A package to simplify visualizing DICOM data via Jupyter/Python.

Project description

Summary

This is a very simplistic DICOM viewer for images and related segmentations (RTSTRUCT and SEG). It was developed as a quick and dirty solution for performing spot checks on data downloaded from The Cancer Imaging Archive using tcia_utils. It was later separated into a stand-alone PyPI package as many users of tcia_utils are not concerned with interactively viewing images and this capability introduced a lot of additional dependencies. There are many other more advanced viewers out there (e.g. 3D Slicer or itkWidgets) that you should try if your data fails with this tool.

Installation

We're installing a forked version of pydicom-seg because the PYPI package is using a very outdated version of jsonschema, which creates a lot of dependency conflicts even though the newer version appears to work without any issues.

# install forked pydicom-seg with updated jsonschema version
!pip install --upgrade -q git+https://github.com/kirbyju/pydicom-seg.git@master

# install simpleDicomViewer
!{sys.executable} -m pip install --upgrade -q simpleDicomViewer```

# Usage

Import using:

`from simpleDicomViewer import dicomViewer`

Examples for using it can be found in [demo.ipynb](https://github.com/kirbyju/simpleDicomViewer/blob/main/demo.ipynb).

# Acknowledgements

A big thanks to [Adam Li](https://github.com/adamli98) who introduced the functionality to display the segmentation overlays.

### Citations:
This repository includes sample data from The Cancer Imaging Archive in the "data" folder which you can use for testing its features.  

1. Zhao, B., Schwartz, L. H., Kris, M. G., & Riely, G. J. (2015). Coffee-break lung CT collection with scan images reconstructed at multiple imaging parameters (Version 3) [Dataset]. The Cancer Imaging Archive. https://doi.org/10.7937/k9/tcia.2015.u1x8a5nr
2. Wee, L., Aerts, H., Kalendralis, P., & Dekker, A. (2020). RIDER Lung CT Segmentation Labels from: Decoding tumour phenotype by noninvasive imaging using a quantitative radiomics approach [Data set]. The Cancer Imaging Archive. https://doi.org/10.7937/tcia.2020.jit9grk8

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

simpledicomviewer-0.0.3.tar.gz (70.3 MB view details)

Uploaded Source

Built Distribution

simpledicomviewer-0.0.3-py3-none-any.whl (9.5 kB view details)

Uploaded Python 3

File details

Details for the file simpledicomviewer-0.0.3.tar.gz.

File metadata

  • Download URL: simpledicomviewer-0.0.3.tar.gz
  • Upload date:
  • Size: 70.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.8

File hashes

Hashes for simpledicomviewer-0.0.3.tar.gz
Algorithm Hash digest
SHA256 96e85bc4823d58103c3128872dafd1f6351b4537f73e41fa0491613e34020091
MD5 097e0bb377dcf437ad422046f28b569f
BLAKE2b-256 29715999e2796e483dcd2096683184caa4cc0a24ef7195261df413d0759adcbe

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for simpledicomviewer-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 93547c58c113fe4def6cd31f40761106f38946bce6f5b9b8b24bb915f537488a
MD5 46dba10f90d2ede78431125fca61e08d
BLAKE2b-256 9ee8a1f0c758ac0b10bc288fb6d598ea8c697078955de794735ceeb9fb990357

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