| Name | dive-mri JSON |
| Version |
1.0.4
JSON |
| download |
| home_page | None |
| Summary | The Diffusion Visualization Explorer (DiVE) Tool |
| upload_time | 2024-10-28 18:52:15 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | Unless otherwise specified by LICENSE.txt files in individual directories, or within individual files or functions, all code is: Copyright (c) 2024, DiVE developers All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the DiVE developers nor the names of any contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
diffusion mri
along-tract visualization
tractography
white matter bundle
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<a name="readme-top"></a>
<br />
<div align="center">
<a href="https://raw.githubusercontent.com/USC-LoBeS/dive/main/images/Logo.svg">
<img src="https://raw.githubusercontent.com/USC-LoBeS/dive/main/images/Logo.svg" alt="Logo" width="80" height="80">
</a>
<h3 align="center">DiVE</h3>
<p align="center">
Diffusion Visualization and Explorer
<br />
<a href="https://github.com/USC-LoBeS/dive/tree/main/example#readme"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://github.com/USC-LoBeS/DiVE/issues">Report Bug</a>
·
<a href="https://github.com/USC-LoBeS/DiVE/issues">Request Feature</a>
</p>
</div>
<!-- TABLE OF CONTENTS -->
<details>
<summary>Table of Contents</summary>
<ol>
<li><a href="#built-with">Built With</a></li>
<li>
<a href="#about-the-project">About The Project</a>
</li>
<li>
<a href="#getting-started">Getting Started</a>
<ul>
<li><a href="#installation">Installation</a></li>
</ul>
</li>
<li><a href="#ui-interaction">UI Interaction</a></li>
<li><a href="#usage-cli">Usage CLI</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#contact">Contact</a></li>
<li><a href="#acknowledgments">Acknowledgments</a></li>
</ol>
</details>
### Built With
[![Fury][Fury.]][Fury-url]
[![OpenGL][OpenGL.]][OpenGL-url]
[![distinctipy][dist.]][dist-url]
[![pypi][pypi.]][pypi-url]
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ABOUT THE PROJECT -->
## About The Project
Diffusion Visualization and Explorer (DiVE) is a tool designed for visualizing medical imaging data. It allows users to visualize tractography in various formats (TRK, TCK, TRX, VTK), binary masks in NIfTI format, and meshes in VTK format. Users also have the flexibility to load multiple Regions of Interest (ROIs) in different combinations, whether they are exclusively of one type (mesh, mask, or tract) or a combination of types. Additionally, users can toggle between 3D visualization and saving the output by specifying a designated path.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## Getting Started
This is an example of how you may give instructions on setting up your project locally.
To get a local copy up and running follow these simple example steps.
### Installation
```sh
pip install dive-mri
```
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- UI Interaction -->
## UI Interaction
1. <strong>Choose Type:</strong> Use the type of ROI type (Mask/Mesh/Tract/Brain) to open the drop down having the names of all the files of that type, to select that required ROI.
2. <strong>Change View:</strong> Click on the buttons to change the view to Sagittal/Coronal/Axial view.
3. <strong>Choose Slice:</strong> Change the brain slice value based on the selected view (a brain_2d file is required to use this)
4. <strong>Change Opacity (Streamlines, Mask, Mesh, Slice):</strong>
Use the sliders to change the opacity of the file for a selected file.
5. <strong> Add Button: </strong> To add more items, click the add button and choose the type of file you want to add.
6. <strong> Remove Button: </strong> To remove a specific file, select it using the Choose type and then click this button.
![Image][ui-image]
<!-- USAGE -->
## USAGE CLI
Here are few example of how to use the code for specific features.
<strong>Rendering Tract/Mask/Mesh :</strong>
![Image][fig1-image]
```
The user can give a 3D region of interest label image in NIFTI format and the tool will render it as a set of 3D contours (Figure A). Tract rendering can be conducted across all common formats (trk, tck, trx, vtk), with user defined coloring options, as well as available defaults (Figure B). Each fiber tract is displayed as tubes with a user-defined width. The tool applies either the color specified by the user or a random color for single labeled masks and chooses a set of distinct colors for multi-labeled masks using “distinctipy” or uses the colormap specified by the user (Figure C). DiVE also allows for the overlay of NIFTI masks and surface meshes on the fiber tracts, which can map scalar values to color or opacity, providing insights into tissue microstructure. The tool supports backgrounds using either a 3D glass brain or 2D slices. Visualization can be done in any stereotaxic space.
```
<strong> Note: Specific Use cases can be found in [open Examples](https://github.com/USC-LoBeS/dive/tree/main/example) </strong>
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTACT -->
## Contact
Lobes - [Siddharth Narula](mailto:narulas@usc.edu), [Iyad Ba Gari](mailto:bagari@usc.edu), [Neda Janahshad](mailto:njahansh@usc.edu)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGMENTS -->
## Acknowledgments
* [Siddharth Narula, Iyad Ba Gari, Shruti P. Gadewar, Sunanda Somu, Neda Jahanshad, "Diffusion Visualization Explorer (DiVE) Organization for Human Brain Mapping (OHBM 2024) June 26,2024](https://ww6.aievolution.com/hbm2401/index.cfm?do=abs.viewAbstract&style=1&abstractID=2661)
* [Iyad Ba Gari, Shayan Javid, Alyssa H. Zhu, Shruti P. Gadewar, Siddharth Narula, Abhinaav Ramesh, Sophia I. Thomopoulos et al. "Along-Tract Parameterization of White Matter Microstructure using Medial Tractography Analysis (MeTA)." In 2023 19th International Symposium on Medical Information Processing and Analysis (SIPAIM), pp. 1-5. IEEE, 2023.](https://doi.org/10.1109/SIPAIM56729.2023.10373540)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- MARKDOWN LINKS & IMAGES -->
[contributors-url]: https://github.com/USC-LoBeS/DiVE/graphs/contributors
[forks-shield]: https://github.com/USC-LoBeS/DiVE/repo_name.svg?style=for-the-badge
[issues-url]: https://github.com/USC-LoBeS/DiVE/issues
[ui-image]: https://raw.githubusercontent.com/USC-LoBeS/dive/main/images/UI.png
[fig1-image]: https://raw.githubusercontent.com/USC-LoBeS/dive/main/images/Figure_1.png
[Fury.]: https://img.shields.io/badge/Fury-red?logo=https%3A%2F%2Ffury.gl%2Flatest%2F_static%2Fimages%2Flogo.svg
[Fury-url]: https://fury.gl/latest/index.html
[OpenGL.]: https://img.shields.io/badge/OpenGL-%235586A4?logo=https%3A%2F%2Ffury.gl%2Flatest%2F_static%2Fimages%2Flogo.svg
[OpenGL-url]:https://www.opengl.org/
[dist.]:https://img.shields.io/badge/distinctipy-blue?logo=https%3A%2F%2Ffury.gl%2Flatest%2F_static%2Fimages%2Flogo.svg
[dist-url]: https://doi.org/10.5281/zenodo.3985191
[pypi.]:https://img.shields.io/badge/pypi-v1.4-blue
[pypi-url]: https://pypi.org/project/dive-mri/
Raw data
{
"_id": null,
"home_page": null,
"name": "dive-mri",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "Diffusion MRI, along-tract visualization, tractography, white matter bundle",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/47/3a/ce52ae3d0285c19f96f5a29eefd5971e70a0712ed256ce7ced934e64e105/dive_mri-1.0.4.tar.gz",
"platform": null,
"description": "<a name=\"readme-top\"></a>\n\n<br />\n<div align=\"center\">\n <a href=\"https://raw.githubusercontent.com/USC-LoBeS/dive/main/images/Logo.svg\">\n <img src=\"https://raw.githubusercontent.com/USC-LoBeS/dive/main/images/Logo.svg\" alt=\"Logo\" width=\"80\" height=\"80\">\n </a>\n\n<h3 align=\"center\">DiVE</h3>\n\n <p align=\"center\">\n Diffusion Visualization and Explorer\n <br />\n <a href=\"https://github.com/USC-LoBeS/dive/tree/main/example#readme\"><strong>Explore the docs \u00bb</strong></a>\n <br />\n <br />\n <a href=\"https://github.com/USC-LoBeS/DiVE/issues\">Report Bug</a>\n \u00b7\n <a href=\"https://github.com/USC-LoBeS/DiVE/issues\">Request Feature</a>\n </p>\n</div>\n\n\n\n<!-- TABLE OF CONTENTS -->\n<details>\n <summary>Table of Contents</summary>\n <ol>\n <li><a href=\"#built-with\">Built With</a></li>\n <li>\n <a href=\"#about-the-project\">About The Project</a>\n </li>\n <li>\n <a href=\"#getting-started\">Getting Started</a>\n <ul>\n <li><a href=\"#installation\">Installation</a></li>\n </ul>\n </li>\n <li><a href=\"#ui-interaction\">UI Interaction</a></li>\n <li><a href=\"#usage-cli\">Usage CLI</a></li>\n <li><a href=\"#contributing\">Contributing</a></li>\n <li><a href=\"#contact\">Contact</a></li>\n <li><a href=\"#acknowledgments\">Acknowledgments</a></li>\n </ol>\n</details>\n\n### Built With\n\n[![Fury][Fury.]][Fury-url]\n[![OpenGL][OpenGL.]][OpenGL-url]\n[![distinctipy][dist.]][dist-url]\n[![pypi][pypi.]][pypi-url]\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n\n\n<!-- ABOUT THE PROJECT -->\n## About The Project\n\n Diffusion Visualization and Explorer (DiVE) is a tool designed for visualizing medical imaging data. It allows users to visualize tractography in various formats (TRK, TCK, TRX, VTK), binary masks in NIfTI format, and meshes in VTK format. Users also have the flexibility to load multiple Regions of Interest (ROIs) in different combinations, whether they are exclusively of one type (mesh, mask, or tract) or a combination of types. Additionally, users can toggle between 3D visualization and saving the output by specifying a designated path.\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n\n\n\n\n<!-- GETTING STARTED -->\n## Getting Started\n\nThis is an example of how you may give instructions on setting up your project locally.\nTo get a local copy up and running follow these simple example steps.\n\n\n### Installation\n\n ```sh\n pip install dive-mri\n ```\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n\n\n<!-- UI Interaction -->\n\n## UI Interaction\n1. <strong>Choose Type:</strong> Use the type of ROI type (Mask/Mesh/Tract/Brain) to open the drop down having the names of all the files of that type, to select that required ROI.\n2. <strong>Change View:</strong> Click on the buttons to change the view to Sagittal/Coronal/Axial view.\n3. <strong>Choose Slice:</strong> Change the brain slice value based on the selected view (a brain_2d file is required to use this)\n4. <strong>Change Opacity (Streamlines, Mask, Mesh, Slice):</strong> \nUse the sliders to change the opacity of the file for a selected file.\n5. <strong> Add Button: </strong> To add more items, click the add button and choose the type of file you want to add.\n6. <strong> Remove Button: </strong> To remove a specific file, select it using the Choose type and then click this button.\n \n![Image][ui-image]\n\n<!-- USAGE -->\n## USAGE CLI\n\nHere are few example of how to use the code for specific features.\n\n<strong>Rendering Tract/Mask/Mesh :</strong> \n![Image][fig1-image]\n```\nThe user can give a 3D region of interest label image in NIFTI format and the tool will render it as a set of 3D contours (Figure A). Tract rendering can be conducted across all common formats (trk, tck, trx, vtk), with user defined coloring options, as well as available defaults (Figure B). Each fiber tract is displayed as tubes with a user-defined width. The tool applies either the color specified by the user or a random color for single labeled masks and chooses a set of distinct colors for multi-labeled masks using \u201cdistinctipy\u201d or uses the colormap specified by the user (Figure C). DiVE also allows for the overlay of NIFTI masks and surface meshes on the fiber tracts, which can map scalar values to color or opacity, providing insights into tissue microstructure. The tool supports backgrounds using either a 3D glass brain or 2D slices. Visualization can be done in any stereotaxic space.\n```\n <strong> Note: Specific Use cases can be found in [open Examples](https://github.com/USC-LoBeS/dive/tree/main/example) </strong>\n\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n\n<!-- CONTACT -->\n## Contact\n\nLobes - [Siddharth Narula](mailto:narulas@usc.edu), [Iyad Ba Gari](mailto:bagari@usc.edu), [Neda Janahshad](mailto:njahansh@usc.edu)\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n\n\n<!-- ACKNOWLEDGMENTS -->\n## Acknowledgments\n\n* [Siddharth Narula, Iyad Ba Gari, Shruti P. Gadewar, Sunanda Somu, Neda Jahanshad, \"Diffusion Visualization Explorer (DiVE) Organization for Human Brain Mapping (OHBM 2024) June 26,2024](https://ww6.aievolution.com/hbm2401/index.cfm?do=abs.viewAbstract&style=1&abstractID=2661)\n\n* [Iyad Ba Gari, Shayan Javid, Alyssa H. Zhu, Shruti P. Gadewar, Siddharth Narula, Abhinaav Ramesh, Sophia I. Thomopoulos et al. \"Along-Tract Parameterization of White Matter Microstructure using Medial Tractography Analysis (MeTA).\" In 2023 19th International Symposium on Medical Information Processing and Analysis (SIPAIM), pp. 1-5. IEEE, 2023.](https://doi.org/10.1109/SIPAIM56729.2023.10373540)\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n\n\n<!-- MARKDOWN LINKS & IMAGES -->\n[contributors-url]: https://github.com/USC-LoBeS/DiVE/graphs/contributors\n[forks-shield]: https://github.com/USC-LoBeS/DiVE/repo_name.svg?style=for-the-badge\n[issues-url]: https://github.com/USC-LoBeS/DiVE/issues\n\n[ui-image]: https://raw.githubusercontent.com/USC-LoBeS/dive/main/images/UI.png\n[fig1-image]: https://raw.githubusercontent.com/USC-LoBeS/dive/main/images/Figure_1.png\n\n[Fury.]: https://img.shields.io/badge/Fury-red?logo=https%3A%2F%2Ffury.gl%2Flatest%2F_static%2Fimages%2Flogo.svg\n[Fury-url]: https://fury.gl/latest/index.html\n[OpenGL.]: https://img.shields.io/badge/OpenGL-%235586A4?logo=https%3A%2F%2Ffury.gl%2Flatest%2F_static%2Fimages%2Flogo.svg\n[OpenGL-url]:https://www.opengl.org/\n[dist.]:https://img.shields.io/badge/distinctipy-blue?logo=https%3A%2F%2Ffury.gl%2Flatest%2F_static%2Fimages%2Flogo.svg\n[dist-url]: https://doi.org/10.5281/zenodo.3985191\n[pypi.]:https://img.shields.io/badge/pypi-v1.4-blue\n[pypi-url]: https://pypi.org/project/dive-mri/\n",
"bugtrack_url": null,
"license": "Unless otherwise specified by LICENSE.txt files in individual directories, or within individual files or functions, all code is: Copyright (c) 2024, DiVE developers All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the DiVE developers nor the names of any contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
"summary": "The Diffusion Visualization Explorer (DiVE) Tool",
"version": "1.0.4",
"project_urls": {
"Repository": "https://github.com/USC-LoBeS/dive"
},
"split_keywords": [
"diffusion mri",
" along-tract visualization",
" tractography",
" white matter bundle"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "82ea3e3eeded6503cd88580bea0b5be0acc9207d54abd14a3f7e1ca7b7ae43c9",
"md5": "edb5c0aa02d3ac34e065ca630d793a6c",
"sha256": "5a475bb9cd71a390ad310bee029e56861e87ce5e98b3c30f5eaca2ae77d0a4cc"
},
"downloads": -1,
"filename": "dive_mri-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "edb5c0aa02d3ac34e065ca630d793a6c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 64857,
"upload_time": "2024-10-28T18:52:14",
"upload_time_iso_8601": "2024-10-28T18:52:14.612393Z",
"url": "https://files.pythonhosted.org/packages/82/ea/3e3eeded6503cd88580bea0b5be0acc9207d54abd14a3f7e1ca7b7ae43c9/dive_mri-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "473ace52ae3d0285c19f96f5a29eefd5971e70a0712ed256ce7ced934e64e105",
"md5": "edb569dbf485344fb8ed90a355b489ff",
"sha256": "929024a718dab4a90a10b20090c6343859f8f41f54880f8c8996461af9e71b3b"
},
"downloads": -1,
"filename": "dive_mri-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "edb569dbf485344fb8ed90a355b489ff",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 68372,
"upload_time": "2024-10-28T18:52:15",
"upload_time_iso_8601": "2024-10-28T18:52:15.881917Z",
"url": "https://files.pythonhosted.org/packages/47/3a/ce52ae3d0285c19f96f5a29eefd5971e70a0712ed256ce7ced934e64e105/dive_mri-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-28 18:52:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "USC-LoBeS",
"github_project": "dive",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "dive-mri"
}
