Skip to content

Commit 9e8b28c

Browse files
More doc updates and throw error message for invalid 3d segmentation
1 parent a862c3c commit 9e8b28c

File tree

5 files changed

+19
-14
lines changed

5 files changed

+19
-14
lines changed

doc/annotation_tools.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -88,29 +88,30 @@ The user interface of the tracking annotator looks like this:
8888
<img src="https://raw.githubusercontent.com/computational-cell-analytics/micro-sam/master/doc/images/tracking-annotator-menu.png" width="1024">
8989

9090
Most elements are the same as in [the 2d annotator](#annotator-2d):
91-
1. The napari layers that contain the image, segmentation and prompts. Same as for [the 2d segmentation app](#annotator-2d) but without the `auto_segmentation` layer, `current_tracks` and `committed_tracks` are the equivalent of `current_object` and `committed_objects`.
92-
2. The prompt menu.
93-
3. The menu with tracking settings: `track_state` is used to indicate that the object you are tracking is dividing in the current frame. `track_id` is used to select which of the tracks after division you are following.
94-
4. The menu for interactive segmentation.
95-
5. The tracking menu. Press `Track Object` (or `Shift-S`) to segment the current object across time.
96-
6. The menu for committing the current tracking result.
97-
7. The menu for clearing the current annotations.
91+
1. The napari layers that contain the segmentations and prompts. Same as for [the 2d segmentation app](#annotator-2d) but without the `auto_segmentation` layer.
92+
2. The embedding menu.
93+
3. The prompt menu.
94+
4. The menu with tracking settings: `track_state` is used to indicate that the object you are tracking is dividing in the current frame. `track_id` is used to select which of the tracks after division you are following.
95+
5. The menu for interactive segmentation.
96+
6. The menu for interactive tracking menu. Click `Track Object` (or press `Shift + S`) to segment the current object across time.
97+
7. The menu for committing the current tracking result.
98+
8. The menu for clearing the current annotations.
9899

99-
Note that the tracking annotator only supports 2d image data, volumetric data is not supported.
100+
Note that the tracking annotator only supports 2d image data, volumetric data is not supported. We also do not support automatic tracking yet.
100101

101102
Check out [this video](TODO) for a tutorial for how to use the tracking annotation tool.
102103

103104

104105
## Image Series Annotator
105106

106-
TODO
107+
<img src="https://raw.githubusercontent.com/computational-cell-analytics/micro-sam/master/doc/images/series-menu.png" width="1024">
107108

108109
We also provide the `image series annotator`, which can be used for running the 2d annotator for several images in a folder. You can start by clicking `Image series annotator` in the GUI, running `micro_sam.image_series_annotator` in the command line or from a [python script](https://github.com/computational-cell-analytics/micro-sam/blob/master/examples/image_series_annotator.py).
109110

110111

111112
## Finetuning Tool
112113

113-
TODO
114+
<img src="https://raw.githubusercontent.com/computational-cell-analytics/micro-sam/master/doc/images/finetuning-menu.png" width="1024">
114115

115116

116117
## Tips & Tricks

doc/images/finetuning-menu.png

-50.3 KB
Loading

doc/images/series-menu.png

-47.2 KB
Loading

doc/python_library.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# How to use the Python Library
1+
# Using the Python Library
22

33
The python library can be imported via
44
```python

micro_sam/sam_annotator/_widgets.py

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1552,9 +1552,13 @@ def _allow_segment_3d(self):
15521552
return True
15531553

15541554
def _run_segmentation_3d(self, kwargs):
1555-
if not self._allow_segment_3d():
1556-
print("Volumetric segmentation with AMG is only supported if you have a GPU.")
1557-
return
1555+
allow_segment_3d = self._allow_segment_3d()
1556+
if not allow_segment_3d:
1557+
val_results = {
1558+
"message_type": "error",
1559+
"message": "Volumetric segmentation with AMG is only supported if you have a GPU."
1560+
}
1561+
return _generate_message(val_results["message_type"], val_results["message"])
15581562

15591563
pbar, pbar_signals = _create_pbar_for_threadworker()
15601564

0 commit comments

Comments
 (0)