=========
dicom_wsi
=========
.. image:: https://img.shields.io/pypi/v/dicom_wsi.svg
:target: https://pypi.python.org/pypi/dicom_wsi
.. image:: https://img.shields.io/travis/Steven-N-Hart/dicom_wsi.svg
:target: https://travis-ci.com/Steven-N-Hart/dicom_wsi
.. image:: https://readthedocs.org/projects/dicom-wsi/badge/?version=latest
:target: https://dicom-wsi.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
----------
Package for converting whole slide image files to DICOM.
* Free software: MIT license
* Documentation: https://dicom-wsi.readthedocs.io.
=====
Usage
=====
First, you need to install dicom_wsi and its dependencies. See this link_ for details.
.. _link: https://dicom-wsi.readthedocs.io/en/latest/installation.html
To use dicom-wsi:
.. code-block:: console
python dicom_wsi.cli.py -w <WSI File path> -o <OutputDirectory> -p <output file prefix> -y yaml/base.yaml
That's it! Most of the time you wan't need to change anything. But if you do, please see the example yaml_ file.
.. _yaml: https://github.com/Steven-N-Hart/dicom_wsi/blob/master/dicom_wsi/yaml/base.yaml
Features
--------
* Validate DICOM elements using pydicom_
* Output format DICOM formatted files (vetted with dciodvfy_)
TODO
--------
* Find out how to determine what `FileMetaInformationGroupLength` should be
Credits
-------
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
.. _dciodvfy: https://www.dclunie.com/dicom3tools/dciodvfy.html
.. _`file type`: https://openslide.org/
.. _pydicom: https://pydicom.github.io/
=======
History
=======
1.0.4 (2023-10-27)
------------------
* Decreased dependencies for install
* Added tryCatch for Aperio data without expected metadata
0.1.0 (2021-1-22)
------------------
* First release on PyPI.
Raw data
{
"_id": null,
"home_page": "https://github.com/Steven-N-Hart/dicom_wsi",
"name": "dicom-wsi",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": "",
"keywords": "dicom_wsi",
"author": "Steven N. Hart",
"author_email": "hart.steven@mayo.edu",
"download_url": "https://files.pythonhosted.org/packages/50/6e/75e00d32553e884c23afb9a288441fe64f39e0b9a0a72f384ba968ad4d80/dicom_wsi-1.0.4.tar.gz",
"platform": null,
"description": "=========\ndicom_wsi\n=========\n\n\n.. image:: https://img.shields.io/pypi/v/dicom_wsi.svg\n :target: https://pypi.python.org/pypi/dicom_wsi\n\n.. image:: https://img.shields.io/travis/Steven-N-Hart/dicom_wsi.svg\n :target: https://travis-ci.com/Steven-N-Hart/dicom_wsi\n\n.. image:: https://readthedocs.org/projects/dicom-wsi/badge/?version=latest\n :target: https://dicom-wsi.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n----------\n\nPackage for converting whole slide image files to DICOM.\n\n* Free software: MIT license\n* Documentation: https://dicom-wsi.readthedocs.io.\n\n=====\nUsage\n=====\n\nFirst, you need to install dicom_wsi and its dependencies. See this link_ for details.\n\n.. _link: https://dicom-wsi.readthedocs.io/en/latest/installation.html\n\nTo use dicom-wsi:\n\n.. code-block:: console\n\n python dicom_wsi.cli.py -w <WSI File path> -o <OutputDirectory> -p <output file prefix> -y yaml/base.yaml\n\n\nThat's it! Most of the time you wan't need to change anything. But if you do, please see the example yaml_ file.\n\n.. _yaml: https://github.com/Steven-N-Hart/dicom_wsi/blob/master/dicom_wsi/yaml/base.yaml\n\nFeatures\n--------\n* Validate DICOM elements using pydicom_\n* Output format DICOM formatted files (vetted with dciodvfy_)\n\nTODO\n--------\n* Find out how to determine what `FileMetaInformationGroupLength` should be\n\n\nCredits\n-------\n\nThis package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n.. _dciodvfy: https://www.dclunie.com/dicom3tools/dciodvfy.html\n.. _`file type`: https://openslide.org/\n.. _pydicom: https://pydicom.github.io/\n\n\n=======\nHistory\n=======\n\n1.0.4 (2023-10-27)\n------------------\n\n* Decreased dependencies for install\n* Added tryCatch for Aperio data without expected metadata\n\n\n\n0.1.0 (2021-1-22)\n------------------\n\n* First release on PyPI.\n\n\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "Package for converting whole slide image files to dicom.",
"version": "1.0.4",
"project_urls": {
"Homepage": "https://github.com/Steven-N-Hart/dicom_wsi"
},
"split_keywords": [
"dicom_wsi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "036294d07b68830354e66f353ffd3269a6061243844e69a70a21244104862160",
"md5": "7aa3d5dace70f335300fabee3591708b",
"sha256": "09a5d25061bebe50073fe0bffa540844eace7f0fc9ef31a1d0f2cf629c485301"
},
"downloads": -1,
"filename": "dicom_wsi-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7aa3d5dace70f335300fabee3591708b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 48637,
"upload_time": "2023-10-27T15:48:00",
"upload_time_iso_8601": "2023-10-27T15:48:00.307462Z",
"url": "https://files.pythonhosted.org/packages/03/62/94d07b68830354e66f353ffd3269a6061243844e69a70a21244104862160/dicom_wsi-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "506e75e00d32553e884c23afb9a288441fe64f39e0b9a0a72f384ba968ad4d80",
"md5": "d86f8167270fb01b88013724252b6418",
"sha256": "d98977a0474a9e1d4a282078f23de5251fa31e1202307b08475f96a42b37ae7a"
},
"downloads": -1,
"filename": "dicom_wsi-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "d86f8167270fb01b88013724252b6418",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 322883,
"upload_time": "2023-10-27T15:48:01",
"upload_time_iso_8601": "2023-10-27T15:48:01.672222Z",
"url": "https://files.pythonhosted.org/packages/50/6e/75e00d32553e884c23afb9a288441fe64f39e0b9a0a72f384ba968ad4d80/dicom_wsi-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-27 15:48:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Steven-N-Hart",
"github_project": "dicom_wsi",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "dicom-wsi"
}
JSON
