CLI Tool

The dcmfx CLI tool makes the capabilities of DCMfx available on the command line.

Installation

Select your platform below to see its installation instructions.

Windows

Download the latest version of dcmfx.exe for Windows here.

macOS

Install Homebrew, then install DCMfx using the provided tap:

brew tap dcmfx/tap
brew install dcmfx

Linux

• For Ubuntu, Debian, Linux Mint, and other Debian-based distributions, an APT repository is provided:

  echo "deb [trusted=yes] https://dcmfx.github.io/apt-repository stable main" | sudo tee /etc/apt/sources.list.d/dcmfx.list
  sudo apt update
  sudo apt install dcmfx

---

• For Red Hat, Fedora, Amazon Linux, SUSE, and other RPM-based distributions, a YUM repository is provided:

  echo -e "[dcmfx]\nname=DCMfx\nbaseurl=http://dcmfx.github.io/yum-repository\nenabled=1\ngpgcheck=0" | sudo tee /etc/yum.repos.d/dcmfx.repo
  sudo yum makecache
  sudo yum install dcmfx

---

• For Arch Linux, a package is provided in the Arch User Repository (AUR). Install it with your preferred AUR helper (e.g. paru):

  paru -S dcmfx

---

• Alternatively, download the latest binary or package here and install it manually.

Usage

After installation, run dcmfx --help to see the available commands:

$ dcmfx --help

DCMfx is a CLI tool for working with DICOM and DICOM JSON

Usage: dcmfx [OPTIONS] <COMMAND>

Commands:
  extract-pixel-data  Extracts the pixel data from a DICOM P10 file and writes
                      each frame to a separate image file
  modify              Reads a DICOM P10 file, applies requested modifications,
                      and writes out a new DICOM P10 file
  print               Prints the content of a DICOM P10 file
  to-dcm              Converts a DICOM JSON file to a DICOM P10 file
  to-json             Converts a DICOM P10 file to a DICOM JSON file
  help                Print this message or the help of the given subcommand(s)

Options:
      --print-stats  Write timing and memory stats to stderr on exit
  -h, --help         Print help
  -V, --version      Print version

Examples

1. Print a DICOM P10 file's data set to stdout:

   dcmfx print input.dcm

2. Convert a DICOM P10 file to a DICOM JSON file:

   dcmfx to-json input.dcm output.json

   To pretty-print the DICOM JSON directly to stdout:

   dcmfx to-json --pretty input.dcm -

3. Convert a DICOM JSON file to a DICOM P10 file:

   dcmfx to-dcm input.json output.dcm

4. Extract pixel data from a DICOM P10 file to image files:

   dcmfx extract-pixel-data input.dcm

5. Rewrite a DICOM P10 file. This will convert the specific character set to UTF-8, change sequences and items to undefined length, and correct invalid files where possible:

   dcmfx modify input.dcm output.dcm

6. Modify a DICOM P10 file to use the 'Deflated Explicit VR Little Endian' transfer syntax with maximum compression:

   dcmfx modify input.dcm output.dcm \
     --transfer-syntax deflated-explicit-vr-little-endian \
     --zlib-compression-level 9

   The modify command can only convert between the following transfer syntaxes:

   • Implicit VR Little Endian
   • Explicit VR Little Endian
   • Deflated Explicit VR Little Endian
   • Explicit VR Big Endian

   Conversion between other transfer syntaxes is not supported.

7. Anonymize a DICOM P10 file to remove all identifying data elements:

   dcmfx modify input.dcm output.dcm --anonymize

   Note that this does not remove any identifying information baked into pixel data or other binary data elements.

8. Remove the top-level '(7FE0,0010) Pixel Data' data element from a DICOM P10 file:

   dcmfx modify input.dcm output.dcm --delete-tags 7FE00010

   Multiple data elements can be deleted by using a comma as a separator:

   dcmfx modify input.dcm output.dcm --delete-tags 00100010,00100030

Gleam CLI

The above examples assume the Rust version of the CLI tool is in use, however all commands are also supported by the Gleam version of the CLI, which can be run with gleam run in /src/gleam/dcmfx_cli.

The Gleam CLI is primarily used when working on the Gleam implementation of DCMfx. The Rust CLI is recommended for regular use as it is faster, has a few additional features, and is a single standalone binary.