# napari-tomodl
[](https://github.com/marcoso96/napari-tomodl/raw/main/LICENSE)
[](https://pypi.org/project/napari-tomodl)
[](https://python.org)
[](https://github.com/marcoso96/napari-tomodl/actions)
[](https://codecov.io/gh/marcoso96/napari-tomodl)
[](https://napari-hub.org/plugins/napari-tomodl)
A plugin for optical projection tomography reconstruction with model-based neural networks.
----------------------------------
This [napari] plugin was generated with [Cookiecutter] using [@napari]'s [cookiecutter-napari-plugin] template.
<!--
Don't miss the full getting started guide to set up your new package:
https://github.com/napari/cookiecutter-napari-plugin#getting-started
and review the napari docs for plugin developers:
https://napari.org/stable/plugins/index.html
-->
## Introduction and usage
ToMoDL allows users to reconstruct tomography images from its raw projections juts from uploading them as an ordered stack of files into the napari viewer.
1 - Load ordered stack: Click File -> Open Files as Stack... and load the angular projections for parallel beam optical tomography reconstruction.
2 - Select the current volume in the dropdown menu with the button 'Select image layer'. Notice that the projections should be in grayscale and more than one slide in the stack.
3 - If the axis is not correctly aligned in acquisition time, we provide an algorithm to do so by clicking on 'Align axis'. This will align the sinogram respect to the center of the detector in order to maximise the variance of the reconstructions. See Walls et al.
4 - Reshape the reconstructed volume to a desired size. This can be useful to prevent exhausting your computing capabilities.
5 - Clip to circle should be False by default.
6 - Choose if filtering should be used. By the moment we only allow using ramp filtering for FBP only (both CPU and GPU).
7 - Choose the correct order of the axis of the projections (T -> Theta axis, Q -> Detector axis)
8 - Reconstruct! A new Layer should be created on top of the projections stack containing the reconstructed volume.
## Installation
This package requires [torch-radon] for optimized GPU tomographic reconstruction:
pip install 'torch-radon @ https://rosh-public.s3-eu-west-1.amazonaws.com/radon-v2/cuda-11.1/torch-1.8/torch_radon-2.0.0-cp38-cp38-linux_x86_64.whl'
and `PyTorch == 1.8.0` via wheel, which can be downloaded and installed with:
pip install 'torch @ https://download.pytorch.org/whl/cu111/torch-1.8.0%2Bcu111-cp38-cp38-linux_x86_64.whl'
You can install `napari-tomodl` via [pip]:
pip install napari-tomodl
## Contributing
Contributions are very welcome. Tests can be run with [tox], please ensure
the coverage at least stays the same before you submit a pull request.
## License
Distributed under the terms of the [MIT] license,
"napari-tomodl" is free and open source software
## Issues
If you encounter any problems, please [file an issue] along with a detailed description.
[napari]: https://github.com/napari/napari
[Cookiecutter]: https://github.com/audreyr/cookiecutter
[@napari]: https://github.com/napari
[MIT]: http://opensource.org/licenses/MIT
[BSD-3]: http://opensource.org/licenses/BSD-3-Clause
[GNU GPL v3.0]: http://www.gnu.org/licenses/gpl-3.0.txt
[GNU LGPL v3.0]: http://www.gnu.org/licenses/lgpl-3.0.txt
[Apache Software License 2.0]: http://www.apache.org/licenses/LICENSE-2.0
[Mozilla Public License 2.0]: https://www.mozilla.org/media/MPL/2.0/index.txt
[cookiecutter-napari-plugin]: https://github.com/napari/cookiecutter-napari-plugin
[napari]: https://github.com/napari/napari
[torch-radon]: https://github.com/matteo-ronchetti/torch-radon
[tox]: https://tox.readthedocs.io/en/latest/
[pip]: https://pypi.org/project/pip/
[PyPI]: https://pypi.org/
Raw data
{
"_id": null,
"home_page": null,
"name": "napari-tomodl",
"maintainer": null,
"docs_url": null,
"requires_python": "<=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Marcos Antonio Obando, Germ\u00e1n Mato, Teresa Correia",
"author_email": "marcos.obando@ib.edu.ar",
"download_url": "https://files.pythonhosted.org/packages/c4/dc/d543282a9453d4d1ab2e4736d1ae566b2533133e8c9124799261de29c2e6/napari_tomodl-0.1.14.tar.gz",
"platform": null,
"description": "# napari-tomodl\n\n[](https://github.com/marcoso96/napari-tomodl/raw/main/LICENSE)\n[](https://pypi.org/project/napari-tomodl)\n[](https://python.org)\n[](https://github.com/marcoso96/napari-tomodl/actions)\n[](https://codecov.io/gh/marcoso96/napari-tomodl)\n[](https://napari-hub.org/plugins/napari-tomodl)\n\nA plugin for optical projection tomography reconstruction with model-based neural networks.\n\n----------------------------------\n\nThis [napari] plugin was generated with [Cookiecutter] using [@napari]'s [cookiecutter-napari-plugin] template.\n\n<!--\nDon't miss the full getting started guide to set up your new package:\nhttps://github.com/napari/cookiecutter-napari-plugin#getting-started\n\nand review the napari docs for plugin developers:\nhttps://napari.org/stable/plugins/index.html\n-->\n## Introduction and usage\n\nToMoDL allows users to reconstruct tomography images from its raw projections juts from uploading them as an ordered stack of files into the napari viewer.\n\n1 - Load ordered stack: Click File -> Open Files as Stack... and load the angular projections for parallel beam optical tomography reconstruction.\n\n\n\n2 - Select the current volume in the dropdown menu with the button 'Select image layer'. Notice that the projections should be in grayscale and more than one slide in the stack.\n\n\n\n3 - If the axis is not correctly aligned in acquisition time, we provide an algorithm to do so by clicking on 'Align axis'. This will align the sinogram respect to the center of the detector in order to maximise the variance of the reconstructions. See Walls et al. \n\n4 - Reshape the reconstructed volume to a desired size. This can be useful to prevent exhausting your computing capabilities.\n\n5 - Clip to circle should be False by default.\n\n6 - Choose if filtering should be used. By the moment we only allow using ramp filtering for FBP only (both CPU and GPU).\n\n7 - Choose the correct order of the axis of the projections (T -> Theta axis, Q -> Detector axis)\n\n8 - Reconstruct! A new Layer should be created on top of the projections stack containing the reconstructed volume.\n\n\n\n## Installation\n\nThis package requires [torch-radon] for optimized GPU tomographic reconstruction:\n\n pip install 'torch-radon @ https://rosh-public.s3-eu-west-1.amazonaws.com/radon-v2/cuda-11.1/torch-1.8/torch_radon-2.0.0-cp38-cp38-linux_x86_64.whl'\n\nand `PyTorch == 1.8.0` via wheel, which can be downloaded and installed with: \n\n pip install 'torch @ https://download.pytorch.org/whl/cu111/torch-1.8.0%2Bcu111-cp38-cp38-linux_x86_64.whl'\n\nYou can install `napari-tomodl` via [pip]:\n\n pip install napari-tomodl\n\n\n\n\n## Contributing\n\nContributions are very welcome. Tests can be run with [tox], please ensure\nthe coverage at least stays the same before you submit a pull request.\n\n## License\n\nDistributed under the terms of the [MIT] license,\n\"napari-tomodl\" is free and open source software\n\n## Issues\n\nIf you encounter any problems, please [file an issue] along with a detailed description.\n\n[napari]: https://github.com/napari/napari\n[Cookiecutter]: https://github.com/audreyr/cookiecutter\n[@napari]: https://github.com/napari\n[MIT]: http://opensource.org/licenses/MIT\n[BSD-3]: http://opensource.org/licenses/BSD-3-Clause\n[GNU GPL v3.0]: http://www.gnu.org/licenses/gpl-3.0.txt\n[GNU LGPL v3.0]: http://www.gnu.org/licenses/lgpl-3.0.txt\n[Apache Software License 2.0]: http://www.apache.org/licenses/LICENSE-2.0\n[Mozilla Public License 2.0]: https://www.mozilla.org/media/MPL/2.0/index.txt\n[cookiecutter-napari-plugin]: https://github.com/napari/cookiecutter-napari-plugin\n\n[napari]: https://github.com/napari/napari\n[torch-radon]: https://github.com/matteo-ronchetti/torch-radon\n[tox]: https://tox.readthedocs.io/en/latest/\n[pip]: https://pypi.org/project/pip/\n[PyPI]: https://pypi.org/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A plugin for optical projection tomography reconstruction with model-based neural networks.",
"version": "0.1.14",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b6c6e9aa5761b7dbf16a24fd31969e32fba3804cc664f6e11b1f4a37542d3731",
"md5": "ac8c52431aea0bb6232c74fdd67ccfee",
"sha256": "6f953877a8d27f017332b76566845c69c31ea512a9bf7e0387378a6e35a1b3be"
},
"downloads": -1,
"filename": "napari_tomodl-0.1.14-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ac8c52431aea0bb6232c74fdd67ccfee",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<=3.9",
"size": 26927,
"upload_time": "2024-04-15T17:12:46",
"upload_time_iso_8601": "2024-04-15T17:12:46.496447Z",
"url": "https://files.pythonhosted.org/packages/b6/c6/e9aa5761b7dbf16a24fd31969e32fba3804cc664f6e11b1f4a37542d3731/napari_tomodl-0.1.14-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c4dcd543282a9453d4d1ab2e4736d1ae566b2533133e8c9124799261de29c2e6",
"md5": "85150dc69a2574fc0ad55bdf458fa31a",
"sha256": "7fecf4a36286070a486bf850330b673ab6ecc3f857dee5f8c9710f8eb587afe8"
},
"downloads": -1,
"filename": "napari_tomodl-0.1.14.tar.gz",
"has_sig": false,
"md5_digest": "85150dc69a2574fc0ad55bdf458fa31a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<=3.9",
"size": 26173,
"upload_time": "2024-04-15T17:12:48",
"upload_time_iso_8601": "2024-04-15T17:12:48.666254Z",
"url": "https://files.pythonhosted.org/packages/c4/dc/d543282a9453d4d1ab2e4736d1ae566b2533133e8c9124799261de29c2e6/napari_tomodl-0.1.14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-15 17:12:48",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "napari-tomodl"
}
JSON