[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
<!-- PROJECT LOGO -->
<br />
<p align="center">
<a href="https://github.com/open-ortho/dicom4ortho">
<img src="https://raw.githubusercontent.com/open-ortho/dicom4ortho/master/images/open-ortho.png" alt="Logo" width="80" height="80">
</a>
<h3 align="center">dicom4ortho 0.3.12</h3>
<p align="center">
A Python library to create fully defined orthodontic photographs in DICOM.
<br />
<a href="https://open-ortho.github.io/dicom4ortho/"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://github.com/open-ortho/dicom4ortho">View Demo</a>
·
<a href="https://github.com/open-ortho/dicom4ortho/issues">Report Bug</a>
·
<a href="https://github.com/open-ortho/dicom4ortho/issues">Request Feature</a>
</p>
</p>
<!-- TABLE OF CONTENTS -->
- [About The Project](#about-the-project)
- [Built With](#built-with)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Validation with dicom3tools](#validation-with-dicom3tools)
- [Usage](#usage)
- [Known Issues](#known-issues)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
- [Acknowledgements](#acknowledgements)
<!-- ABOUT THE PROJECT -->
## About The Project
The DICOM standard is ready for any developer in the orthodontic community to
implement. However, it can be complicated and implementation can be time
consuming. We want to create a proof of concept to demonstrate how to
properly store orthodontic visible light images (aka photographs) using
DICOM, while ensuring all codes (necessary to uniquely identify each image
type) are in the proper place.
Here's why:
* Your time should be focused on creating something amazing.
* Being able to import and export DICOM images to and from your orthodontic
software will open doors to you and the orthodontic provider.
* No one software will serve all orthodontic providers completely. Adding
interoperability will allow your product to integrate with others, giving
additional value to your solution.
You may suggest changes by forking this repo and creating a pull request or
opening an issue. Thanks to all the people have have contributed to this
project!
A list of commonly used resources that we find helpful are listed in the
acknowledgements.
### Built With
* [pydicom](https://pydicom.github.io/)
* [pillow](https://python-pillow.org/)
* [dicom3tools](https://www.dclunie.com/dicom3tools.html)
<!-- GETTING STARTED -->
## Getting Started
Like any other Python module, install the module than use it. There is a CLI
interface as well.
### Prerequisites
- An installation of Python 3+.
- optional: [dicom3tools](https://www.dclunie.com/dicom3tools.html)
### Installation
Install unsing pipenv by running
$ pipenv install dicom4ortho
Install using pip by running
$ pip install dicom4ortho
Only Python 3+ is supported
### Validation with dicom3tools
The dicom3tools are used to validate and is only used when the `--validate`
option is used. This is just a conveninece wrapper for debugging, and it's
installation is not necessary for normal operation.
The [dicom3tools](https://www.dclunie.com/dicom3tools.html) can be installed
from compiled binaries, which are available for macOS and Windows.
Once installed, point `DICOM3TOOLS_PATH` in `config.py` to the installation
of the dicom3tools.
<!-- USAGE EXAMPLES -->
## Usage
The official documentation of this project is available on line
[here](https://open-ortho.github.io/dicom4ortho). Source code for the
documentation is in this repository under the `gh-pages` branch.
The DICOM images require a lot of information which is not contained in a
flat PNG or JPEG image. This information would, in a production environment,
usually come from the practice management software, or photo management
software.
The easiest way to feed this information to `dicom4ortho`'s CLI is using a
CSV file. You can find an example CSV file [here](resources/example/input_from.csv)
Once installed, if necessary, start the virtual environment:
pipenv shell
then use dicom4ortho like this:
$ dicom4ortho <filename>
Where `filename` should be a `.csv` file. Passing a single image file with
metadata through arguments is planned for future implementations.
## Known Issues
Please check the [Implementation Status](docs/IMPLEMENTATION_STATUS.md)
document.
<!-- ROADMAP -->
## Roadmap
See the [open issues](https://github.com/open-ortho/dicom4ortho/issues) for a list of proposed features (and known issues).
<!-- CONTRIBUTING -->
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a [Pull Request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)
<!-- LICENSE -->
## License
Distributed under the MIT License. See [LICENSE](LICENSE) for more information.
<!-- CONTACT -->
## Contact
Toni Magni- [@zgypa](https://twitter.com/zgypa) - open-ortho@afm.co
Project Link: [https://github.com/open-ortho/dicom4ortho](https://github.com/open-ortho/dicom4ortho)
<!-- ACKNOWLEDGEMENTS -->
## Acknowledgements
- [DICOM](https://www.webpagefx.com/tools/emoji-cheat-sheet)
- [American Dental Association Standards Committee for Dental Informatics](https://www.ada.org/en/science-research/dental-standards/standards-committee-on-dental-informatics)
<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[contributors-shield]: https://img.shields.io/github/contributors/open-ortho/dicom4ortho.svg?style=for-the-badge
[contributors-url]: https://github.com/open-ortho/dicom4ortho/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/open-ortho/dicom4ortho.svg?style=for-the-badge
[forks-url]: https://github.com/open-ortho/dicom4ortho/network/members
[stars-shield]: https://img.shields.io/github/stars/open-ortho/dicom4ortho.svg?style=for-the-badge
[stars-url]: https://github.com/open-ortho/dicom4ortho/stargazers
[issues-shield]: https://img.shields.io/github/issues/open-ortho/dicom4ortho.svg?style=for-the-badge
[issues-url]: https://github.com/open-ortho/dicom4ortho/issues
[license-shield]: https://img.shields.io/github/license/open-ortho/dicom4ortho.svg?style=for-the-badge
[license-url]: https://github.com/open-ortho/dicom4ortho/blob/master/LICENSE
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/open-ortho
[product-screenshot]: images/screenshot.png
[example-csv-url]: resources/example/input_from.csv
Raw data
{
"_id": null,
"home_page": "https://github.com/open-ortho/dicom4ortho",
"name": "dicom4ortho",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": null,
"keywords": "DICOM VL Visible Light Photography Orthodontics",
"author": "Toni Magni",
"author_email": "amagni@open-ortho.org",
"download_url": "https://files.pythonhosted.org/packages/ac/bc/d76e0519f6cd23c8cfa832efe82b55042a783817f8a1a41e3faf4886946f/dicom4ortho-0.3.12.tar.gz",
"platform": null,
"description": "[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![MIT License][license-shield]][license-url]\n[![LinkedIn][linkedin-shield]][linkedin-url]\n\n<!-- PROJECT LOGO -->\n<br />\n<p align=\"center\">\n <a href=\"https://github.com/open-ortho/dicom4ortho\">\n <img src=\"https://raw.githubusercontent.com/open-ortho/dicom4ortho/master/images/open-ortho.png\" alt=\"Logo\" width=\"80\" height=\"80\">\n </a>\n\n <h3 align=\"center\">dicom4ortho 0.3.12</h3>\n\n <p align=\"center\">\n A Python library to create fully defined orthodontic photographs in DICOM.\n <br />\n <a href=\"https://open-ortho.github.io/dicom4ortho/\"><strong>Explore the docs \u00bb</strong></a>\n <br />\n <br />\n <a href=\"https://github.com/open-ortho/dicom4ortho\">View Demo</a>\n \u00b7\n <a href=\"https://github.com/open-ortho/dicom4ortho/issues\">Report Bug</a>\n \u00b7\n <a href=\"https://github.com/open-ortho/dicom4ortho/issues\">Request Feature</a>\n </p>\n</p>\n\n<!-- TABLE OF CONTENTS -->\n- [About The Project](#about-the-project)\n - [Built With](#built-with)\n- [Getting Started](#getting-started)\n - [Prerequisites](#prerequisites)\n - [Installation](#installation)\n - [Validation with dicom3tools](#validation-with-dicom3tools)\n- [Usage](#usage)\n- [Known Issues](#known-issues)\n- [Roadmap](#roadmap)\n- [Contributing](#contributing)\n- [License](#license)\n- [Contact](#contact)\n- [Acknowledgements](#acknowledgements)\n\n\n<!-- ABOUT THE PROJECT -->\n## About The Project\n\nThe DICOM standard is ready for any developer in the orthodontic community to\nimplement. However, it can be complicated and implementation can be time\nconsuming. We want to create a proof of concept to demonstrate how to\nproperly store orthodontic visible light images (aka photographs) using\nDICOM, while ensuring all codes (necessary to uniquely identify each image\ntype) are in the proper place.\n\nHere's why:\n\n* Your time should be focused on creating something amazing.\n* Being able to import and export DICOM images to and from your orthodontic\n software will open doors to you and the orthodontic provider.\n* No one software will serve all orthodontic providers completely. Adding\n interoperability will allow your product to integrate with others, giving\n additional value to your solution.\n\nYou may suggest changes by forking this repo and creating a pull request or\nopening an issue. Thanks to all the people have have contributed to this\nproject!\n\nA list of commonly used resources that we find helpful are listed in the\nacknowledgements.\n\n### Built With\n\n* [pydicom](https://pydicom.github.io/)\n* [pillow](https://python-pillow.org/)\n* [dicom3tools](https://www.dclunie.com/dicom3tools.html)\n\n<!-- GETTING STARTED -->\n## Getting Started\n\nLike any other Python module, install the module than use it. There is a CLI\ninterface as well.\n\n### Prerequisites\n\n- An installation of Python 3+.\n- optional: [dicom3tools](https://www.dclunie.com/dicom3tools.html)\n\n### Installation\n\nInstall unsing pipenv by running\n\n $ pipenv install dicom4ortho\n\nInstall using pip by running\n\n $ pip install dicom4ortho\n\nOnly Python 3+ is supported\n\n### Validation with dicom3tools\n\nThe dicom3tools are used to validate and is only used when the `--validate`\noption is used. This is just a conveninece wrapper for debugging, and it's\ninstallation is not necessary for normal operation.\n\nThe [dicom3tools](https://www.dclunie.com/dicom3tools.html) can be installed\nfrom compiled binaries, which are available for macOS and Windows.\n\nOnce installed, point `DICOM3TOOLS_PATH` in `config.py` to the installation\nof the dicom3tools.\n\n<!-- USAGE EXAMPLES -->\n## Usage\n\nThe official documentation of this project is available on line\n[here](https://open-ortho.github.io/dicom4ortho). Source code for the\ndocumentation is in this repository under the `gh-pages` branch.\n\nThe DICOM images require a lot of information which is not contained in a\nflat PNG or JPEG image. This information would, in a production environment,\nusually come from the practice management software, or photo management\nsoftware.\n\nThe easiest way to feed this information to `dicom4ortho`'s CLI is using a\nCSV file. You can find an example CSV file [here](resources/example/input_from.csv)\n\nOnce installed, if necessary, start the virtual environment:\n\n pipenv shell\n\nthen use dicom4ortho like this:\n\n $ dicom4ortho <filename>\n\nWhere `filename` should be a `.csv` file. Passing a single image file with\nmetadata through arguments is planned for future implementations.\n\n## Known Issues\n\nPlease check the [Implementation Status](docs/IMPLEMENTATION_STATUS.md)\ndocument.\n\n<!-- ROADMAP -->\n## Roadmap\n\nSee the [open issues](https://github.com/open-ortho/dicom4ortho/issues) for a list of proposed features (and known issues).\n\n<!-- CONTRIBUTING -->\n## Contributing\n\nContributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a [Pull Request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)\n\n<!-- LICENSE -->\n## License\n\nDistributed under the MIT License. See [LICENSE](LICENSE) for more information.\n\n<!-- CONTACT -->\n## Contact\n\nToni Magni- [@zgypa](https://twitter.com/zgypa) - open-ortho@afm.co\n\nProject Link: [https://github.com/open-ortho/dicom4ortho](https://github.com/open-ortho/dicom4ortho)\n\n<!-- ACKNOWLEDGEMENTS -->\n## Acknowledgements\n\n- [DICOM](https://www.webpagefx.com/tools/emoji-cheat-sheet)\n- [American Dental Association Standards Committee for Dental Informatics](https://www.ada.org/en/science-research/dental-standards/standards-committee-on-dental-informatics)\n\n<!-- MARKDOWN LINKS & IMAGES -->\n<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->\n[contributors-shield]: https://img.shields.io/github/contributors/open-ortho/dicom4ortho.svg?style=for-the-badge\n[contributors-url]: https://github.com/open-ortho/dicom4ortho/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/open-ortho/dicom4ortho.svg?style=for-the-badge\n[forks-url]: https://github.com/open-ortho/dicom4ortho/network/members\n[stars-shield]: https://img.shields.io/github/stars/open-ortho/dicom4ortho.svg?style=for-the-badge\n[stars-url]: https://github.com/open-ortho/dicom4ortho/stargazers\n[issues-shield]: https://img.shields.io/github/issues/open-ortho/dicom4ortho.svg?style=for-the-badge\n[issues-url]: https://github.com/open-ortho/dicom4ortho/issues\n[license-shield]: https://img.shields.io/github/license/open-ortho/dicom4ortho.svg?style=for-the-badge\n[license-url]: https://github.com/open-ortho/dicom4ortho/blob/master/LICENSE\n[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555\n[linkedin-url]: https://linkedin.com/in/open-ortho\n[product-screenshot]: images/screenshot.png\n[example-csv-url]: resources/example/input_from.csv\n",
"bugtrack_url": null,
"license": null,
"summary": "A DICOM Implementation for Orthodontic Images",
"version": "0.3.12",
"project_urls": {
"Homepage": "https://github.com/open-ortho/dicom4ortho"
},
"split_keywords": [
"dicom",
"vl",
"visible",
"light",
"photography",
"orthodontics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "59f77deb1bf51057192e8cae705fe0e4c1acb4f8dcfaeed0faf2bb421e873eff",
"md5": "85424439d8f96efa784184a201981064",
"sha256": "bd3bf500c88cdbe5829650dc89b3213bd89aecb5814d168b0fa80f2450349256"
},
"downloads": -1,
"filename": "dicom4ortho-0.3.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "85424439d8f96efa784184a201981064",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 38243,
"upload_time": "2024-08-09T11:42:55",
"upload_time_iso_8601": "2024-08-09T11:42:55.899661Z",
"url": "https://files.pythonhosted.org/packages/59/f7/7deb1bf51057192e8cae705fe0e4c1acb4f8dcfaeed0faf2bb421e873eff/dicom4ortho-0.3.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "acbcd76e0519f6cd23c8cfa832efe82b55042a783817f8a1a41e3faf4886946f",
"md5": "a40fc7ca9dfdedc657c5037ca4ce036b",
"sha256": "c89e1e3ed016968b6f99f2effdafcbc416d56f276a6a1d60eaacbc1397601a99"
},
"downloads": -1,
"filename": "dicom4ortho-0.3.12.tar.gz",
"has_sig": false,
"md5_digest": "a40fc7ca9dfdedc657c5037ca4ce036b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 43477,
"upload_time": "2024-08-09T11:42:56",
"upload_time_iso_8601": "2024-08-09T11:42:56.921519Z",
"url": "https://files.pythonhosted.org/packages/ac/bc/d76e0519f6cd23c8cfa832efe82b55042a783817f8a1a41e3faf4886946f/dicom4ortho-0.3.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-09 11:42:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "open-ortho",
"github_project": "dicom4ortho",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "dicom4ortho"
}
JSON
