| Name | pylibCZIrw JSON |
| Version |
4.0.0
JSON |
| download |
| home_page | |
| Summary | A python wrapper around the libCZI C++ library with reading and writing functionality. |
| upload_time | 2023-12-04 17:51:57 |
| maintainer | |
| docs_url | None |
| author | Felix Scheffler |
| requires_python | >=3.7,<3.12 |
| license | |
| keywords |
czi
imaging
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pylibCZIrw - Python wrapper for libCZI
This project provides a simple and easy-to-use Python wrapper for [libCZI](https://github.com/ZEISS/libczi) - a cross-platform C++ library intended for providing read and write access to CZI image documents.
## Important Remarks
* At the moment, **pylibCZIrw** completely abstracts away the subblock concept, both in the reading and in the writing APIs.
* The core concept of pylibCZIrw is focussing on reading and writing 2D image planes by specifying the dimension indices and its location in order to only read or write **what is really needed**.
* It allows reading data via http/https-protocol enabling cloud storage scenarios.
## Example Usage
```python
from pylibCZIrw import czi as pyczi
filepath = "myimagefile.czi"
# open the CZI document to read the
with pyczi.open_czi(filepath) as czidoc:
# get the image dimensions as a dictionary, where the key identifies the dimension
total_bounding_box = czidoc.total_bounding_box
# get the total bounding box for all scenes
total_bounding_rectangle = czidoc.total_bounding_rectangle
# get the bounding boxes for each individual scene
scenes_bounding_rectangle = czidoc.scenes_bounding_rectangle
# read a 2D image plane and optionally specify planes, zoom levels and ROIs
image2d = czidoc.read(plane={"T": 1, "Z": 2, "C": 0}, zoom=1.0, roi=(0, 0, 50, 100))
```
The detailed usage can be inferred from this sample notebook:
[](https://colab.research.google.com/github/zeiss-microscopy/OAD/blob/master/jupyter_notebooks/pylibCZIrw/pylibCZIrw_4_0_0.ipynb)
For more detailed information refer to the pylibCZIrw-documentation.html shipped with the source distribution of this package (see the **Download files** section).
## Installation
In case there is no wheel available for your system configuration, you can:
- try to install from the provided source distribution
**For Windows**:
- try to [keep paths short on systems with maximum path lengths](https://github.com/pypa/pip/issues/3055)
- make [Win10 accept file paths over 260 characters](https://www.howtogeek.com/266621/how-to-make-windows-10-accept-file-paths-over-260-characters/)
- reach out to the maintainers of this project to add more wheels
## Disclaimer
The library and the notebook are free to use for everybody. Carl Zeiss Microscopy GmbH undertakes no warranty concerning the use of those tools. Use them at your own risk.
**By using any of those examples you agree to this disclaimer.**
Version: 2023.11.20
Copyright (c) 2023 Carl Zeiss AG, Germany. All Rights Reserved.
Raw data
{
"_id": null,
"home_page": "",
"name": "pylibCZIrw",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<3.12",
"maintainer_email": "",
"keywords": "czi,imaging",
"author": "Felix Scheffler",
"author_email": "felix.scheffler@zeiss.com",
"download_url": "https://files.pythonhosted.org/packages/71/d1/be5cca224f3b88c13b50b129d5988ec04aad3c04a805d8601560a1a39587/pylibCZIrw-4.0.0.tar.gz",
"platform": null,
"description": "# pylibCZIrw - Python wrapper for libCZI\n\nThis project provides a simple and easy-to-use Python wrapper for [libCZI](https://github.com/ZEISS/libczi) - a cross-platform C++ library intended for providing read and write access to CZI image documents.\n\n## Important Remarks\n\n* At the moment, **pylibCZIrw** completely abstracts away the subblock concept, both in the reading and in the writing APIs.\n* The core concept of pylibCZIrw is focussing on reading and writing 2D image planes by specifying the dimension indices and its location in order to only read or write **what is really needed**.\n* It allows reading data via http/https-protocol enabling cloud storage scenarios.\n\n## Example Usage\n\n```python\nfrom pylibCZIrw import czi as pyczi\n\nfilepath = \"myimagefile.czi\"\n\n# open the CZI document to read the\nwith pyczi.open_czi(filepath) as czidoc:\n # get the image dimensions as a dictionary, where the key identifies the dimension\n total_bounding_box = czidoc.total_bounding_box\n\n # get the total bounding box for all scenes\n total_bounding_rectangle = czidoc.total_bounding_rectangle\n\n # get the bounding boxes for each individual scene\n scenes_bounding_rectangle = czidoc.scenes_bounding_rectangle\n\n # read a 2D image plane and optionally specify planes, zoom levels and ROIs\n image2d = czidoc.read(plane={\"T\": 1, \"Z\": 2, \"C\": 0}, zoom=1.0, roi=(0, 0, 50, 100))\n```\n\n\nThe detailed usage can be inferred from this sample notebook: \n\n[](https://colab.research.google.com/github/zeiss-microscopy/OAD/blob/master/jupyter_notebooks/pylibCZIrw/pylibCZIrw_4_0_0.ipynb) \n\nFor more detailed information refer to the pylibCZIrw-documentation.html shipped with the source distribution of this package (see the **Download files** section). \n\n## Installation\nIn case there is no wheel available for your system configuration, you can: \n- try to install from the provided source distribution \n **For Windows**:\n - try to [keep paths short on systems with maximum path lengths](https://github.com/pypa/pip/issues/3055)\n - make [Win10 accept file paths over 260 characters](https://www.howtogeek.com/266621/how-to-make-windows-10-accept-file-paths-over-260-characters/)\n- reach out to the maintainers of this project to add more wheels\n\n## Disclaimer\n\nThe library and the notebook are free to use for everybody. Carl Zeiss Microscopy GmbH undertakes no warranty concerning the use of those tools. Use them at your own risk.\n\n**By using any of those examples you agree to this disclaimer.**\n\nVersion: 2023.11.20\n\nCopyright (c) 2023 Carl Zeiss AG, Germany. All Rights Reserved.\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A python wrapper around the libCZI C++ library with reading and writing functionality.",
"version": "4.0.0",
"project_urls": null,
"split_keywords": [
"czi",
"imaging"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e7d807a04a471b06af0a7d0cce982ddfd267bcf77dafa246755f5efdd6ec616b",
"md5": "3e08bd1bc776c34eed5c5c0dee2509d6",
"sha256": "02e306c47d303a27df8572b5a91a204bd8877721ad8ba63712b8a9ce442b9611"
},
"downloads": -1,
"filename": "pylibCZIrw-4.0.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "3e08bd1bc776c34eed5c5c0dee2509d6",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.7,<3.12",
"size": 4131068,
"upload_time": "2023-12-04T17:51:34",
"upload_time_iso_8601": "2023-12-04T17:51:34.291060Z",
"url": "https://files.pythonhosted.org/packages/e7/d8/07a04a471b06af0a7d0cce982ddfd267bcf77dafa246755f5efdd6ec616b/pylibCZIrw-4.0.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7beda9bdfe80b45753f405a455e537daf600dab0267f72c844898cb94e155e2c",
"md5": "9ceb22c04c64a0f85ee1f885ae3e71dc",
"sha256": "f52af19901a23654dc98162139925c6e99b12cbab4bdec0227fb4e2d7e87950e"
},
"downloads": -1,
"filename": "pylibCZIrw-4.0.0-cp310-cp310-win_amd64.whl",
"has_sig": false,
"md5_digest": "9ceb22c04c64a0f85ee1f885ae3e71dc",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.7,<3.12",
"size": 1197799,
"upload_time": "2023-12-04T17:51:37",
"upload_time_iso_8601": "2023-12-04T17:51:37.135933Z",
"url": "https://files.pythonhosted.org/packages/7b/ed/a9bdfe80b45753f405a455e537daf600dab0267f72c844898cb94e155e2c/pylibCZIrw-4.0.0-cp310-cp310-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6964ca476c254fb3f2349123d350428084dd510bbe5ae6ecb415073d8f829b6d",
"md5": "740b3631845f52a5183deb06b18fba42",
"sha256": "d35a326987a1af7217355b9b8413ef94530ca5af1cfb2bc5f1be4c5a5753ce74"
},
"downloads": -1,
"filename": "pylibCZIrw-4.0.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "740b3631845f52a5183deb06b18fba42",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.7,<3.12",
"size": 4132666,
"upload_time": "2023-12-04T17:51:40",
"upload_time_iso_8601": "2023-12-04T17:51:40.097952Z",
"url": "https://files.pythonhosted.org/packages/69/64/ca476c254fb3f2349123d350428084dd510bbe5ae6ecb415073d8f829b6d/pylibCZIrw-4.0.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dd4e849c846e05086e38384b9099bac41aa933b413bebc63a0ce8ed96b21c583",
"md5": "ea0304407300897b3a3eb60b3209fee9",
"sha256": "59d5ea9bb1e50feb61c9546c42b4478b6194c2f6d41975fd904ca5eb3da9efea"
},
"downloads": -1,
"filename": "pylibCZIrw-4.0.0-cp311-cp311-win_amd64.whl",
"has_sig": false,
"md5_digest": "ea0304407300897b3a3eb60b3209fee9",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.7,<3.12",
"size": 1198353,
"upload_time": "2023-12-04T17:51:42",
"upload_time_iso_8601": "2023-12-04T17:51:42.402003Z",
"url": "https://files.pythonhosted.org/packages/dd/4e/849c846e05086e38384b9099bac41aa933b413bebc63a0ce8ed96b21c583/pylibCZIrw-4.0.0-cp311-cp311-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ec24016e2e6a105cbb2b5dd89b00ad040ad14bc22564753e686bb785ce115d27",
"md5": "fbfc923b45d7471dd32476dd3905208e",
"sha256": "0a6143bb2c997c94f23f52b5a5ac635301bc346717b63b97113a461b7f78f036"
},
"downloads": -1,
"filename": "pylibCZIrw-4.0.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "fbfc923b45d7471dd32476dd3905208e",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3.7,<3.12",
"size": 4133552,
"upload_time": "2023-12-04T17:51:44",
"upload_time_iso_8601": "2023-12-04T17:51:44.809113Z",
"url": "https://files.pythonhosted.org/packages/ec/24/016e2e6a105cbb2b5dd89b00ad040ad14bc22564753e686bb785ce115d27/pylibCZIrw-4.0.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8e8e3c12f2459ba1b8b6a81fce85375f0e324861c7481e265a781639738c81d8",
"md5": "edb83fcfb3eb932e34413ca73064350b",
"sha256": "630093527e50963c27207fb75db51821b12f643cdd1c39c6126a0546fbb342de"
},
"downloads": -1,
"filename": "pylibCZIrw-4.0.0-cp37-cp37m-win_amd64.whl",
"has_sig": false,
"md5_digest": "edb83fcfb3eb932e34413ca73064350b",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3.7,<3.12",
"size": 1198690,
"upload_time": "2023-12-04T17:51:47",
"upload_time_iso_8601": "2023-12-04T17:51:47.475149Z",
"url": "https://files.pythonhosted.org/packages/8e/8e/3c12f2459ba1b8b6a81fce85375f0e324861c7481e265a781639738c81d8/pylibCZIrw-4.0.0-cp37-cp37m-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0b2cb619519c8c8708eb1e3e12b352d7aff4e0558b72514802e36bfb3fb5d24f",
"md5": "59f32c004ef0fad65e09fc87d9a31f98",
"sha256": "5e87311242c74f84f821092e2b33c252d20493383192f8fd1ca37129c5beb582"
},
"downloads": -1,
"filename": "pylibCZIrw-4.0.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "59f32c004ef0fad65e09fc87d9a31f98",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.7,<3.12",
"size": 4130847,
"upload_time": "2023-12-04T17:51:49",
"upload_time_iso_8601": "2023-12-04T17:51:49.775463Z",
"url": "https://files.pythonhosted.org/packages/0b/2c/b619519c8c8708eb1e3e12b352d7aff4e0558b72514802e36bfb3fb5d24f/pylibCZIrw-4.0.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8170e0685ae87b127f1d1399721f15a39b94b0e11a4fce4b1667535b71aad967",
"md5": "0246734677ebe533aa2002ffceacae8c",
"sha256": "a7f602ac7a141e83c178343919565b9bba4aa54fa32cafec8a0abe366dd72dbf"
},
"downloads": -1,
"filename": "pylibCZIrw-4.0.0-cp38-cp38-win_amd64.whl",
"has_sig": false,
"md5_digest": "0246734677ebe533aa2002ffceacae8c",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.7,<3.12",
"size": 1198219,
"upload_time": "2023-12-04T17:51:52",
"upload_time_iso_8601": "2023-12-04T17:51:52.087461Z",
"url": "https://files.pythonhosted.org/packages/81/70/e0685ae87b127f1d1399721f15a39b94b0e11a4fce4b1667535b71aad967/pylibCZIrw-4.0.0-cp38-cp38-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "83a67de265413964dfb18f90dda5099bfe6dd4aa046d9fa55965c9a1d8690d82",
"md5": "f7737b7a781ea6698079b8c81259a798",
"sha256": "91975dbd57575fa779bbcc60629a51e2fc52d55a0fb5e9003b6cfc5a4112bbb1"
},
"downloads": -1,
"filename": "pylibCZIrw-4.0.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "f7737b7a781ea6698079b8c81259a798",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.7,<3.12",
"size": 4131310,
"upload_time": "2023-12-04T17:51:53",
"upload_time_iso_8601": "2023-12-04T17:51:53.708690Z",
"url": "https://files.pythonhosted.org/packages/83/a6/7de265413964dfb18f90dda5099bfe6dd4aa046d9fa55965c9a1d8690d82/pylibCZIrw-4.0.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "62357037a3696210f0d59ec78c4d27a220bfdc5c4eadaebb4eab1c2abe202374",
"md5": "d54a5a47b111c825e5d688fcef2a1d9e",
"sha256": "f5e1b4f4e7966e325801e2f82b841e1f28e8af5a9b77afe2e129133e57048230"
},
"downloads": -1,
"filename": "pylibCZIrw-4.0.0-cp39-cp39-win_amd64.whl",
"has_sig": false,
"md5_digest": "d54a5a47b111c825e5d688fcef2a1d9e",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.7,<3.12",
"size": 1195267,
"upload_time": "2023-12-04T17:51:55",
"upload_time_iso_8601": "2023-12-04T17:51:55.911224Z",
"url": "https://files.pythonhosted.org/packages/62/35/7037a3696210f0d59ec78c4d27a220bfdc5c4eadaebb4eab1c2abe202374/pylibCZIrw-4.0.0-cp39-cp39-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "71d1be5cca224f3b88c13b50b129d5988ec04aad3c04a805d8601560a1a39587",
"md5": "15c9d1819df155c811884c2672519d76",
"sha256": "b5301e8c22e1d2aa2446b8697da7728e46aaa62e695c146d5238e94a5ed98531"
},
"downloads": -1,
"filename": "pylibCZIrw-4.0.0.tar.gz",
"has_sig": false,
"md5_digest": "15c9d1819df155c811884c2672519d76",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<3.12",
"size": 5375318,
"upload_time": "2023-12-04T17:51:57",
"upload_time_iso_8601": "2023-12-04T17:51:57.508736Z",
"url": "https://files.pythonhosted.org/packages/71/d1/be5cca224f3b88c13b50b129d5988ec04aad3c04a805d8601560a1a39587/pylibCZIrw-4.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-04 17:51:57",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pylibczirw"
}
