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.

NOTE: Since version 0.4.0, a warning will be shown if more than one match is found. To disable warnings for a single call, use rdsr_obj.get('procedure_reported', warnings=False).value.To disable all warnings, use nav.read_file(r'C:\rdsr_file.dcm', warnings=False) when loading the file.

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.5.0.tar.gz (8.8 kB view details)

Uploaded Source

Built Distribution

rdsr_navigator-0.5.0-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rdsr_navigator-0.5.0.tar.gz
  • Upload date:
  • Size: 8.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.2

File hashes

Hashes for rdsr_navigator-0.5.0.tar.gz
Algorithm Hash digest
SHA256 960add352c73186b8f5a9030c1cf266bbb0e07634399bb720977dbcddf9e06e2
MD5 40c618b4a78e7cd21e0ba32a833b8136
BLAKE2b-256 03ccae2bbb7951ed34463ede26419791b6a41d775bf8d245618474a8ad64db75

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rdsr_navigator-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 10.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.2

File hashes

Hashes for rdsr_navigator-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 857670b5bba645449c9ae91c136016c104639db56c515dfe85f23a12bfdc42f3
MD5 eb3ddcb1c779981e34f0614f352f100c
BLAKE2b-256 9543e892fd26199d8bec36cead81f387a5cdab5631de40f02eddce91263c8d4d

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