| Name | ximage JSON |
| Version |
0.0.4
JSON |
| download |
| home_page | None |
| Summary | xarray-based tools for image/video processing |
| upload_time | 2024-04-02 16:31:07 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2023 Gionata Ghiggi Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
image
video
labelling
patch
extraction
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# đĻ Welcome to ximage
| | |
| -------------------- | ---------------------------------------------- |
| Deployment | [](https://pypi.org/project/ximage/) [](https://anaconda.org/conda-forge/ximage) |
| Activity | [](https://pypi.org/project/ximage/) [](https://anaconda.org/conda-forge/ximage) |
| Python Versions | [](https://www.python.org/downloads/) |
| Supported Systems | [](https://github.com/ghiggi/ximage/actions/workflows/tests.yml) [](https://github.com/ghiggi/ximage/actions/workflows/tests.yml) [](https://github.com/ghiggi/ximage/actions/workflows/tests_windows.yml) |
| Project Status | [](https://www.repostatus.org/#active) |
| Build Status | [](https://github.com/ghiggi/ximage/actions/workflows/tests.yml) [](https://github.com/ghiggi/ximage/actions/workflows/lint.yml) [](https://ximage.readthedocs.io/en/latest/) |
| Linting | [](https://github.com/psf/black) [](https://github.com/astral-sh/ruff) [](https://github.com/codespell-project/codespell) |
| Code Coverage | [](https://coveralls.io/github/ghiggi/ximage?branch=main) [](https://codecov.io/gh/ghiggi/ximage) |
| Code Quality | [](https://www.codefactor.io/repository/github/ghiggi/ximage) [](https://codebeat.co/projects/github-com-ghiggi-ximage-main) [](https://app.codacy.com/gh/ghiggi/ximage/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [](https://codescene.io/projects/41869) |
| License | [](https://github.com/ghiggi/ximage/blob/main/LICENSE) |
| Community | [](https://join.slack.com/t/xarray-tools/shared_invite/zt-28f5r0n75-ygNZN5omemhz72NM~WKUHA) [](https://github.com/ghiggi/ximage/discussions) |
| Citation | [](https://zenodo.org/records/8131553) |
[**Slack**](https://join.slack.com/t/xarray-tools/shared_invite/zt-28f5r0n75-ygNZN5omemhz72NM~WKUHA) | [**Docs**](https://x-image.readthedocs.io/en/latest/)
## âšī¸ Software Overview
The software currently enables to:
- label n-dimensional xarray objects
- extract patches around n-dimensional labels
- extract patches from n-dimensional xarray objects
Join the [**Slack Workspace**](https://join.slack.com/t/xarray-tools/shared_invite/zt-28f5r0n75-ygNZN5omemhz72NM~WKUHA) to meet the community !
## đ Quick Start
`ximage` provides an easy-to-use interface to manipulate image, videos and n-dimensional arrays with classical image processing techniques.
The `ximage` xarray accessor provides a convenient way to labelling and extract patches in n-dimensional arrays !
##### Image labelling
```python
min_value_threshold = 1
max_value_threshold = np.inf
min_area_threshold = 5
max_area_threshold = np.inf
footprint = None
sort_by = "area"
sort_decreasing = True
label_name = "label"
### Label xarray object
xr_obj = da.ximage.label(
min_value_threshold=min_value_threshold,
max_value_threshold=max_value_threshold,
min_area_threshold=min_area_threshold,
max_area_threshold=max_area_threshold,
footprint=footprint,
sort_by=sort_by,
sort_decreasing=sort_decreasing,
label_name=label_name,
)
```
##### Extract patches around labels
```python
# Output Options
n_patches = 10
n_labels = None
labels_id = None
highlight_label_id = False
# Patch Extraction Options
patch_size = (100, 100)
centered_on = "label_bbox"
padding = 0
n_patches_per_label = np.Inf
n_patches_per_partition = 1
# Tiling/Sliding Options
partitioning_method = None # "tiling" / "sliding"
n_partitions_per_label = None
kernel_size = None
buffer = 0
stride = None
include_last = True
ensure_slice_size = True
debug = True
verbose = True
da_patch_gen = xr_obj.ximage.label_patches(
label_name=label_name,
patch_size=patch_size,
variable=variable,
# Output Options
n_patches=n_patches,
n_labels=n_labels,
labels_id=labels_id,
highlight_label_id=highlight_label_id,
# Patch Extraction Options
centered_on=centered_on,
padding=padding,
n_patches_per_label=n_patches_per_label,
n_patches_per_partition=n_patches_per_partition,
# Tiling/Sliding Options
partitioning_method=partitioning_method,
n_partitions_per_label=n_partitions_per_label,
kernel_size=kernel_size,
buffer=buffer,
stride=stride,
include_last=include_last,
ensure_slice_size=ensure_slice_size,
debug=debug,
verbose=verbose,
)
```
#### đ Explore the ximage documentation
To discover all `ximage` utilities, please read the [software documentation](https://x-image.readthedocs.io/en/latest/).
## đ ī¸ Installation
### conda
ximage can be installed via [conda][conda_link] on Linux, Mac, and Windows.
Install the package by typing the following command in the terminal:
```bash
conda install ximage
```
In case conda-forge is not set up for your system yet, see the easy to follow instructions on [conda-forge][conda_forge_link].
[conda_link]: https://docs.conda.io/en/latest/miniconda.html
[conda_forge_link]: https://github.com/conda-forge/ximage-feedstock#installing-ximage
### pip
`ximage` can be installed also via [pip][pip_link] on Linux, Mac, and Windows.
On Windows you can install [WinPython][winpy_link] to get Python and pip running.
Install the `ximage` package by typing the following command in the terminal:
```bash
pip install ximage
```
To install the latest development version via pip, see the [documentation][dev_install_link].
[pip_link]: https://pypi.org/project/gpm-api
[winpy_link]: https://winpython.github.io/
[dev_install_link]: https://gpm-api.readthedocs.io/en/latest/02_installation.html#installation-for-contributors
## đ Feedback and Contributing Guidelines
If you aim to contribute or discuss the future development of ximage,
we highly suggest to join the [**Slack Workspace**](https://join.slack.com/t/xarray-tools/shared_invite/zt-28f5r0n75-ygNZN5omemhz72NM~WKUHA)
Feel free to also open a [GitHub Issue](https://github.com/ghiggi/ximage/issues) or a
[GitHub Discussion](https://github.com/ghiggi/ximage/discussions) specific to your questions or ideas.
## âī¸ Contributors
* [Gionata Ghiggi](https://people.epfl.ch/gionata.ghiggi)
* [Son Pham-Ba](https://people.epfl.ch/son.phamba?lang=en)
## Citation
You can cite the `ximage` software by:
> Ghiggi Gionata & Son Pham-Ba . ghiggi/ximage. Zenodo. https://doi.org/10.5281/zenodo.8131552
If you want to cite a specific version, have a look at the [Zenodo site](https://doi.org/10.5281/zenodo.8131552).
## License
The content of this repository is released under the terms of the [MIT](LICENSE) license.
## đ Requirements:
- [xarray](https://docs.xarray.dev/en/stable/)
- [dask](https://www.dask.org/)
- [dask_image](https://image.dask.org/en/latest/)
- [skimage](https://scikit-image.org/)
Raw data
{
"_id": null,
"home_page": null,
"name": "ximage",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "image, video, labelling, patch, extraction",
"author": null,
"author_email": "Gionata Ghiggi <gionata.ghiggi@epfl.ch>",
"download_url": "https://files.pythonhosted.org/packages/11/2e/4f1a0d172afdb3fe62a3304e88bb7ac65d0ddf15700dc906fef239dcaf65/ximage-0.0.4.tar.gz",
"platform": null,
"description": "# \ud83d\udce6 Welcome to ximage\n\n| | |\n| -------------------- | ---------------------------------------------- |\n| Deployment | [](https://pypi.org/project/ximage/) [](https://anaconda.org/conda-forge/ximage) |\n| Activity | [](https://pypi.org/project/ximage/) [](https://anaconda.org/conda-forge/ximage) |\n| Python Versions | [](https://www.python.org/downloads/) |\n| Supported Systems | [](https://github.com/ghiggi/ximage/actions/workflows/tests.yml) [](https://github.com/ghiggi/ximage/actions/workflows/tests.yml) [](https://github.com/ghiggi/ximage/actions/workflows/tests_windows.yml) |\n| Project Status | [](https://www.repostatus.org/#active) |\n| Build Status | [](https://github.com/ghiggi/ximage/actions/workflows/tests.yml) [](https://github.com/ghiggi/ximage/actions/workflows/lint.yml) [](https://ximage.readthedocs.io/en/latest/) |\n| Linting | [](https://github.com/psf/black) [](https://github.com/astral-sh/ruff) [](https://github.com/codespell-project/codespell) |\n| Code Coverage | [](https://coveralls.io/github/ghiggi/ximage?branch=main) [](https://codecov.io/gh/ghiggi/ximage) |\n| Code Quality | [](https://www.codefactor.io/repository/github/ghiggi/ximage) [](https://codebeat.co/projects/github-com-ghiggi-ximage-main) [](https://app.codacy.com/gh/ghiggi/ximage/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [](https://codescene.io/projects/41869) |\n| License | [](https://github.com/ghiggi/ximage/blob/main/LICENSE) |\n| Community | [](https://join.slack.com/t/xarray-tools/shared_invite/zt-28f5r0n75-ygNZN5omemhz72NM~WKUHA) [](https://github.com/ghiggi/ximage/discussions) |\n| Citation | [](https://zenodo.org/records/8131553) |\n\n [**Slack**](https://join.slack.com/t/xarray-tools/shared_invite/zt-28f5r0n75-ygNZN5omemhz72NM~WKUHA) | [**Docs**](https://x-image.readthedocs.io/en/latest/)\n\n\n## \u2139\ufe0f Software Overview\n\nThe software currently enables to:\n\n- label n-dimensional xarray objects\n- extract patches around n-dimensional labels\n- extract patches from n-dimensional xarray objects\n\nJoin the [**Slack Workspace**](https://join.slack.com/t/xarray-tools/shared_invite/zt-28f5r0n75-ygNZN5omemhz72NM~WKUHA) to meet the community !\n\n## \ud83d\ude80 Quick Start\n\n`ximage` provides an easy-to-use interface to manipulate image, videos and n-dimensional arrays with classical image processing techniques.\n\nThe `ximage` xarray accessor provides a convenient way to labelling and extract patches in n-dimensional arrays !\n\n##### Image labelling\n\n```python\nmin_value_threshold = 1\nmax_value_threshold = np.inf\nmin_area_threshold = 5\nmax_area_threshold = np.inf\nfootprint = None\nsort_by = \"area\"\nsort_decreasing = True\nlabel_name = \"label\"\n\n### Label xarray object\nxr_obj = da.ximage.label(\n min_value_threshold=min_value_threshold,\n max_value_threshold=max_value_threshold,\n min_area_threshold=min_area_threshold,\n max_area_threshold=max_area_threshold,\n footprint=footprint,\n sort_by=sort_by,\n sort_decreasing=sort_decreasing,\n label_name=label_name,\n)\n```\n\n##### Extract patches around labels\n\n```python\n# Output Options\nn_patches = 10\nn_labels = None\nlabels_id = None\nhighlight_label_id = False\n# Patch Extraction Options\npatch_size = (100, 100)\ncentered_on = \"label_bbox\"\npadding = 0\nn_patches_per_label = np.Inf\nn_patches_per_partition = 1\n# Tiling/Sliding Options\npartitioning_method = None # \"tiling\" / \"sliding\"\nn_partitions_per_label = None\nkernel_size = None\nbuffer = 0\nstride = None\ninclude_last = True\nensure_slice_size = True\ndebug = True\nverbose = True\n\nda_patch_gen = xr_obj.ximage.label_patches(\n label_name=label_name,\n patch_size=patch_size,\n variable=variable,\n # Output Options\n n_patches=n_patches,\n n_labels=n_labels,\n labels_id=labels_id,\n highlight_label_id=highlight_label_id,\n # Patch Extraction Options\n centered_on=centered_on,\n padding=padding,\n n_patches_per_label=n_patches_per_label,\n n_patches_per_partition=n_patches_per_partition,\n # Tiling/Sliding Options\n partitioning_method=partitioning_method,\n n_partitions_per_label=n_partitions_per_label,\n kernel_size=kernel_size,\n buffer=buffer,\n stride=stride,\n include_last=include_last,\n ensure_slice_size=ensure_slice_size,\n debug=debug,\n verbose=verbose,\n)\n\n```\n\n#### \ud83d\udcd6 Explore the ximage documentation\n\nTo discover all `ximage` utilities, please read the [software documentation](https://x-image.readthedocs.io/en/latest/).\n\n## \ud83d\udee0\ufe0f Installation\n\n### conda\n\nximage can be installed via [conda][conda_link] on Linux, Mac, and Windows.\nInstall the package by typing the following command in the terminal:\n\n```bash\nconda install ximage\n```\n\nIn case conda-forge is not set up for your system yet, see the easy to follow instructions on [conda-forge][conda_forge_link].\n\n[conda_link]: https://docs.conda.io/en/latest/miniconda.html\n[conda_forge_link]: https://github.com/conda-forge/ximage-feedstock#installing-ximage\n\n### pip\n\n`ximage` can be installed also via [pip][pip_link] on Linux, Mac, and Windows.\nOn Windows you can install [WinPython][winpy_link] to get Python and pip running.\n\nInstall the `ximage` package by typing the following command in the terminal:\n\n```bash\npip install ximage\n```\n\nTo install the latest development version via pip, see the [documentation][dev_install_link].\n\n[pip_link]: https://pypi.org/project/gpm-api\n[winpy_link]: https://winpython.github.io/\n[dev_install_link]: https://gpm-api.readthedocs.io/en/latest/02_installation.html#installation-for-contributors\n\n## \ud83d\udcad Feedback and Contributing Guidelines\n\nIf you aim to contribute or discuss the future development of ximage,\nwe highly suggest to join the [**Slack Workspace**](https://join.slack.com/t/xarray-tools/shared_invite/zt-28f5r0n75-ygNZN5omemhz72NM~WKUHA)\n\nFeel free to also open a [GitHub Issue](https://github.com/ghiggi/ximage/issues) or a\n[GitHub Discussion](https://github.com/ghiggi/ximage/discussions) specific to your questions or ideas.\n\n## \u270d\ufe0f Contributors\n\n* [Gionata Ghiggi](https://people.epfl.ch/gionata.ghiggi)\n* [Son Pham-Ba](https://people.epfl.ch/son.phamba?lang=en)\n\n## Citation\n\nYou can cite the `ximage` software by:\n\n> Ghiggi Gionata & Son Pham-Ba . ghiggi/ximage. Zenodo. https://doi.org/10.5281/zenodo.8131552\n\nIf you want to cite a specific version, have a look at the [Zenodo site](https://doi.org/10.5281/zenodo.8131552).\n\n## License\n\nThe content of this repository is released under the terms of the [MIT](LICENSE) license.\n\n## \ud83d\udcda Requirements:\n\n- [xarray](https://docs.xarray.dev/en/stable/)\n- [dask](https://www.dask.org/)\n- [dask_image](https://image.dask.org/en/latest/)\n- [skimage](https://scikit-image.org/)\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Gionata Ghiggi Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "xarray-based tools for image/video processing",
"version": "0.0.4",
"project_urls": {
"changelog": "https://github.com/ghiggi/ximage/blob/main/CHANGELOG.md",
"documentation": "https://ximage.readthedocs.io",
"homepage": "https://github.com/ghiggi/ximage",
"repository": "https://github.com/ghiggi/ximage",
"source": "https://github.com/ghiggi/ximage",
"tracker": "https://github.com/ghiggi/ximage/issues"
},
"split_keywords": [
"image",
" video",
" labelling",
" patch",
" extraction"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "01a6da9ec6b414536105df0d12edcfde7237277208d3700703b42bf8b29986eb",
"md5": "e3f7d0e4e2312fc20300a64d3e15ee61",
"sha256": "50dab48cdeac9ec43352ceed778e2d7a906644b352ce84ddfd8636bef38ba705"
},
"downloads": -1,
"filename": "ximage-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e3f7d0e4e2312fc20300a64d3e15ee61",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 38473,
"upload_time": "2024-04-02T16:31:06",
"upload_time_iso_8601": "2024-04-02T16:31:06.562951Z",
"url": "https://files.pythonhosted.org/packages/01/a6/da9ec6b414536105df0d12edcfde7237277208d3700703b42bf8b29986eb/ximage-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "112e4f1a0d172afdb3fe62a3304e88bb7ac65d0ddf15700dc906fef239dcaf65",
"md5": "ba49cc41fa2a21820696ef6f98a8845f",
"sha256": "fe335670d1a0b6254dc7a4d1ddcbef82dfd55578c9404eaccf5edb2c7a965cb9"
},
"downloads": -1,
"filename": "ximage-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "ba49cc41fa2a21820696ef6f98a8845f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 44092,
"upload_time": "2024-04-02T16:31:07",
"upload_time_iso_8601": "2024-04-02T16:31:07.822658Z",
"url": "https://files.pythonhosted.org/packages/11/2e/4f1a0d172afdb3fe62a3304e88bb7ac65d0ddf15700dc906fef239dcaf65/ximage-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-02 16:31:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ghiggi",
"github_project": "ximage",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "ximage"
}
