Skip to main content

DICOM Splitter

This gear is meant to split DICOM archives into two or more archives. The main use cases for this gear are if,

  • There are one or more localizers (scouts, etc.) mixed in with primary images
  • There are multiple Series in one archive.
  • The archive is multiphasic with respect to slice location (geometry split)
  • The archive has non uniform image orientations (geometry split)
  • Some field varies across the archive and you have reason to the archive based on that field (Note: This "group by" option is exclusive if a previous geometry split is performed)

The gear is set to do the first two above by default, i.e. it will extract a localizer(s) from the archive, and it will extract each unique SeriesInstanceUID into its own archive.

Usage

Inputs

  • dicom : DICOM archive input

Configuration

  • extract_localizer (boolean, default True): Whether or not to extract localizer from archive.
  • group_by (string, default "SeriesInstanceUID"): Comma separated list of dicom tags to split the archive on.
  • tag (string, default "splitter"): The tag to be added on input file upon run completion.
  • debug (boolean, default False): Include debug output.
  • delete_input (boolean, default True): Delete input if DICOM is successfully split.

Outputs

The gear will output nothing if no splitting action was taken. Otherwise it will output a variable number of archives depending on the input and configuration named with the following pattern:

series-<SeriesNumber>_<Modality>_<SeriesDescription>_<GroupByTags>[_localizer], where

  • SeriesNumber is the value of the SeriesNumber tag across the archive. By default the largest sized archive (by number of slices) will retain the original SeriesNumber and additional archives will be incremented by 1000 + i, where i is the index of the archive in a list of total archives.
  • SeriesDescription is the value of the SeriesDescription tag across the archive
  • GroupByTags is an underscore separated list of all tags appearing in the group_by list, and their corresponding value in that archive. Tags "SeriesInstanceUID" and "SeriesNumber" are not included even if they appear in the group_by list.
  • Modality is the value of the Modality tag across the archive
  • If the series is a localizer, _localizer will be appended.

Metadata

Release files for fw-gear-splitter 1.7.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for fw-gear-splitter 1.7.2
File Interpreter ABI Platform
fw_gear_splitter-1.7.2-py3-none-any.whl Python 3 none any Details

Release files / fw_gear_splitter-1.7.2-py3-none-any.whl

Download URL fw_gear_splitter-1.7.2-py3-none-any.whl
Size 22.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a82105c68c1b106123dd2986b00ea738b36f2917120e2b878e494f3f2f71b4b2
BLAKE2b-256 checksum
How to use checksums
a13c49e9c6fe7d175f48c093bfa8fa68b4254dd26e05f0362bafb7097de4dca6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.2 CPython/3.9.19 Linux/5.15.146+

Release history Release notifications | RSS feed

This release

1.7.2 This release

1 release file

1.7.1

1 release file

1.7.0

1 release file

1.5.2

1 release file

1.5.0

1 release file

1.4.3

1 release file

1.4.2

1 release file

1.3.4

1 release file

1.3.3

1 release file

1.3.2

1 release file

1.3.1

1 release file

1.3.0

1 release file

1.2.5

1 release file

1.2.4

1 release file

1.2.3

1 release file

1.2.2

1 release file

1.2.1

1 release file

1.2.0

1 release file

1.1.1

1 release file

1.1.0

1 release file

1.0.0

1 release file

0.2.4

1 release file

0.2.3

1 release file

0.2.2

1 release file

0.2.1

1 release file

0.2.0

1 release file

0.1.2

1 release file

0.1.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page