Skip to content

Commit 3ab9a8d

Browse files
Update documentation
1 parent 79c6242 commit 3ab9a8d

File tree

2 files changed

+38
-3
lines changed

2 files changed

+38
-3
lines changed
-277 Bytes
Loading

doc/start_page.md

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ to use them.
6060

6161
## Segmentation Models
6262

63-
We currently offer 7 different models for segmenting synaptic structures:
63+
We currently offer seven different models for segmenting synaptic structures:
6464
- `vesicles_3d` to segment vesicles in (room-temperature) electron tomograms.
6565
- `vesicles_2d` to segment vesicles in two-dimensional electron micrographs.
6666
- `vesicles_cryo` to segment vesicles in cryogenic electron tomograms.
@@ -72,7 +72,42 @@ We currently offer 7 different models for segmenting synaptic structures:
7272

7373
## Napari Plugin
7474

75-
**The napari plugin will be documented in the next few days!**
75+
After installing SynapseNet you can start napari by activating the `synapse-net` environment (or another environment you installed it in) and executing the `napari` command.
76+
Once napari is opened, you can load a tomogram (or other image data), by drag'n'dropping the corresponding mrc file onto the napari window.
77+
78+
You can find the SynapseNet widgets in the menu `Plugin->SynapseNet`, see also the screenshot below.
79+
We currently provide five different plugins, which are explained in the following paragraphs.
80+
81+
<img src="https://raw.githubusercontent.com/computational-cell-analytics/synapse-net/refs/heads/main/doc/images/napari/napari1-plugin-menu.jpg" alt="The napari plugin widget with selection of the SynapseNet plugins." width="768">
82+
83+
The `Segmentation` widget enables segmenting synaptic structures with the SynapseNet [models](#segmentation-models).
84+
You can select the image layer for which to run segmentation from the `Image data` dropdown and the model to use from the `Select Model` dropdown.
85+
Then press `Run Segmentation`. To display a progress bar click on `activity` in the lower right.
86+
The screenshot below shows the Segmentation UI and a segmentation result for 2D vesicle segmentation.
87+
88+
<img src="https://raw.githubusercontent.com/computational-cell-analytics/synapse-net/refs/heads/main/doc/images/napari/napari2-segmentation-widget.jpg" alt="The napari plugin widget with selection of the SynapseNet plugins." width="768">
89+
90+
The `Distance Measurement` widget measures distances between segmented vesicles and another object. You can select the vesicle segmentation from the `Segmentation` dropdown and the object from the `Object` dropdown.
91+
Then press `Measure Distances` to measure the distances, which will be displayed as red lines in the image.
92+
The measured values will be shown in a table, which can also be saved to a csv file.
93+
The screenshot below shows distances measured between the vesicles and active zone (red structure).
94+
Alternatively, you can measure the pairwise distances between individual vesicles via `Measure Pairwise Distances`.
95+
96+
<img src="https://raw.githubusercontent.com/computational-cell-analytics/synapse-net/refs/heads/main/doc/images/napari/napari3-distance-widget.jpg" alt="The napari plugin widget with selection of the SynapseNet plugins." width="768">
97+
98+
The `Morphology Analysis` widget measures morphometric features, such as radii and intensity statistics for vesicles, or surface area and volume for other structures. The widget functions similar to the distance measurement.
99+
100+
<img src="https://raw.githubusercontent.com/computational-cell-analytics/synapse-net/refs/heads/main/doc/images/napari/napari4-morphology-widget.jpg" alt="The napari plugin widget with selection of the SynapseNet plugins." width="768">
101+
102+
The `Pool Assignment` widget groups vesicles into different pools based on the distance and morphology measurements from the previous widgets.
103+
Select the vesicles via the `Vesicle Segmentation` dropdown and the distances to up to two different structures via `Distances to Structure` and `Distances to Structure 2`.
104+
Then, specify the name for a new layer where the pools will be saved via `Layer Name`, the name for the current pool via `Vesicle Pool` and the criterion for the pool via `Criterion`. Pressing `Create Vesicle Pool` creates the assignment for the pool by copying the vesicles that meet the criterion to the specified layer.
105+
You can press it multiple times for different criteria to group the vesicles into different pools.
106+
The screenshot below shows a grouping of vesicles into 'close' (red) and 'far' (blue) vesicles based on their distance to the active zone.
107+
108+
<img src="https://raw.githubusercontent.com/computational-cell-analytics/synapse-net/refs/heads/main/doc/images/napari/napari5-pool-widget.jpg" alt="The napari plugin widget with selection of the SynapseNet plugins." width="768">
109+
110+
In addition, the `Segmentation Postprocessing` widget can be used to filter out objects that do not overlap with a mask, e.g. a synaptic compartment, or to intersect a segmentation with the boundaries of a mask.
76111

77112

78113
## Command Line Functionality
@@ -113,7 +148,7 @@ We offer different functionality for segmenting and analyzing synapses in electr
113148
- `synapse_net.imod` for importing and exporting segmentations from / to IMOD.
114149
- `synapse_net.training` for training U-Nets for synaptic structure segmentation, either via [domain adaptation](#domain-adaptation) or [using data with annotations](network-training).
115150

116-
Please refer to the library documentation below for a full overview of our library's functionality.
151+
Please refer to the module documentation below for a full overview of our library's functionality.
117152

118153
### Domain Adaptation
119154

0 commit comments

Comments
 (0)