You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23-1Lines changed: 23 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,11 +8,15 @@ We implement napari applications for:
8
8
9
9
**Early beta version**
10
10
11
-
This is an early beta version. Any feedback is welcome, but please be aware that the functionality is evolving fast and not fully tested.
11
+
This is an early beta version. Any feedback is welcome, but please be aware that the functionality is under active development and that several features are not finalized or thoroughly tested yet.
12
+
Once the functionality has matured we plan to release the interactive annotation applications as [napari plugins](https://napari.org/stable/plugins/index.html).
13
+
12
14
13
15
## Functionality overview
14
16
15
17
TODO
18
+
- quick explanation and gifs
19
+
16
20
17
21
## Installation
18
22
@@ -51,15 +55,32 @@ pip install -e .
51
55
52
56
## Usage
53
57
58
+
After the installation the three applications for interactive annotations can be started from the command line or within a python script:
59
+
-**2d annotation**: via the command `micro_sam.annotator_2d` or with the function `micro_sam.sam_annotator.annotator_2d` from python. Run `micro_sam.annotator_2d -h` or check out [examples/sam_annotator_2d](https://github.com/computational-cell-analytics/micro-sam/blob/master/examples/sam_annotator_2d.py) for details.
60
+
-**3d annotation**: via the command `micro_sam.annotator_3d` or with the function `micro_sam.sam_annotator.annotator_3d` from python. Run `micro_sam.annotator_3d -h` or check out [examples/sam_annotator_3d](https://github.com/computational-cell-analytics/micro-sam/blob/master/examples/sam_annotator_3d.py) for details.
61
+
-**tracking**: via the command `micro_sam.annotator_tracking` or with the function `micro_sam.sam_annotator.annotator_tracking` from python. Run `micro_sam.annotator_tracking -h` or check out [examples/sam_annotator_tracking](https://github.com/computational-cell-analytics/micro-sam/blob/master/examples/sam_annotator_tracking.py) for details.
62
+
54
63
TODO
64
+
- show image with annotated user interface (for 3d?!)
65
+
- link to videos that explain the functionality for the 3 plugins
55
66
56
67
### Tips & Tricks
57
68
58
69
TODO
70
+
- speeding things up: precomputing the embeddings with a gpu, making input images smaller
71
+
- correcting existing segmentaitons via `segmentation_results`
72
+
- saving and loading intermediate results via segmentation results
73
+
74
+
### Limitations
75
+
76
+
TODO
77
+
- automatic instance segmentation limitations
59
78
60
79
## Using the micro_sam library
61
80
62
81
TODO
82
+
- link to the example image series application
83
+
63
84
64
85
## Contributing
65
86
@@ -68,6 +89,7 @@ micro_sam <- library with utility functionality for using SAM for microscopy dat
68
89
/sam_annotator <- the napari plugins for annotation
69
90
```
70
91
92
+
71
93
## Citation
72
94
73
95
If you are using this repository in your research please cite
0 commit comments