Skip to main content

High-level DICOM abstractions.

Project description

Build Status Documentation Status PyPi Distribution Python Versions Downloads Contributor Covenant

Highdicom

highdicom is a pure Python package built on top of pydicom to provide a higher-level application programming interface (API) for working with DICOM files. Its focus is on common operations required for machine learning, computer vision, and other similar computational analyses. Broadly speaking, the package helps with three types of task:

  1. Reading existing DICOM image files of a wide variety of modalities (covering radiology, pathology, and more) and selecting and formatting its frames for computational analysis. This includes considerations such as spatial arrangements of frames, and application of pixel transforms, which are not handled by pydicom.

  2. Storing image-derived information, for example from computational analyses or human annotation, in derived DICOM objects for communication and storage. This includes:

    • Annotations
    • Parametric Map images
    • Segmentation images
    • Structured Report documents (containing numerical results, qualitative evaluations, and/or vector graphic annotations)
    • Secondary Capture images
    • Key Object Selection documents
    • Legacy Converted Enhanced CT/PET/MR images (e.g., for single frame to multi-frame conversion)
    • Softcopy Presentation State instances (including Grayscale, Color, and Pseudo-Color)
  3. Reading existing derived DICOM files of the above types and filtering and accessing the information contained within them.

Documentation

Please refer to the online documentation at highdicom.readthedocs.io, which includes installation instructions, a user guide with examples, a developer guide, and complete documentation of the application programming interface of the highdicom package.

Citation

For more information about the motivation of the library and the design of highdicom's API, please see the following article:

Highdicom: A Python library for standardized encoding of image annotations and machine learning model outputs in pathology and radiology C.P. Bridge, C. Gorman, S. Pieper, S.W. Doyle, J.K. Lennerz, J. Kalpathy-Cramer, D.A. Clunie, A.Y. Fedorov, and M.D. Herrmann. Journal of Digital Imaging, August 2022

If you use highdicom in your research, please cite the above article.

Support

The developers gratefully acknowledge their support:

This software is maintained in part by the NCI Imaging Data Commons project, which has been funded in whole or in part with Federal funds from the NCI, NIH, under task order no. HHSN26110071 under contract no. HHSN261201500003l.

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

highdicom-0.26.0.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

highdicom-0.26.0-py3-none-any.whl (1.1 MB view details)

Uploaded Python 3

File details

Details for the file highdicom-0.26.0.tar.gz.

File metadata

  • Download URL: highdicom-0.26.0.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.8

File hashes

Hashes for highdicom-0.26.0.tar.gz
Algorithm Hash digest
SHA256 366424f75fc8d1bfd39d33c3da1546417761c5bee2e71b521b76d08eadf7ab27
MD5 5b9729ec3d3a43676877b9f6129368f3
BLAKE2b-256 686b3427dca6a69e70fe2e8ed3587fd8dbeab95a3d4607d9990be76b14a64769

See more details on using hashes here.

File details

Details for the file highdicom-0.26.0-py3-none-any.whl.

File metadata

  • Download URL: highdicom-0.26.0-py3-none-any.whl
  • Upload date:
  • Size: 1.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.8

File hashes

Hashes for highdicom-0.26.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0eefea3e0b1c74b5a52af10fa652daa7620dca25bef9771eb5833c8e03b238ca
MD5 2991126cf546690c1711d3d82dc1932f
BLAKE2b-256 1899af2a678ece27b8f9884aa0147aff268df02ddc362c2ae05d155c14cc194f

See more details on using hashes here.

Supported by

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