# Nifti Overlay
Nifti Overlay is a Python program for creating visualizations of 3D volumetric neuorimaging data. It specifically creates tiled images of one or more images overlaid on top of one of another.
Here is an example output image, showing a registered PET image on top of a T1-weighted MRI:
## Why use this package?
[I](https://github.com/earnestt1234/) wrote this package to help with quality control for neuroimaging preprocessing pipelines. Most of the images I worked with were stored remotely, and it was fairly infeasible to look at them interactively. I wrote (a prototype) of this package in order to generate quick snapshots of various steps of the pipeline. For example, I would check the overlap of an automatically generated brain mask against the brain. Or look at the alignment of two registered images.
So, if you want to quickly generate a picture that shows a lot of the brain, maybe this will be helpful.
## Installation
Nifti Overlay can be installed from PyPI:
```bash
pip install nifti_overlay
```
See the [releases page](https://github.com/earnestt1234/nifti_overlay/releases) for information about the most current release.
## Documentation
Check out the documentation: [https://nifti-overlay.readthedocs.io/en/latest/](https://nifti-overlay.readthedocs.io/en/latest/).
## License
Open source under [MIT](https://github.com/earnestt1234/nifti_overlay/blob/main/LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/earnestt1234/nifti_overlay",
"name": "nifti-overlay",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Tom Earnest",
"author_email": "Tom Earnest <earnestt1234@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/19/e4/13414612be1bceeae3dc3a4e319243b7d010305a45ccdbc78d868c1860d7/nifti_overlay-0.0.1.tar.gz",
"platform": null,
"description": "# Nifti Overlay\n\nNifti Overlay is a Python program for creating visualizations of 3D volumetric neuorimaging data. It specifically creates tiled images of one or more images overlaid on top of one of another.\n\nHere is an example output image, showing a registered PET image on top of a T1-weighted MRI:\n\n \n\n## Why use this package?\n\n[I](https://github.com/earnestt1234/) wrote this package to help with quality control for neuroimaging preprocessing pipelines. Most of the images I worked with were stored remotely, and it was fairly infeasible to look at them interactively. I wrote (a prototype) of this package in order to generate quick snapshots of various steps of the pipeline. For example, I would check the overlap of an automatically generated brain mask against the brain. Or look at the alignment of two registered images.\n\nSo, if you want to quickly generate a picture that shows a lot of the brain, maybe this will be helpful.\n\n## Installation\n\nNifti Overlay can be installed from PyPI:\n\n```bash\npip install nifti_overlay\n```\n\nSee the [releases page](https://github.com/earnestt1234/nifti_overlay/releases) for information about the most current release.\n\n## Documentation\n\nCheck out the documentation: [https://nifti-overlay.readthedocs.io/en/latest/](https://nifti-overlay.readthedocs.io/en/latest/).\n\n## License\n\nOpen source under [MIT](https://github.com/earnestt1234/nifti_overlay/blob/main/LICENSE).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A program for creating tiled images of volumetric neuorimaging data.",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/earnestt1234/nifti_overlay"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f519f1ba29917d25595ee9860b69dd80770e69ba6bd31cea46f941de1ce40b38",
"md5": "8c4bffec36db2539d7b2337538006990",
"sha256": "5c63229be60eee1ca9917d8be91b0022607a806dda84a245cf43aaaf9285a222"
},
"downloads": -1,
"filename": "nifti_overlay-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8c4bffec36db2539d7b2337538006990",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 20229,
"upload_time": "2025-01-10T03:26:33",
"upload_time_iso_8601": "2025-01-10T03:26:33.604602Z",
"url": "https://files.pythonhosted.org/packages/f5/19/f1ba29917d25595ee9860b69dd80770e69ba6bd31cea46f941de1ce40b38/nifti_overlay-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "19e413414612be1bceeae3dc3a4e319243b7d010305a45ccdbc78d868c1860d7",
"md5": "065e75622e5273ad87507c3bd64fdcd3",
"sha256": "3f6e8f4fc6442e84ec31c83824abe92fe28206343e57b038a11ee4de0bf65b91"
},
"downloads": -1,
"filename": "nifti_overlay-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "065e75622e5273ad87507c3bd64fdcd3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 21578,
"upload_time": "2025-01-10T03:26:35",
"upload_time_iso_8601": "2025-01-10T03:26:35.958862Z",
"url": "https://files.pythonhosted.org/packages/19/e4/13414612be1bceeae3dc3a4e319243b7d010305a45ccdbc78d868c1860d7/nifti_overlay-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-10 03:26:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "earnestt1234",
"github_project": "nifti_overlay",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "matplotlib",
"specs": [
[
">=",
"3.2"
]
]
},
{
"name": "nibabel",
"specs": [
[
">=",
"3.2"
]
]
},
{
"name": "numpy",
"specs": [
[
">=",
"1.2"
]
]
},
{
"name": "scikit-image",
"specs": [
[
">=",
"0.24.0"
]
]
}
],
"lcname": "nifti-overlay"
}
JSON
