| Name | spydcmtk JSON |
| Version |
1.2.16
JSON |
| download |
| home_page | None |
| Summary | Simple python dicom toolkit. |
| upload_time | 2025-10-07 16:35:07 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9.0 |
| license | MIT |
| keywords |
ct
dicom
imaging
medical
mri
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# *spydcmtk*
*Simple PYthon DiCoM Tool Kit*
Dicom organisational, querying and conversion toolkit
*spydcmtk* is a pure Python package built on top of [*pydicom*](https://github.com/pydicom/pydicom).
This package extends pydicom with a class structure based upon the Patient-Study-Series-Image hierarchy. In addition, it provides a number of built in routines for common actions when working with dicom files, such as human readable renaming, anonymisation, searching and summarising.
## Installation
Using [pip](https://pypi.org/project/spydcmtk/):
```
pip install spydcmtk
```
## Quick start
If you installed via pip then *spydcmtk* console script will be exposed in your python environment.
Access via:
```bash
spydcmtk -h
```
to see the commandline usage available to you.
If you would like to incorporate spydcmtk into your python project, then import as:
```python
import spydcmtk
listOfStudies = spydcmtk.dcmTK.ListOfDicomStudies.setFromDirectory(MY_DICOM_DIRECTORY)
# Example filtering
dcmStudy = listOfStudies.getStudyByDate('20230429') # Dates in dicom standard string format: YYYYMMDD
dcmSeries = dcmStudy.getSeriesBySeriesNumber(1)
# Example writing new dicom files with anonymisation
dcmStudy.writeToOrganisedFileStructure(tmpDir, anonName='Not A Name')
```
# Configuration
spydcmtk uses a spydcmtk.conf file for configuration.
By default spydcmtk.conf files are search for in the following locations:
1. source_code_directory/spydcmtk.conf (file with default settings)
2. $HOME/spydcmtk.conf
3. $HOME/.spydcmtk.conf
4. $HOME/.config/spydcmtk.conf
5. Full file path defined at environment variable: "SPYDCMTK_CONF"
6. Full path passed as commandline argument to `spydcmtk`
Files are read in the above order with each subsequent variable present over writing any previously defined.
For information on files found and variables used run:
`spydcmtk -INFO`
## Documentation
Clear documentation of basic features can be seen by running the *"spycmtk -h"* command as referenced above.
For detailed documentation please see [spydcmtk-documentation](https://fraser29.github.io/spydcmtk/)
Raw data
{
"_id": null,
"home_page": null,
"name": "spydcmtk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9.0",
"maintainer_email": null,
"keywords": "ct, dicom, imaging, medical, mri",
"author": null,
"author_email": "\"Fraser M. Callaghan\" <callaghan.fm@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/e9/63/178c9c9fe40b31b46879c02b3f711e805b77e5627f8e1f42f035de7ea960/spydcmtk-1.2.16.tar.gz",
"platform": null,
"description": "# *spydcmtk*\n\n*Simple PYthon DiCoM Tool Kit*\n\nDicom organisational, querying and conversion toolkit\n\n*spydcmtk* is a pure Python package built on top of [*pydicom*](https://github.com/pydicom/pydicom).\n\nThis package extends pydicom with a class structure based upon the Patient-Study-Series-Image hierarchy. In addition, it provides a number of built in routines for common actions when working with dicom files, such as human readable renaming, anonymisation, searching and summarising. \n\n\n## Installation\n\nUsing [pip](https://pypi.org/project/spydcmtk/):\n```\npip install spydcmtk\n```\n\n## Quick start\n\nIf you installed via pip then *spydcmtk* console script will be exposed in your python environment. \n\nAccess via:\n```bash\nspydcmtk -h\n```\nto see the commandline usage available to you.\n\n\nIf you would like to incorporate spydcmtk into your python project, then import as:\n```python\nimport spydcmtk\n\nlistOfStudies = spydcmtk.dcmTK.ListOfDicomStudies.setFromDirectory(MY_DICOM_DIRECTORY)\n# Example filtering\ndcmStudy = listOfStudies.getStudyByDate('20230429') # Dates in dicom standard string format: YYYYMMDD\ndcmSeries = dcmStudy.getSeriesBySeriesNumber(1)\n# Example writing new dicom files with anonymisation\ndcmStudy.writeToOrganisedFileStructure(tmpDir, anonName='Not A Name')\n\n```\n\n\n# Configuration\n\nspydcmtk uses a spydcmtk.conf file for configuration. \n\nBy default spydcmtk.conf files are search for in the following locations: \n\n1. source_code_directory/spydcmtk.conf (file with default settings)\n2. $HOME/spydcmtk.conf\n3. $HOME/.spydcmtk.conf\n4. $HOME/.config/spydcmtk.conf\n5. Full file path defined at environment variable: \"SPYDCMTK_CONF\"\n6. Full path passed as commandline argument to `spydcmtk`\n\nFiles are read in the above order with each subsequent variable present over writing any previously defined. \nFor information on files found and variables used run:\n\n`spydcmtk -INFO` \n\n\n## Documentation\n\nClear documentation of basic features can be seen by running the *\"spycmtk -h\"* command as referenced above. \nFor detailed documentation please see [spydcmtk-documentation](https://fraser29.github.io/spydcmtk/)\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Simple python dicom toolkit.",
"version": "1.2.16",
"project_urls": {
"Homepage": "https://github.com/fraser29/spydcmtk"
},
"split_keywords": [
"ct",
" dicom",
" imaging",
" medical",
" mri"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "4d3c5f773a1c447080455c09f8a56956b3cdfc42e32e3731cd36f0570c4e1c61",
"md5": "b6a6e07a1b34a6229470d38bcfda4c21",
"sha256": "e88824e8178ec4e2fa5c0af5cd05ab95a75da8a8bca30dfbbe44e99fe3540817"
},
"downloads": -1,
"filename": "spydcmtk-1.2.16-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b6a6e07a1b34a6229470d38bcfda4c21",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9.0",
"size": 1549648,
"upload_time": "2025-10-07T16:35:05",
"upload_time_iso_8601": "2025-10-07T16:35:05.447111Z",
"url": "https://files.pythonhosted.org/packages/4d/3c/5f773a1c447080455c09f8a56956b3cdfc42e32e3731cd36f0570c4e1c61/spydcmtk-1.2.16-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e963178c9c9fe40b31b46879c02b3f711e805b77e5627f8e1f42f035de7ea960",
"md5": "f70e45021c286fc00bc34f520770a467",
"sha256": "822347fa99f70489ca670d9cde0559bb4a3ce442da6de2447ae7acaa629b254c"
},
"downloads": -1,
"filename": "spydcmtk-1.2.16.tar.gz",
"has_sig": false,
"md5_digest": "f70e45021c286fc00bc34f520770a467",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9.0",
"size": 1539618,
"upload_time": "2025-10-07T16:35:07",
"upload_time_iso_8601": "2025-10-07T16:35:07.813283Z",
"url": "https://files.pythonhosted.org/packages/e9/63/178c9c9fe40b31b46879c02b3f711e805b77e5627f8e1f42f035de7ea960/spydcmtk-1.2.16.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-07 16:35:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fraser29",
"github_project": "spydcmtk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "spydcmtk"
}
