Skip to content

Commit b8a192c

Browse files
committed
docs update
1 parent e77d440 commit b8a192c

File tree

2 files changed

+21
-9
lines changed

2 files changed

+21
-9
lines changed

docs/res/cropping_module_guide.rst

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ Folders can be stacks of either .png or .tif files, ideally numbered with the in
2222
.. note::
2323
Only single 3D **.tif** files or one folder of several **.png** or **.tif** (stack of 2D images) are supported.
2424

25-
You can the choose the size of the cropped volume, which will be constant throughout the process; make sure it is correct beforehand.
25+
You can then choose the size of the cropped volume, which will be constant throughout the process; make sure it is correct beforehand.
26+
Setting a larger size than the size of the image will cause issues.
2627
Support for dynamically changing the crop size might be added in the future.
2728

2829
Once you are ready, you can press **Start** to start the review process.
@@ -38,15 +39,17 @@ Once you have launched the review process, you will have access to three sliders
3839
you **change the position** of the cropped volumes and labels in the x,y and z positions.
3940

4041
.. hint::
41-
If you **cannot see your cropped volume well**, feel free to change the **colormaps** of the image and the cropped
42+
If you **cannot see your cropped volume well**, feel free to change the **colormap** of the image and the cropped
4243
volume to better see them.
4344
You may want to change the **opacity** and **contrast thresholds** depending on your image, too.
4445

4546

4647
.. note::
47-
When you are done you can save the cropped volume and labels directly using napari,
48-
by selecting the layer and then using **File -> Save selected layer**,
49-
or simply **CTRL+S** once you have selected the correct layer.
48+
When you are done you can save the cropped volume and labels directly with the
49+
**Quicksave** button on the lower left, which will save in the folder you picked the image from, or as
50+
a separate folder if you loaded a folder as a stack.
51+
If you want more options (name, format) you can save by selecting the layer and then
52+
using **File -> Save selected layer**, or simply **CTRL+S** once you have selected the correct layer.
5053

5154

5255

docs/res/inference_module_guide.rst

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Interface and functionalities
2424
--------------------------------
2525

2626
When launching the module, you will be asked to provide an image folder containing all the volumes you'd like to be labeled.
27-
All images with the **.tif** extension in this folder will be labeled.
27+
All images with the chosen (**.tif** or **.tiff** currently supported) extension in this folder will be labeled.
2828
You can then choose an output folder, where all the results will be saved.
2929

3030
.. note::
@@ -33,14 +33,23 @@ You can then choose an output folder, where all the results will be saved.
3333
| For example, using a VNet on the third image of a folder, called "volume_1.tif" will yield :
3434
| *volume_1_VNet_2022_04_06_15_49_42_pred3.tif*
3535
36+
You can then choose one of the selected models above, which will be used for inference.
37+
38+
If you want to see your results without anisotropy when you have anistropic images, you can specify that you have anisotropic data
39+
and set the resolution of your image in micron, this wil save & show the results without anisotropy.
40+
41+
You can perform thresholding to binarize your labels, all values beneath the confidence threshold will be set to 0 using this.
42+
If you wish to use instance segmentation it is recommended to use threshlding.
43+
3644
You can also select whether you'd like to see the results in napari afterwards; by default the first image processed will be displayed,
37-
but you can choose to display up to three or ten at once.
45+
but you can choose to display up to ten at once. You can also request to see the originals.
3846

3947
When you are done choosing your parameters, you can press the **Start** button to begin the inference process.
40-
Once it has finished, results will be saved then displayed in napari; each ouput will be paired with its original.
48+
Once it has finished, results will be saved then displayed in napari; each output will be paired with its original.
4149

4250
.. hint::
43-
| **Results** will be displayed using the **twilight shifted** colormap, whereas the **original** image will show in the **inferno** colormap.
51+
| **Results** will be displayed using the **twilight shifted** colormap if raw or **turbo** if thresholded,
52+
| whereas the **original** image will be shown in the **inferno** colormap.
4453
| Feel free to change the **colormap** or **contrast** when viewing results to ensure you can properly see the labels.
4554
| You'll most likely want to use **3D view** and **grid mode** in napari when checking results more broadly.
4655

0 commit comments

Comments
 (0)