updated param doc: added note that the ref image and alignment marks need to be updated as well (#2916)

param-doc: added note that the ref image and alignment marks need to be updated as well
2025-12-08 12:36:52 +03:00 · 2024-02-15 23:49:14 +01:00
parent 0ea4b3b3ce
commit 827d9d1700
17 changed files with 72 additions and 15 deletions
--- a/param-docs/parameter-pages/TakeImage/Aec2.md
+++ b/param-docs/parameter-pages/TakeImage/Aec2.md
@@ -5,6 +5,9 @@ Default Value: `false`
    This is an **Expert Parameter**! Only change it if you understand what it does!
      
 !!! Note
-    This parameter can also be set on the Reference Image configuration.
+    This parameter can also be set on the Reference Image configuration page!
+
+!!! Note
+    After changing this parameter you need to update your reference image and alignment markers!

 Switch to "Auto-exposure Control 2" algorithm. This may resolve some over-exposure and under-exposure issues.
--- a/param-docs/parameter-pages/TakeImage/AutoExposureLevel.md
+++ b/param-docs/parameter-pages/TakeImage/AutoExposureLevel.md
@@ -5,7 +5,10 @@ Default Value: `0`
    This is an **Expert Parameter**! Only change it if you understand what it does!

 !!! Note
-    This parameter can also be set on the Reference Image configuration.
+    This parameter can also be set on the Reference Image configuration page!
+
+!!! Note
+    After changing this parameter you need to update your reference image and alignment markers!

 Exposure compensation. Lower values produce darker image.

--- a/param-docs/parameter-pages/TakeImage/Brightness.md
+++ b/param-docs/parameter-pages/TakeImage/Brightness.md
@@ -2,6 +2,9 @@
 Default Value: `0`
      
 !!! Note
-    This parameter can also be set on the Reference Image configuration.
+    This parameter can also be set on the Reference Image configuration page!
+
+!!! Note
+    After changing this parameter you need to update your reference image and alignment markers!

 Image Brightness (`-2` .. `2`) 
--- a/param-docs/parameter-pages/TakeImage/Contrast.md
+++ b/param-docs/parameter-pages/TakeImage/Contrast.md
@@ -2,7 +2,10 @@
 Default Value: `0`

 !!! Note
-    This parameter can also be set on the Reference Image configuration.
+    This parameter can also be set on the Reference Image configuration page!
+
+!!! Note
+    After changing this parameter you need to update your reference image and alignment markers!

 Image Contrast (`-2` .. `2`)

--- a/param-docs/parameter-pages/TakeImage/FixedExposure.md
+++ b/param-docs/parameter-pages/TakeImage/FixedExposure.md
@@ -4,4 +4,10 @@ Default Value: `false`
 !!! Warning
    This is an **Expert Parameter**! Only change it if you understand what it does!

+!!! Note
+    This parameter can also be set on the Reference Image configuration page!
+
+!!! Note
+    After changing this parameter you need to update your reference image and alignment markers!
+
 Fixes the illumination setting of camera at the startup and uses this later -> Individual round is faster.
--- a/param-docs/parameter-pages/TakeImage/Grayscale.md
+++ b/param-docs/parameter-pages/TakeImage/Grayscale.md
@@ -5,6 +5,9 @@ Default Value: `false`
    This is an **Expert Parameter**! Only change it if you understand what it does!
      
 !!! Note
-    This parameter can also be set on the Reference Image configuration.
+    This parameter can also be set on the Reference Image configuration page!
+
+!!! Note
+    After changing this parameter you need to update your reference image and alignment markers!

 Produces black and white image.
--- a/param-docs/parameter-pages/TakeImage/LEDIntensity.md
+++ b/param-docs/parameter-pages/TakeImage/LEDIntensity.md
@@ -2,6 +2,9 @@
 Default Value: `50`

 !!! Note
-    This parameter can also be set on the Reference Image configuration.
+    This parameter can also be set on the Reference Image configuration page!
+
+!!! Note
+    After changing this parameter you need to update your reference image and alignment markers!

 Set the Flash LED Intensity: (`0` .. `100`)
--- a/param-docs/parameter-pages/TakeImage/Negative.md
+++ b/param-docs/parameter-pages/TakeImage/Negative.md
@@ -5,6 +5,9 @@ Default Value: `false`
    This is an **Expert Parameter**! Only change it if you understand what it does!
      
 !!! Note
-    This parameter can also be set on the Reference Image configuration.
+    This parameter can also be set on the Reference Image configuration page!
+
+!!! Note
+    After changing this parameter you need to update your reference image and alignment markers!

 Inverts the colors.
--- a/param-docs/parameter-pages/TakeImage/Saturation.md
+++ b/param-docs/parameter-pages/TakeImage/Saturation.md
@@ -2,7 +2,10 @@
 Default Value: `0`

 !!! Note
-    This parameter can also be set on the Reference Image configuration.
+    This parameter can also be set on the Reference Image configuration page!
+
+!!! Note
+    After changing this parameter you need to update your reference image and alignment markers!

 Image Saturation (`-2` .. `2`)

--- a/param-docs/parameter-pages/TakeImage/Sharpness.md
+++ b/param-docs/parameter-pages/TakeImage/Sharpness.md
@@ -5,7 +5,10 @@ Default Value: `0`
    This is an **Expert Parameter**! Only change it if you understand what it does!
      
 !!! Note
-    This parameter can also be set on the Reference Image configuration.
+    This parameter can also be set on the Reference Image configuration page!
+
+!!! Note
+    After changing this parameter you need to update your reference image and alignment markers!

 Changes the sharpness of the image. Set to `-4` for auto-sharpness. 

--- a/param-docs/parameter-pages/TakeImage/Zoom.md
+++ b/param-docs/parameter-pages/TakeImage/Zoom.md
@@ -5,6 +5,9 @@ Default Value: `false`
    This is an **Expert Parameter**! Only change it if you understand what it does!

 !!! Note
-    This parameter can also be set on the Reference Image configuration.
+    This parameter can also be set on the Reference Image configuration page!
+
+!!! Note
+    After changing this parameter you need to update your reference image and alignment markers!

 Crop the camera sensor frame to `ImageSize` resolution instead of scaling it down.
--- a/param-docs/parameter-pages/TakeImage/ZoomMode.md
+++ b/param-docs/parameter-pages/TakeImage/ZoomMode.md
@@ -5,7 +5,10 @@ Default Value: `0`
    This is an **Expert Parameter**! Only change it if you understand what it does!

 !!! Note
-    This parameter can also be set on the Reference Image configuration.
+    This parameter can also be set on the Reference Image configuration page!
+
+!!! Note
+    After changing this parameter you need to update your reference image and alignment markers!

 `ZoomMode` only applies when `Zoom` is enabled.
 Value 0: Crop the camera sensor frame to `ImageSize` resolution.
--- a/param-docs/parameter-pages/TakeImage/ZoomOffsetX.md
+++ b/param-docs/parameter-pages/TakeImage/ZoomOffsetX.md
@@ -5,7 +5,10 @@ Default Value: `0`
    This is an **Expert Parameter**! Only change it if you understand what it does!

 !!! Note
-    This parameter can also be set on the Reference Image configuration.
+    This parameter can also be set on the Reference Image configuration page!
+
+!!! Note
+    After changing this parameter you need to update your reference image and alignment markers!

 `ZoomOffsetX` only applies when `Zoom` is enabled.
 X coordinate of the crop location within the camera sensor frame.
--- a/param-docs/parameter-pages/TakeImage/ZoomOffsetY.md
+++ b/param-docs/parameter-pages/TakeImage/ZoomOffsetY.md
@@ -5,7 +5,10 @@ Default Value: `0`
    This is an **Expert Parameter**! Only change it if you understand what it does!

 !!! Note
-    This parameter can also be set on the Reference Image configuration.
+    This parameter can also be set on the Reference Image configuration page!
+
+!!! Note
+    After changing this parameter you need to update your reference image and alignment markers!

 `ZoomOffsetY` only applies when `Zoom` is enabled.
 Y coordinate of the crop location within the camera sensor frame.