test blur doc

supervisely-ecosystem · Sep 29, 2023 · ffef1a4 · ffef1a4
1 parent 73de870
commit ffef1a4
Showing 1 changed file with 73 additions and 0 deletions.
diff --git a/src/ui/dtl/actions/blur/readme.md b/src/ui/dtl/actions/blur/readme.md
@@ -0,0 +1,73 @@
+# Blur
+
+Layer for blurring the image by applying a Gaussian or median filter.
+
+### Settings:
+
+- Blur type:
+  - Possible values: "Median" or "Gaussian"
+- Kernel size (if blur type is "Median"):
+  - Possible values: positive odd integer
+- Sigma (if blur type is "Gaussian"):
+  - Possible values: positive float
+
+## Example:
+
+Json config examples:
+
+#### Gaussian blur
+
+```json
+{
+  "action": "blur",
+  "src": ["$data1"],
+  "dst": "$data2",
+  "settings": {
+    "blur_type": "gaussian",
+    "sigma": { "min": 4, "max": 6 }
+  }
+}
+```
+
+#### Median blur
+
+```json
+{
+  "action": "blur",
+  "src": ["$data1"],
+  "dst": "$data2",
+  "settings": {
+    "blur_type": "Median",
+    "kernel_size": 65
+  }
+}
+```
+
+<table>
+<tr>
+<td>Original image</td>
+<td>Gaussian blur. Sigma: 4-6</td>
+<td>Median blur, kernel size: 65</td>
+</tr>
+<tr>
+<td> <img src="https://github.com/supervisely-ecosystem/dtl-v2/assets/79905215/2a75b8d9-a666-4075-ada7-665b38bd9f6f" alt="Original image" style="width: 33%;"/> </td>
+<td> <img src="https://github.com/supervisely-ecosystem/dtl-v2/assets/79905215/cfbecd28-3879-4c1b-9512-158b671be113" alt="Gaussian sigma: 4-6" style="width: 33%;"/> </td>
+<td> <img src="https://github.com/supervisely-ecosystem/dtl-v2/assets/79905215/ba758520-35ee-4fbd-bbda-2666e63dd7c6" alt="Median, kernel size: 65" style="width: 33%;"/> </td>
+</tr>
+</table>
+
+| Original image                                                                                                          | Gaussian blur. Sigma: 4-6                                                                                                    | Median blur, kernel size: 65                                                                                                     |
+| ----------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
+| ![Original image](https://github.com/supervisely-ecosystem/dtl-v2/assets/79905215/2a75b8d9-a666-4075-ada7-665b38bd9f6f) | ![Gaussian sigma: 4-6](https://github.com/supervisely-ecosystem/dtl-v2/assets/79905215/cfbecd28-3879-4c1b-9512-158b671be113) | ![Median, kernel size: 65](https://github.com/supervisely-ecosystem/dtl-v2/assets/79905215/ba758520-35ee-4fbd-bbda-2666e63dd7c6) |
+
+<!-- ### Original Image
+
+![Original image](https://github.com/supervisely-ecosystem/dtl-v2/assets/79905215/2a75b8d9-a666-4075-ada7-665b38bd9f6f)
+
+### Blur type: Median, Kernel size: 65
+
+![Median, kernel size: 65](https://github.com/supervisely-ecosystem/dtl-v2/assets/79905215/ba758520-35ee-4fbd-bbda-2666e63dd7c6)
+
+### Blur type: Gaussian, Sigma: 4-6
+
+![Gaussian sigma: 4-6](https://github.com/supervisely-ecosystem/dtl-v2/assets/79905215/cfbecd28-3879-4c1b-9512-158b671be113) -->