Deprecated in favor of oxidicom.

See https://github.com/FNNDSC/oxidicom/

pypx-listener

An instance handler for storescp which reorganizes incoming DICOM files. Rust re-write of px-repack from pypx.

What It Does

pypx is a collection of CLI commands and Python functions which handle PACS query and DICOM retrieval for the ChRIS system. The order of events for DICOM retrieval is:

1. pypx requests for a DICOM series to be pushed from the PACS to us.
2. storescp receives DICOM instances one by one.
3. For each DICOM instance, "repack" it to a location on the filesystem where it'll be picked up by downstream pypx operations.
4. pypx discovers "repacked" files and pushes them to the ChRIS backend.

Repacking

During the process or repacking:

1. DICOM files are moved to the "data dir" in a human-friendly tree based layout. E.g. data/1449c1d-anonymized-20090701/MR-Brain_w_o_Contrast-98edede8b2-20130308/00005-SAG_MPRAGE_220_FOV/0061-1.3.12.2.1107.5.2.19.45152.2013030808110087109885915.dcm
2. JSON files containing DICOM tag data are written to the "log dir". These JSON files are read by downstream pypx operations.

Successor to px-repack

rx-repack versions 0.4.2 and earlier were drop-in replacements for px-repack and tested for feature parity. Starting in rx-repack version 1.0.0, features are being added to rx-repack which are not implemented in px-repack.

The motivation to replace px-repack with rx-repack is performance. See the section about performance.

Testing

Get data:

./get_examples.sh examples

Run tests:

cargo test

Blazingly Fast!

rx-repack runs faster than the rate at which storescp receives DICOM instances, so it is unlikely to cause backpressure.

This solves a problem with px-repack where the memory footprint and elapsed time of spawning one Python process per file would cause a buildup of resource consumption even when pulling only 3-4 series of MRI data.

Benchmarking: Setup

./get_examples.sh examples
cargo build --release

Benchmarking: v.s. px-repack

rx-repack called per-instance is ~10x faster than px-repack called per-series.

source examples/pypx/bin/activate
export PATH="$PWD/target/release:$PATH"
hyperfine --prepare 'rm -rf /tmp/dicom' \
          "px-repack --xcrdir $PWD/examples/FNNDSC-SAG-anon-3d6e850 --parseAllFilesWithSubStr , --verbosity 0 --datadir /tmp/dicom" \
"fd --exec rx-repack --xcrdir '{//}' --xcrfile '{/}' --verbosity 0 --datadir /tmp/dicom \; --threads=1 --type f '.*\.dcm$' $PWD/examples/FNNDSC-SAG-anon-3d6e850"

However, for a more direct comparison, we need to call px-repack and rs-repack both exactly the same way: one process per series, sequential execution.

source examples/pypx/bin/activate
export PATH="$PWD/target/release:$PATH"
hyperfine --prepare 'rm -rf /tmp/dicom' -L xx-repack px-repack,rx-repack \
   "fd --exec {xx-repack} --xcrdir '{//}' --xcrfile '{/}' --verbosity 0 --datadir /tmp/dicom \; \
   --threads=1 --type f '.*\.dcm$' $PWD/examples/FNNDSC-SAG-anon-3d6e850"

Benchmarking: Results

The performance of rs-repack is 200 times faster than px-repack.

Benchmark 1: fd --exec px-repack --xcrdir '{//}' --xcrfile '{/}' --verbosity 0 --datadir /tmp/dicom \;    --threads=1 --type f '.*\.dcm$' /home/jenni/fnndsc/pypx-listener/examples/FNNDSC-SAG-anon-3d6e850
  Time (mean ± σ):     41.000 s ±  0.230 s    [User: 35.948 s, System: 4.861 s]
  Range (min … max):   40.669 s … 41.473 s    10 runs
 
Benchmark 2: fd --exec rx-repack --xcrdir '{//}' --xcrfile '{/}' --verbosity 0 --datadir /tmp/dicom \;    --threads=1 --type f '.*\.dcm$' /home/jenni/fnndsc/pypx-listener/examples/FNNDSC-SAG-anon-3d6e850
  Time (mean ± σ):     204.6 ms ±   5.6 ms    [User: 149.0 ms, System: 53.5 ms]
  Range (min … max):   198.9 ms … 216.7 ms    13 runs
 
Summary
  fd --exec rx-repack --xcrdir '{//}' --xcrfile '{/}' --verbosity 0 --datadir /tmp/dicom \;    --threads=1 --type f '.*\.dcm$' /home/jenni/fnndsc/pypx-listener/examples/FNNDSC-SAG-anon-3d6e850 ran
  200.35 ± 5.58 times faster than fd --exec px-repack --xcrdir '{//}' --xcrfile '{/}' --verbosity 0 --datadir /tmp/dicom \;    --threads=1 --type f '.*\.dcm$' /home/jenni/fnndsc/pypx-listener/examples/FNNDSC-SAG-anon-3d6e850

Amusingly, rx-repack runs ~12x faster than it takes Python 3.11.3 to do literally nothing.

hyperfine -N "python -c ''" "target/release/rx-repack --xcrdir $PWD/examples/FNNDSC-SAG-anon-3d6e850 --xcrfile 0002-1.3.12.2.1107.5.2.19.45152.2013030808110261698786039.dcm  --datadir /tmp/dicom"