#dicom #dictionary #generator #generate

app dicom-dictionary-builder

A generator of DICOM dictionaries from standard documentation and other sources

11 unstable releases (4 breaking)

0.7.0 Apr 25, 2024
0.4.0 Jul 23, 2023
0.3.2 Dec 12, 2022
0.3.1 Oct 23, 2022
0.1.0 Aug 31, 2019

#1381 in Command line utilities

40 downloads per month


631 lines

DICOM-rs dictionary-builder

CratesIO Documentation

This sub-project is a tool for generating machine readable attribute dictionaries from the DICOM standard. At the moment, the tool is capable of parsing .dic files from the DCMTK project.

This tool is part of the DICOM-rs project.


cargo build --release


DICOM dictionary builder

Usage: dicom-dictionary-builder <COMMAND>

  data-element  Fetch and build a dictionary of DICOM data elements (tags)
  uids          Fetch and build a dictionary of DICOM unique identifiers
  help          Print this message or the help of the given subcommand(s)

  -h, --help  Print help

After specifying which dictionary is intended, the next argument is usually its source, which can be either a file or a hyperlink.

Fetching a data element (tags) dictionary:

Fetch and build a dictionary of DICOM data elements (tags)

Usage: dicom-dictionary-builder data-element [OPTIONS] [FROM]

  [FROM]  Path or URL to the data element dictionary [default: https://raw.githubusercontent.com/DCMTK/dcmtk/master/dcmdata/data/dicom.dic]

  -o <OUTPUT>              The output file [default: tags.rs]
      --ignore-retired     Ignore retired DICOM tags
      --deprecate-retired  Mark retired DICOM tags as deprecated
  -h, --help               Print help

Fetching a UID dictionary:

Usage: dicom-dictionary-builder uids [OPTIONS] [FROM]

  [FROM]  Path or URL to the XML file containing the UID values tables [default: https://dicom.nema.org/medical/dicom/current/source/docbook/part06/part06.xml]

  -o <OUTPUT>              The output file [default: uids.rs]
      --ignore-retired     Ignore retired UIDs
      --deprecate-retired  Mark retired UIDs as deprecated
      --feature-gate       Whether to gate different UID types on Cargo features
  -h, --help               Print help

Note: If retrieving part06.xml from the official DICOM server fails due to the TLS connection not initializing, try downloading the file with another software and passing the path to the file manually.


~205K SLoC