Skip to content

Commit 5741a71

Browse files
committed
updated docs
1 parent c1cda0c commit 5741a71

13 files changed

Lines changed: 59 additions & 21 deletions
28.5 KB
Loading

docs/assets/extractor_1.png

-29.3 KB
Binary file not shown.
-75.8 KB
Binary file not shown.
28.5 KB
Loading
File renamed without changes.
83.3 KB
Loading
66.4 KB
Loading
74.3 KB
Loading

docs/feature_extractor.md

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,30 +9,20 @@ You can bring up the *Feature Extractor widget* from the napari **Plugins** menu
99
![plugins menu](assets/plugins_menu.png){width="360"}
1010

1111
## Widget Tools Description
12-
![Feature Extractor](assets/extractor_widget/extractor.png){width="360"}
12+
![Feature Extractor](assets/extractor_widget/extractor_numbered.png){width="360"}
1313

1414
1. **Image Layer**: To select your current image stack.
1515
2. **Encoder Model**: Sets which model you want to use for feature extraction.
1616
The **FF** plugins, by default, comes with `MobileSAM`, `SAM (huge)`, `μSAM_LM (base)`, `μSAM_EM_Organelles (base)`, `DINOv2`, `SAM2 (large)`, and `SAM2 (base)` models. It is also possible to introduce a new model by adding a new [*model adapter*](./model_adapter.md) class.
17-
3. **Features Storage File**: Where you want to save the features as an `HDF5` file.
18-
4. **Extract Features** button: Will run the feature extraction process.
19-
5. **Stop** button: To stop the extraction process!
20-
21-
## CLI Description
22-
23-
You can also extract features by running the `featureforest.feature_extractor` CLI in your terminal.
24-
25-
Here is a brief description of the expected input arguments (see `$ featureforest.feature_extractor -h` for details):
26-
1. `--input_path`: The filepath to an input image.
27-
2. `--output_path`: The filepath where the extracted features will be stored for the next step, i.e. [_Segmentation_](./segmentation.md).
28-
3. `--model_choice`: The choice of model that will be used for feature extraction.
29-
30-
The extraction process might take some time based on number of image slices and the image resolution. This is due to the fact that in **FF** we turn an image into overlapping patches, then pass those patches to the encoder model to get the features. Why we do this? We need to aquire a feature vector per each pixel and not for the whole image.
17+
3. **No Patching**: If checked, it means no patching will happen during the feature extraction process. Otherwise, the image will be divided into patches before passing them through the encoder model. By using SAM2 encoders, you might check this box to save some computation power.
18+
4. **Features Storage File**: Where you want to save the features as an `HDF5` file.
19+
5. **Extract Features** button: Will run the feature extraction process.
20+
6. **Stop** button: To stop the extraction process!
3121

3222
## Model Selection
3323
Our experiments tell us usually the `SAM2 (large)` model works the best. However, for less complicated images, using `MobileSAM` or `DINOv2` might also result in a good segmentation as they are lighter and faster.
3424

3525
!!! note
36-
When you use a model for the first time, the model's weight will be downloaded from their repository. So, you might hit a little delay at the first use of model.
26+
When you use a model for the first time, the model's weight will be downloaded from their repository. So, you might hit a little delay at the first usage of model.
3727

3828
Once you have your image features extracted, you can use the [**Segmentation**](./segmentation.md) widget to generate your image masks.

docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ title: Welcome
99
### Overview
1010
FF plugin includes two widgets: **Feature Extractor** and **Segmentation** widgets.
1111

12-
![Feature Extractor](assets/extractor_1.png){width="300"}
12+
![Feature Extractor](assets/extractor_widget/extractor_1.png){width="300"}
1313
/// caption
1414
Feature Extractor Widget
1515
///
1616

17-
![Segmentation](assets/segmentation_1.png){width="300" align=left}
18-
![Segmentation](assets/segmentation_2.png){width="300" align=right}
17+
![Segmentation](assets/segmentation_widget/segmentation_1.png){width="300" align=left}
18+
![Segmentation](assets/segmentation_widget/segmentation_2.png){width="300" align=right}
1919
/// caption
2020
Segmentation Widget
2121
///

0 commit comments

Comments
 (0)