Welcome to ximage

The ximage is still in development. Feel free to try it out and to report issues or to suggest changes.

Quick start

ximage provides an easy-to-use interface to manipulate image, videos and n-dimensional arrays with classical image processing techniques.

Look at the Tutorials to have an overview of the software !

Installation

pip

ximage can be installed via pip on Linux, Mac, and Windows. On Windows you can install WinPython to get Python and pip running. Then, install the ximage package by typing the following command in the command terminal:

pip install ximage

To install the latest development version via pip, see the [documentation][doc_install_link].

conda [NOT YET AVAILABLE]

ximage can be installed via conda on Linux, Mac, and Windows. Install the package by typing the following command in a command terminal:

conda install ximage

In case conda forge is not set up for your system yet, see the easy to follow instructions on conda forge.

Documentation for ximage

You can find the documentation under [ximage.readthedocs.io][doc_link]

Tutorials and Examples

The documentation also includes some tutorials, showing the most important use cases of ximage. These tutorial are also available as Jupyter Notebooks and in Google Colab:

• 1. Introduction to image labeling [Notebook][Colab]
• 2. Introduction to label patch extraction [Notebook][Colab]
• 3. Introduction to image patch extraction [Notebook][Colab]

Citation

If you are using ximage in your publication please cite our paper:

TODO: GMD

You can cite the Zenodo code publication of ximage by:

Ghiggi Gionata & XXXX . 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.

Requirements:

• xarray
• dask
• dask_image
• skimage

License

The content of this repository is released under the terms of the MIT license.