Browse Source

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
CaCO3 1 year ago
parent
commit
827d9d1700

+ 4 - 1
param-docs/parameter-pages/Alignment/FlipImageSize.md

@@ -2,7 +2,10 @@
 Default Value: `false`
     
 !!! 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!
 
 This parameter can be used to rotate the viewport together with the alignment rotation:
 ![](img/flipImageSize.png) 

+ 4 - 1
param-docs/parameter-pages/Alignment/InitialMirror.md

@@ -2,6 +2,9 @@
 Default Value: `false`
     
 !!! 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!
 
 Option for initially mirroring the image on the original x-axis.

+ 6 - 0
param-docs/parameter-pages/Alignment/InitialRotate.md

@@ -3,4 +3,10 @@ Default Value: `0`
 
 Unit: Degrees
 
+!!! 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!
+
 Initial rotation of image before alignment in degree (`-360` .. `+360`)

+ 4 - 1
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.

+ 4 - 1
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.
 

+ 4 - 1
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`) 

+ 4 - 1
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`)
 

+ 6 - 0
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.

+ 4 - 1
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.

+ 4 - 1
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`)

+ 4 - 1
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.

+ 4 - 1
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`)
 

+ 4 - 1
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. 
 

+ 4 - 1
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.

+ 4 - 1
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.

+ 4 - 1
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.

+ 4 - 1
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.