/dicom-rs

Pure Rust implementation of the DICOM standard

Primary LanguageRustApache License 2.0Apache-2.0

DICOM-rs

Build Status Minimum Rust Version Stable dependency status Gitter CratesIO Documentation

An ecosystem of library and tools for DICOM compliant systems.

This collection provides a pure Rust implementation of the DICOM standard, allowing users to read and write DICOM objects over files and other sources, while remaining intrinsically fast and safe to use.

Components

Library:

  • core represents all of the base traits, data structures and functions related to DICOM content.
  • encoding contains DICOM data encoding and decoding primitives.
  • parser provides a middle-level abstraction for the parsing and printing of DICOM data sets.
  • object provides a high-level abstraction of DICOM objects and functions for reading and writing DICOM files.
  • dictionary-std contains a Rust definition of the standard data dictionary.
  • transfer-syntax-registry contains a registry of transfer syntax specifications.
  • ul implements the DICOM upper layer protocol.

Tools:

  • dcmdump is a command-line application for inspecting DICOM files.
  • dictionary-builder is a Rust application that generates code and other data structures for a DICOM standard dictionary using entries from the official website.
  • scpproxy implements the Proxy service class provider.

Using as a library

dicom-object is currently the most usable crate for reading DICOM objects from a file or a similar source. As an alternative, the parent crate dicom can be added instead, which aggregates the key components of the full library, including dicom-object.

An example of use follows. For more details, please visit the dicom-object documentation.

use dicom_object::open_file;
use dicom_object::Result;

let obj = open_file("0001.dcm")?;
let patient_name = obj.element_by_name("PatientName")?.to_str()?;
let modality = obj.element_by_name("Modality")?.to_str()?;

Building

You can use Cargo to build all crates in the repository.

cargo build --release

Roadmap & Contributing

This project is a work in progress, but actively developed.

Your feedback during the development of these solutions is welcome. Please see the wiki for additional guidelines related to the project's roadmap.

License

Licensed under either of

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.