Skip to content

Commit e42b54c

Browse files
authored
Merge pull request #424 from gletort/patch-2
Enhance Cellpose-Appose plugin documentation
2 parents c7f57df + acc813f commit e42b54c

1 file changed

Lines changed: 32 additions & 13 deletions

File tree

_pages/plugins/cellpose-appose.md

Lines changed: 32 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
---
22
title: Cellpose-Appose
33
description: PLugin to use Cellpose from Fiji relying on Appose.
4+
source-url: https://github.com/Image-Analysis-Hub/cellpose-appose
45
artifact: fiji.plugin:Cellpose_Appose
56
categories: [Segmentation]
7+
forum-tag: fiji, cellpose
68
---
79

8-
9-
This is a plugin to install and run [cellpose](https://www.cellpose.org/) on 2D/3D in Fiji.
10+
This plugin install and run [cellpose](https://www.cellpose.org/) on 2D/3D in Fiji.
1011
Two version of cellpose is available:
11-
- Cellpose (v3)
12-
- Cellpose-SAM (v4)
12+
- Cellpose (v3, [doi:10.1038/s41592-025-02595-5](https://www.nature.com/articles/s41592-025-02595-5))
13+
- Cellpose-SAM (v4, [doi:10.1101/2025.04.28.651001](https://www.biorxiv.org/content/10.1101/2025.04.28.651001v1))
1314

1415
This plugin is based on [Appose](https://github.com/apposed/appose), that automatically install python environment and allows python script execution with shared objects with Fiji.
1516

@@ -30,21 +31,39 @@ Press `Apply changes` and restart Fiji when it's done.
3031
From Fiji
3132
- Open the image that you want to process.
3233
- Launch one of the cellpose version available in the plugin:
33-
- `Plugins>Segmentation>Cellpose-Appose>Cellpose...` _see [here](#cellpose) for documentation_
34-
- `Plugins>Segmentation>Cellpose-Appose>Cellpose-SAM...` _see [here](#cellpose-sam) for documentation_
35-
- Configure your Cellpose run through the Graphic Interface
34+
- `Plugins>Segmentation>Cellpose-Appose>Cellpose...`
35+
This option allows to run CellPose v3.
36+
The full official Cellpose 3 documentation is available [here](https://cellpose.readthedocs.io/en/v3.1.1.1/).
37+
- `Plugins>Segmentation>Cellpose-Appose>Cellpose-SAM...`
38+
This option allows to run CellPose v4 with SAM.
39+
The full official Cellpose 4 documentation is available [here](https://cellpose.readthedocs.io/en/latest/).
40+
- Configure your Cellpose run through the Graphic Interface. _see [here](#parameters) for documentation_
3641
- Press "Ok" and Enjoy!
3742

3843
> [!NOTE]
39-
> The python environment will be automatically installed in your home `.local\shared\appose` directory and activated from the plugin when needed.
44+
> The first time you run each option of this plugin, a python environment with the requested Cellpose version will be automatically installed in your home `.local\shared\appose` directory, which will take some time. The next time you use the same option, the environment will be directly activated from the plugin when needed so it will be much faster.
45+
46+
>[!NOTE]
47+
>Cellpose-SAM relies on a much bigger neural network than Cellpose3. Thus computation with this version takes longer and it is advised to have a GPU available.
48+
49+
## Parameters
50+
51+
After you selected a version of Cellpose, a graphical interface will pop-up to let you choose the parameters to run cellpose. See the Cellpose [documentation](https://cellpose.readthedocs.io/en/latest/) for full description of the parameters.
52+
53+
## Cellpose parameters
4054

55+
- `Cellpose model` (**Cellpose v3 only**): Select a pretrained model from Cellpose website. These models have been trained on dataset with specific biological objects, as for example nuclei for `nuclei` model. Select the model that corresponds the best to your data.
56+
57+
- `Path to custom model`: if you have fine-tuned or trained your own cellpose model, write here the full path to the directory containing the model files.
58+
59+
- `Diameter`: The prediction is sensitive to the size of the objects to detect, so you need to indicate the average diameter of the objects (cell or nuclei), in pixels. This parameter strongly affects the segmentation results for Cellpose v3, while Cellpose-SAM can handle a much bigger range of object sizes. Cellpose will resize your image(s) to have an average object size compatible to the one of the training data (30 pixels for most models), and resize back the results to your initial image size. _Default value is 30 pixel_.
4160

42-
## Cellpose
61+
- `Channel selection`: Choose the color channel on the image to do the segmentation on (that contain the staining of your objects).
62+
- For **Cellpose 3**: you can select one or two channels, one for the main object to segment (`Cytoplasmic channel`) and an optional one for the nuclei staining (`Nuclei chanel`). When you have both stainings, selecting also the nuclei channel can help the segmentation of the contour of the cell by giving more information.
63+
- For **Cellpose-SAM**: Cellpose-SAM can use information from up to 3 channels to segment the objects. So select the number of channels that are relevant to segment your objects of interest.
64+
65+
- `Minimum Object Size`: At the end of the segmentation process, objects that are smaller in size (total area in pixel) from this parameter will be removed. This allows to get rid off small errors segmentation of only a few pixel. _Default value is 15 pixels^2_.
4366

44-
The option `Plugins>Segmentation>Cellpose-Appose>Cellpose...` allows to run CellPose v3.
4567

46-
## Cellpose-SAM
4768

48-
The option `Plugins>Segmentation>Cellpose-Appose>Cellpose-SAM...` allows to run CellPose v4 with SAM.
4969

50-
### Cuda selection

0 commit comments

Comments
 (0)