feat: Described image cache

joda01 · Jan 9, 2025 · a4324a3 · a4324a3
1 parent 607ed2b
commit a4324a3
Show file tree

Hide file tree

Showing 7 changed files with 1,064 additions and 4 deletions.
diff --git a/docs/commands/command_image_math.md b/docs/commands/command_image_math.md
@@ -2,12 +2,13 @@
 (command-image-math)=
 # Image math
 
-:::{sidebar} Edge detection
+:::{sidebar} Pixel operations
 
-Edge detection is the process of finding edges in an image and converting them to a gradient representation.
-Sharper changes in the intensity values lead to a higher gradient.
+An image is represented as a matrix of pixel intensity values.
+When calculating with images a matrix operation is performed which uses the pixel value at `(n,m)` from both matrixes and applying the operator on that.
+The resulting matrix after applying the operator on all elements of the matrix is the resulting image.
 
-```{figure} images/edge_detection.drawio.svg
+```{figure} images/image_math.drawio.svg
 :class: full-image
 ```
 
@@ -16,3 +17,8 @@ Sharper changes in the intensity values lead to a higher gradient.
 ```{figure} images/image_math_screenshot.png
 :class: tiny-image
 ```
+
+The image math command can be used to combine two images using one of the provided mathematical operations.
+Input image one is the image from the last pipeline step, the second image is the image configured in the {guilabel}`Input image channel` settings.
+For the second image either an image channel can be used or an image stored in the cache from a previous pipeline.
+If {guilabel}`From cache` is not {guilabel}`None` the channel settings are ignored and the image from the selected cache slot is loaded.
diff --git a/docs/commands/command_store_to_cache.md b/docs/commands/command_store_to_cache.md
@@ -0,0 +1,31 @@
+
+(command-store-to-cache)=
+# Store to cache
+
+:::{sidebar} Cache
+
+ImageC cache is reserved place in the RAM of the computer.
+Storing an image to the cache stores the actual image to this place in RAM.
+Other commands can load these images from the RAM in an efficient way and apply further processing steps on it.
+
+```{figure} images/store_to_cache.drawio.svg
+:class: full-image
+```
+
+:::
+
+```{figure} images/image_math_screenshot.png
+:class: tiny-image
+```
+
+The store image to cache command stores an actual image at any time to the cache.
+Image cache allows using a preprocessed image as base for further preprocessing steps in an other pipeline or in the same pipeline in a future step.
+Possible applications might be to preprocess a background for subtraction and use this preprocessed background together with the image math subtract command in other pipelines to remove it.
+
+:::{note}
+Cache scope is the processing step of an image. For each image a separate cache storage is created.
+:::
+
+:::{note}
+Once an image is stored to the cache it is not edited any more. Loading from the cache creates a new local copy of the image and the pipeline is working on this local copy but not on the cached image.
+:::
diff --git a/docs/commands/images/image_math.drawio.svg b/docs/commands/images/image_math.drawio.svg
diff --git a/.../commands/images/image_math_screenhot.png → ...commands/images/image_math_screenshot.png b/.../commands/images/image_math_screenhot.png → ...commands/images/image_math_screenshot.png
diff --git a/docs/commands/images/store_image_to_cache_screenshot.png b/docs/commands/images/store_image_to_cache_screenshot.png
diff --git a/docs/commands/images/store_to_cache.drawio.svg b/docs/commands/images/store_to_cache.drawio.svg
diff --git a/docs/commands/index.md b/docs/commands/index.md
@@ -21,6 +21,8 @@ command_blur
 command_intensity
 command_median_subtract
 command_edge_detection
+command_image_math
+command_store_to_cache
 :::
 
 (commands-object-segmentation)=