ImageGrains <img src="https://github.com/dmair1989/ImageGrains/blob/main/illustrations/logo_2.png?raw=true" width="100" title="logo" alt="logo" align="left">

PyPI - Wheel PyPI - License GitHub code size in bytes

A software library for segmenting and measuring of sedimentary particles in images. The segmentation is done with Cellpose-SAM, designed for cell and nucleus segmentation in biomedical images. Its segmentation capability is transferred to geoscientific applications throurgh re-training of the model with images of sediment particles. Pretrained segmentation models from our data are available or custom models can be trained (see paper for details).

:sparkles: New Release: Version 2.0 :sparkles:

The major update to 2.0 includes:

Switching to Cellpose-SAM (4.0.1+) as default segmentation model, which improves the segmentation accuracy and generalization a lot. For more details, see the paper.
New models trained on a larger dataset (IG2) that includes different types of grains and imagery.
Including 3D segmentation of CT-scan stacks; see Notebook and Schuster et al. (2025).
A graphical user interface (GUI).

Try ImageGrains 2.0 with Cellpose-SAM in Colab with your own data in google drive:
Complete grain size and shape analysis.ipynb

Citation

If you use ImageGrains, please cite:

Mair, D., Witz, G., Do Prado, A., Garefalakis, P., Wild, A., Ville, F., Schuster, B., Horn, M., Österle, J., Fabbri, S. C., Litty, C., Achleitner, S., Leistner, S., Hiller, C., and Schlunegger, F.: ImageGrains 2.0: Improved precision and generalization for grain segmentation, EGUsphere [preprint], https://doi.org/10.5194/egusphere-2025-6346.
Pachitariu, M., Rariden, M., Stringer, C.. Cellpose-SAM: superhuman generalization for cellular segmentation. bioRxiv 2025.04.28.651001; https://doi.org/10.1101/2025.04.28.651001

If you use legacy versions with Cellpose 2 (e.g., by using ImageGrains 1.x or IG1 models), please cite the Cellpose 1.0 paper:

Mair, D., Witz, G., Do Prado, A.H., Garefalakis, P. & Schlunegger, F. (2023) Automated detecting, segmenting and measuring of grains in images of fluvial sediments: The potential for large and precise data from specialist deep learning models and transfer learning. Earth Surface Processes and Landforms, 1–18. https://doi.org/10.1002/esp.5755.
Stringer, C.A., Pachitariu, M., (2021). Cellpose: a generalist algorithm for cellular segmentation. Nat Methods 18, 100–106. https://doi.org/10.1038/s41592-020-01018-x.

If you use ImageGrains to calculate percentile uncertainties please also cite:

Mair, D., Henrique, A., Prado, D., Garefalakis, P., Lechmann, A., Whittaker, A., and Schlunegger, F. (2022): Grain size of fluvial gravel bars from close-range UAV imagery-uncertainty in segmentation-based data, Earth Surf. Dyn., 10,953-973. https://doi.org/10.5194/esurf-10-953-2022.

Local installation

The easiest way to install the software is by using the conda package manager. If you do not have conda installed, please follow the instructions on the conda website. If you encounter problems during installation, have a look here. If these methods do not solve them, please open an issue.

To install the software, open an anaconda prompt / command prompt, then create a new environment with:

conda create --name imagegrains -c conda-forge python=3.10

and activate it with:

conda activate imagegrains

Then install the package using

pip install imagegrains

:exclamation: Please notet that this will install Cellpose 4.0.1 or newer. The new Cellpose-SAM architecture is not compatible with older models! To use older models, install the last version of ImageGrains 1.x with:

pip install imagegrains==1.2.1

GPU support

By default, Cellpose will run on the CPU if no GPU is available. From version 4.0.1 on, it uses a transformer (Cellpose-SAM) as backbone segmentation model, which is much larger than the previous model. Using a GPU on local machines is strongly recommended.

Mac: Cellpose (version 4.0.1 and later) supports Apple GPUs (M1 and newer) out-of-the-box.

Windows or Linux: To use a GPU, you will have to make sure you have a GPU compatible PyTorch version. For this:

Uninstall the PyTorch version that gets installed by default with Cellpose:
```
 pip uninstall torch
```
Make sure your have up-to-date drivers for your GPU installed.
Re-install a GPU version of PyTorch via conda using a command that you can find here (this takes care of the cuda toolkit, cudnn etc. so no need to install manually anything more than the driver). The command will look like this:
```
 pip3 install torch torchvision --index-url https://download.pytorch.org/whl/cu118  
```

How does it work?

ImageGrains is organised in 3 main modules for Segmentation, Grain size measurements and Grain size distribution (GSD) analysis. There are several ways to use them:

1 - User Interface: The most convienient option is to use the GUI built as napari plugin: https://github.com/guiwitz/napari-imagegrains.

You can simply install it with:

pip install git+https://github.com/dmair1989/napari-imagegrains.git

Afterwards, you can start the program by running:

napari

For instructions, please refer to the docs.

2 - Console: The most basic option is to run ImageGrains from the console by first activating the enviromnent:

conda activate imagegrains

Then download the pretrained models and demo data by executing:

python -m imagegrains --download_data True

To start an analysis from the console run:

python -m imagegrains --img_dir F:/REPLACE_WITH_PATH_TO_FOLDER_OF_IMAGES_(JPEG)

This will run the main application with the default settings on images in the provided location. You can use --help to see all input options.

3 - Notebooks: Alternatively, you can run the jupyter notebooks in /notebooks in their order. They offer more options and information for most workflow steps. Of course, any modules and functions can be combined in custom scripts or notebooks.

Workflow

The main concept of ImageGrains is to first segment grains in images, then to measure and scale them with the respective image resolution before finally estimating the uncertainty on an image base. The whole workflow is designed to use individual images or a set of images in a specific folder. During the processing steps, all intermediate outputs can be stored. Short versions of the entire workflow are available in Complete grain size and shape analysis.ipynb and notebooks/complete_imagegrains_analysis.

Segmentation of own images

For details on how to segment own images with pre-trained models, see the corresponding jupyter notebook notebooks/1_image_segmentation.ipynb. To use it locally, open the console and activate the environment (conda activate imagegrains) and start your jupyter instance (e.g., viajupyter lab). Then, open the notebook and follow the instructions. You can use pre-trained models or train a custom model (see below).

Grain size and shape measurements

For details on how to measure grain sizes, see the jupyter notebook notebooks/2_grain_sizes.ipynb. It will load the segmented grain masks and calculate the grain size and shape for each grain on an image-by-image basis. Several options for outline fitting are available. The grain size is then scaled with the image resolution and stored in an outp

Imagegrains

Install / Use

README