Skip to content

Commit 57e2a59

Browse files
committed
Rework the doc for the spot editor of TrackMate.
True to v8.1.0.
1 parent 4a7e052 commit 57e2a59

20 files changed

+72
-39
lines changed

_pages/plugins/trackmate/tutorials/trackmate-segmentation-editor.md

Lines changed: 72 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ The fact that the initial spot and the new one have the same label plays no role
8282

8383
When you select one of the tool by cliking on its icon or with F1 - F6, the right part of the toolbar changes to show the tool controls.
8484

85-
### The pan tool - {% include key key="F1" %}
85+
### The pan / move tool - {% include key key="F1" %}
8686

8787
See above.
8888
When this tool is selected, the mouse is used to navigate in the image.
@@ -98,67 +98,101 @@ The default key shortcuts to do so are {% include key key="Q" %} / {% include k
9898

9999
The rightmost list allows changing the paint mode.
100100
There are three of them: _Replace, Add, Preserve_.
101+
The selected modes and brush size are remembered between use of the editor.
101102

102-
#### Paint Replace
103+
#### Paint replace
103104

104-
#### Pain Add
105+
This is the default mode.
106+
If you paint over an existing label, it is discarded.
107+
108+
{% include img src="/media/plugins/trackmate/spot-editor/TrackMate-Editor-Paint-Replace.gif" align="center" %}
109+
110+
#### Paint add
105111

106112
In TrackMate the spots can be overlapping, and as a consequence, in the editor you can have several labels on one pixel.
107113
This is the way to edit overlapping spots.
108114
The _Add_ mode paint labels, and if there is an existing label, it will add the selected one, and not remove the existing one:
109115

110-
<iframe width="480" height="270" align="center" src="/media/plugins/trackmate/spot-editor/TrackMate-Editor-Paint-AddMode_halfsize.mp4" allow="autoplay">
116+
{% include img src="/media/plugins/trackmate/spot-editor/TrackMate-Editor-Paint-AddMode.gif" align="center" %}
117+
118+
This will lead to overlapping spots, as demonstrated in the animation above.
111119

120+
#### Paint preserve
112121

113-
#### Paint Preserve
122+
This mode is the converse of the 'Replace' mode.
123+
The selected label will be applied only on the pixels that have no label already.
124+
It will only paint on the background.
125+
This is useful if you have close objects that you know are not overlapping.
126+
127+
{% include img src="/media/plugins/trackmate/spot-editor/TrackMate-Editor-Paint-PreserveMode.gif" align="center" %}
114128

115129

116130
### Deleting pixels - {% include key key="F3" %}
117131

118-
The fourth button on the top bar is the _Delete_ button.
119-
Click it to make the delete brush mode active.
120-
But if you click on the spurious detections, nothing happens.
121-
This is because the **delete brush only works on the pixels of the label that is currently selected in the left side bar**.
122-
You need to select the label you want to edit first.
123-
To do so, you can either
124-
- {% include key key="Shift|left click" %} on the spot mask in the image panel,
125-
- click on the _Select_ button on the top toolbar (the sixth button on the left) then click on the spot in the image,
126-
- or select the label in the left side bar.
132+
The delete tool also has several modes, that are made to harness possibly overlapping labels.
133+
134+
#### Delete all labels
135+
136+
This mode simply remove all labels at once.
137+
You get the background where you paint.
138+
139+
{% include img src="/media/plugins/trackmate/spot-editor/TrackMate-Editor-Delete-AllLabels.gif" align="center" %}
140+
141+
#### Delete selected label
142+
143+
With this mode, the brush will only remove the label currently selected, and no touch the others:
144+
145+
{% include img src="/media/plugins/trackmate/spot-editor/TrackMate-Editor-Delete-SelectedLabel.gif" align="center" %}
127146

128-
{% include notice icon="note"
129-
content="*Shift-click* in the image selects the spot at the cursor position." %}
130147

131-
{% include img src="/media/plugins/trackmate/spot-editor/trackmate-spot-editor-tuto-11.gif" align="center" %}
148+
### Flood fill - {% include key key="F4" %}
132149

133-
Shift-click on each of the spurious detections to select them, and then click on them with the _delete_ brush on to remove them.
134-
Notice that the corresponding labels in the left side bar are not removed, which is normal.
150+
This tool allows for painting over a 'segment' of the labeling.
151+
That is: any connected portion of the labels that have the same labels underneath.
152+
It is most useful to replace a label or add one.
153+
There is also two modes for this tool.
135154

136-
{% include img src="/media/plugins/trackmate/spot-editor/trackmate-spot-editor-tuto-12.gif" align="center" %}
155+
#### Flood fill replace
137156

138-
### Painting spots
157+
Similar to the _Paint add_ tool, this leads to replace all the label of a segment with the selected label.
158+
On the animation below, the red part of the labeling is overwritten with the blue label, leading to a larger spot:
139159

140-
We now want to enlarge the largest spot to cover the nucleus.
141-
First shift-click on it in the image panel to make the spot label active.
142-
Then click on the _Add_ button in the top bar which is the second button from the left.
143-
Edit the brush size to about 5 pixels, and paint over the nucleus.
160+
{% include img src="/media/plugins/trackmate/spot-editor/TrackMate-Editor-FloodFill-Replace.gif" align="center" %}
144161

145-
{% include img src="/media/plugins/trackmate/spot-editor/trackmate-spot-editor-tuto-13.gif" align="center" %}
162+
#### Flood fill add
146163

147-
### Removing entire spots
164+
This _adds_ a label to a segment that might already have one.
165+
On the animation below, the red label is added to the blue segment.
166+
This segment has now two labels, the blue and the red, and it appers in magenta in the editor.
167+
After returning to TrackMate, this leads to two spots overlapping:
148168

149-
You can also remove entire spots from the editor using the _Remove_ mode, which is the third button from the left in the top bar.
150-
Again, the corresponding label of the spot to remove must be selected in the left side bar.
151-
Click on the _Remove_ button, select the label in the left side bar and click on the spot you want to remove.
169+
{% include img src="/media/plugins/trackmate/spot-editor/TrackMate-Editor-FloodFill-Add.gif" align="center" %}
152170

153-
{% include img src="/media/plugins/trackmate/spot-editor/trackmate-spot-editor-tuto-14.gif" align="center" %}
171+
### Flood erase - {% include key key="F5" %}
154172

155-
### Filling holes
173+
This tool removes one or all labels of a segment.
156174

157-
Another way of creating spots is to paint the border and fill the inside.
158-
After drawing the contour of the nucleus, you can use the _Fill_ button, which is the third button from the left in the top bar.
159-
Click it, and click inside the contour to fill it.
175+
#### Flood erase remove all
176+
177+
All the labels are removed from the segment.
178+
The modified pixels are now part of the background.
179+
180+
{% include img src="/media/plugins/trackmate/spot-editor/TrackMate-Editor-FloodErase-RemoveAll.gif" align="center" %}
181+
182+
#### Flood erase selected label
183+
184+
Only the currently selected label is removed.
185+
For instance, on the animation below, the top segment has two labels, red and blue, and appears in magenta.
186+
The flood erase tool is used to remove the blue label from it, which leaves the red label.
187+
188+
{% include img src="/media/plugins/trackmate/spot-editor/TrackMate-Editor-FloodErase-SelectedLabel.gif" align="center" %}
189+
190+
191+
### Select label - {% include key key="F6" %}
192+
193+
Click on any pixel to select its associated label.
194+
If the pixel contains multiple labels, click repeatedly to cycle through them.
160195

161-
{% include img src="/media/plugins/trackmate/spot-editor/trackmate-spot-editor-tuto-15.gif" align="center" %}
162196

163197
### Keyboard shortcuts changing the brush mode and size
164198

@@ -226,8 +260,7 @@ This respects whether you have a ROI in the image or not.
226260

227261
In TrackMate, spots are represented as polygons, as as such they can overlap.
228262
This is also the case in the spot editor.
229-
This is the reason why it is necessary to select the spot you want to edit before using the brush.
230-
263+
See the _Paint add_ mode above for instance.
231264
{% include img src="/media/plugins/trackmate/spot-editor/trackmate-spot-editor-tuto-22.gif" align="center" %}
232265

233266
### Several spots can have the same label
@@ -258,4 +291,4 @@ Has the same effect as clicking the _Close and send to TrackMate_ button.
258291

259292

260293
___
261-
Jean-Yves Tinevez, August 2025
294+
Jean-Yves Tinevez, August - December 2025
211 KB
Loading

media/plugins/trackmate/spot-editor/TrackMate-Editor-Delete-AllLabels_halfsize.mp4

Whitespace-only changes.
226 KB
Loading

media/plugins/trackmate/spot-editor/TrackMate-Editor-Delete-SelectedLabel_halfsize.mp4

Whitespace-only changes.
220 KB
Loading

media/plugins/trackmate/spot-editor/TrackMate-Editor-FloodErase-RemoveAll_halfsize.mp4

Whitespace-only changes.
138 KB
Loading

media/plugins/trackmate/spot-editor/TrackMate-Editor-FloodErase-SelectedLabel_halfsize.mp4

Whitespace-only changes.
214 KB
Loading

0 commit comments

Comments
 (0)