| Name | fw-gear-dicom-splitter JSON |
| Version |
2.0.2
JSON |
| download |
| home_page | None |
| Summary | DICOM splitter based on unique tags, or localizers |
| upload_time | 2024-09-26 00:41:48 |
| maintainer | None |
| docs_url | None |
| author | Flywheel |
| requires_python | <4,>=3.11 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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.
## Version 2.0.0 Breaking Change
Note that versions of this gear prior to version 2.0.0 are named `splitter`. On the
release of version 2.0.0, the gear was renamed to `dicom-splitter` and all package
names, import statements, and other references were modified to reflect this rename.
Any software that depends on `dicom-splitter` should be updated with this breaking
change in mind.
Raw data
{
"_id": null,
"home_page": null,
"name": "fw-gear-dicom-splitter",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.11",
"maintainer_email": null,
"keywords": null,
"author": "Flywheel",
"author_email": "support@flywheel.io",
"download_url": null,
"platform": null,
"description": "# DICOM Splitter\n\nThis gear is meant to split DICOM archives into two or more archives. The main use\ncases for this gear are if,\n\n* There are one or more localizers (scouts, etc.) mixed in with primary images\n* There are multiple Series in one archive.\n* The archive is multiphasic with respect to slice location (geometry split)\n* The archive has non uniform image orientations (geometry split)\n* Some field varies across the archive and you have reason to the archive based on that\n field (Note: This \"group by\" option is exclusive if a previous geometry split is performed)\n\nThe gear is set to do the first two above by default, i.e. it will extract a\nlocalizer(s) from the archive, and it will extract each unique SeriesInstanceUID into\nits own archive.\n\n## Usage\n\n### Inputs\n\n* __dicom__ : DICOM archive input\n\n### Configuration\n\n* __extract_localizer__ (boolean, default True): Whether or not to extract localizer\nfrom archive.\n* __group_by__ (string, default \"SeriesInstanceUID\"): Comma separated list of dicom\ntags to split the archive on.\n* __tag__ (string, default \"splitter\"): The tag to be added on input file upon run\ncompletion.\n* __debug__ (boolean, default False): Include debug output.\n* __delete_input__ (boolean, default True): Delete input if DICOM is successfully split.\n\n### Outputs\n\nThe gear will output nothing if no splitting action was taken. Otherwise it will output\na variable number of archives depending on the input and configuration named with the\nfollowing pattern:\n\n`series-<SeriesNumber>_<Modality>_<SeriesDescription>_<GroupByTags>[_localizer]`, where\n\n* `SeriesNumber` is the value of the `SeriesNumber` tag across the archive. By default\n the largest sized archive (by number of slices) will retain the original\n `SeriesNumber` and additional archives will be incremented by `1000 + i`, where `i` is\n the index of the archive in a list of total archives.\n* `SeriesDescription` is the value of the `SeriesDescription` tag across the archive\n* `GroupByTags` is an underscore separated list of all tags appearing in the `group_by` list,\n and their corresponding value in that archive. Tags \"SeriesInstanceUID\" and \"SeriesNumber\"\n are not included even if they appear in the `group_by` list.\n* `Modality` is the value of the `Modality` tag across the archive\n* If the series is a localizer, `_localizer` will be appended.\n\n## Version 2.0.0 Breaking Change\n\nNote that versions of this gear prior to version 2.0.0 are named `splitter`. On the\nrelease of version 2.0.0, the gear was renamed to `dicom-splitter` and all package\nnames, import statements, and other references were modified to reflect this rename.\nAny software that depends on `dicom-splitter` should be updated with this breaking\nchange in mind.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "DICOM splitter based on unique tags, or localizers",
"version": "2.0.2",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e2f60abf1c3241f4d11bbc662e51589e967933ea3fd76d955112b65ffed72fd1",
"md5": "bccbc933cdd39a228781c2342c3142aa",
"sha256": "c0c65cba3530650943da0b1399f574ff4a6edc155c7f39ff8a094ff2afdb2900"
},
"downloads": -1,
"filename": "fw_gear_dicom_splitter-2.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bccbc933cdd39a228781c2342c3142aa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.11",
"size": 22458,
"upload_time": "2024-09-26T00:41:48",
"upload_time_iso_8601": "2024-09-26T00:41:48.410343Z",
"url": "https://files.pythonhosted.org/packages/e2/f6/0abf1c3241f4d11bbc662e51589e967933ea3fd76d955112b65ffed72fd1/fw_gear_dicom_splitter-2.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-26 00:41:48",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "fw-gear-dicom-splitter"
}
