Skip to main content

Package for extracting data from DICOM RDSR files

Project description

RDSR Navigator

Downloads Downloads

A package for extracting data from DICOM RDSR files. The focus of this project is to extract data. It is not possible to modify files. The project is currently in early development and things might not work exactly how you expect. The public API is not yet stable, please keep this in mind.

The package is intended for RESEARCH USE ONLY, NOT FOR CLINICAL USE.

Getting started

These instructions will get you a copy of the project up and running on your local machine.

Prerequisites

RDSR Navigator is written in Python 3.6 and uses pydicom. Therefore make sure you are running Python 3.6 or later and make sure pydicom is installed. If pydicom is not installed, use the command below to install pydicom.

$ pip install pydicom

Installation

RDSR Navigator is available on pypi and can be installed using the following command.

$ pip install rdsr_navigator

Now, you are ready to start using RDSR navigator.

Usage

Read file

To open an RDSR file, type the following.

    >>> import rdsr_navigator as nav
    >>> rdsr_obj = nav.read_file(r'C:\rdsr_file.dcm')

The input argument to read_file is a str containing the path to an RDSR file. Other supported data types are pathlib and pydicom objects.

Extract data

Data is extracted by first navigating through the RDSR hierarchy using the concept names. All concept names are given in lower case, separated by underscores ("_"). In the example below we are extracting the value from "Procedure Reported".

    >>> rdsr_obj['procedure_reported'].value

    'Projection X-Ray'

Data can also be extracted by using the code value and coding scheme designator separated by a colon (":"). This is shown in the example below.

    >>> rdsr_obj['121058:DCM'].value

    'Projection X-Ray'

When the square brackets are used, the first matched concept name is returned. This is inappropriate if several entries with the same concept name exist on the same level. To iterate entries with the same concept name, use the get_all method.

    >>> for irr_event in sr_obj.get_all('irradiation_event_x-ray_data')):
            print(irr_event['dose_area_product'].value)

    (1.9632189e-7, 'Gy.m2')
    (1.1173212e-5, 'Gy.m2')
    (8.566802e-7, 'Gy.m2')

Drill deeper into the hierarchy by adding more concept names in the square brackets.

    >>> rdsr_obj['procedure_reported', 'has_intent'].value

    'Combined Diagnostic and Therapeutic Procedure'

Jupyter notebook integration

The RDSR navigator classes are integrated with jupyter notebooks.

  • Data is nicely displayed in tabular form.
  • Tab completion is available when accessing data using square brackets.

Supported value types

Currently, only a few value types are supported. The supported value types are listed below.

  • Code Meaning
  • Date Time
  • Measured Values
  • Text Value
  • UID

License

This project is licensed under the MIT License - see the LICENSE file for details.

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

rdsr_navigator-0.2.9.tar.gz (7.9 kB view details)

Uploaded Source

Built Distribution

rdsr_navigator-0.2.9-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

Details for the file rdsr_navigator-0.2.9.tar.gz.

File metadata

  • Download URL: rdsr_navigator-0.2.9.tar.gz
  • Upload date:
  • Size: 7.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2

File hashes

Hashes for rdsr_navigator-0.2.9.tar.gz
Algorithm Hash digest
SHA256 c82de8dde5c027d6097b65d56aa650c2fbd438bfba0e63176332100fb7614bcd
MD5 b1ea351fd0f3043d76df0b5d23f304e7
BLAKE2b-256 ef2096b638ba5478dee1c3bdbb000a1a153d85a50d6768de72269894f541dc67

See more details on using hashes here.

File details

Details for the file rdsr_navigator-0.2.9-py3-none-any.whl.

File metadata

  • Download URL: rdsr_navigator-0.2.9-py3-none-any.whl
  • Upload date:
  • Size: 10.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2

File hashes

Hashes for rdsr_navigator-0.2.9-py3-none-any.whl
Algorithm Hash digest
SHA256 5c23c57a1889dde304e307be06b6e580c60905cee059e1de132f22a7b259731f
MD5 e7e395f6655086e2fe11cd2f1919baba
BLAKE2b-256 11ba2c83a872dd235a4e5c3c90be0691334a52f87f5d3ec5792b2d737bc8899e

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