Repository files navigation

An ecosystem of library and tools forDICOM compliant systems.

This collection provides a pure Rust implementation of the DICOM standard,allowing users to work with DICOM objectsand interact with DICOM applications,while aiming to be fast, safe, and intuitive to use.

The following library packages are designed to be used inother Rust libraries and applications.

• object provides a high-level abstraction of DICOM objectsand functions for reading and writing DICOM files.
• pixeldata enables the decoding and conversion of DICOM objectsinto usable imaging data structures,such as images and multidimensional arrays.
• dump provides helpful routines fordumping the contents of DICOM objects.
• json provides serialization and deserialization to DICOM JSON.
• ul implements the DICOM upper layer protocol.
• dictionary-std contains a Rust definition ofthe standard data dictionary.
• transfer-syntax-registry contains a registry oftransfer syntax specifications.
• parser provides a middle-level abstractionfor the parsing and printing of DICOM data sets.
• encoding contains DICOM data encoding and decoding primitives.
• core represents all of the base traits,data structures and functions related to DICOM content.

The parent cratedicom aggregates the key components of the full library,so it can be added to a project as an alternative toselectively grabbing the components that you need.

Generally, most projects would adddicom_object,which is the most usable crate for reading DICOM objects from a file or a similar source.This crate is available indicom::object.For working with the imaging data of a DICOM object,addpixeldata.Network capabilities may be constructed on top oful.

A simple example of use follows.For more details,please visit thedicom documentation.

use dicom::object::open_file;use dicom::dictionary_std::tags;let obj =open_file("0001.dcm")?;let patient_name = obj.element(tags::PATIENT_NAME)?.to_str()?;let modality = obj.element(tags::MODALITY)?.to_str()?;

The project also comprises an assortment of command line tools.

• dump, aside from being a library,is also a command-line application for inspecting DICOM files.
• scpproxy implements a Proxy service class provider.
• echoscu implements a Verification service class user.
• findscu implements a Find service class user.
• storescu implements a Storage service class user.
• storescp implements a Storage service class provider.
• toimage lets you convert a DICOM file into an image file.
• fromimage lets you replace the imaging data of a DICOM filewith one from an image file.
• pixeldata also includesdicom-transcode,which lets you transcode DICOM files to other transfer syntaxes.

• dictionary-builder is an independent application thatgenerates code and other data structures for a DICOM standard dictionary.

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

cargo build

Other than the parts needed to build a pure Rust project,no other development dependencies are necessaryunless certain extensions are included via Cargo features.Consult each crate for guidelines on selecting features to suit your needs.

Minimum supported Rust version is 1.72.0 and only applies to the library crates with default features.
Binary crates and extra features may require a newer version of Rust.

This project is under active development.

Your feedback during the development of these solutions is welcome. Please see thewikifor additional guidelines related to the project's roadmap.See also thecontributor guidelines and the project'sCode of Conduct.

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE orhttp://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT orhttp://opensource.org/licenses/MIT)

at your option.

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