From 39a74b64cf221a501bb205864d6d54949ef17c44 Mon Sep 17 00:00:00 2001 From: CaCO3 Date: Thu, 15 Feb 2024 23:40:10 +0100 Subject: [PATCH] added note that the ref image and alignment marks need to be updated as well --- param-docs/parameter-pages/Alignment/FlipImageSize.md | 5 ++++- param-docs/parameter-pages/Alignment/InitialMirror.md | 5 ++++- param-docs/parameter-pages/Alignment/InitialRotate.md | 6 ++++++ param-docs/parameter-pages/TakeImage/Aec2.md | 5 ++++- param-docs/parameter-pages/TakeImage/AutoExposureLevel.md | 5 ++++- param-docs/parameter-pages/TakeImage/Brightness.md | 5 ++++- param-docs/parameter-pages/TakeImage/Contrast.md | 5 ++++- param-docs/parameter-pages/TakeImage/FixedExposure.md | 6 ++++++ param-docs/parameter-pages/TakeImage/Grayscale.md | 5 ++++- param-docs/parameter-pages/TakeImage/LEDIntensity.md | 5 ++++- param-docs/parameter-pages/TakeImage/Negative.md | 5 ++++- param-docs/parameter-pages/TakeImage/Saturation.md | 5 ++++- param-docs/parameter-pages/TakeImage/Sharpness.md | 5 ++++- param-docs/parameter-pages/TakeImage/Zoom.md | 5 ++++- param-docs/parameter-pages/TakeImage/ZoomMode.md | 5 ++++- param-docs/parameter-pages/TakeImage/ZoomOffsetX.md | 5 ++++- param-docs/parameter-pages/TakeImage/ZoomOffsetY.md | 5 ++++- 17 files changed, 72 insertions(+), 15 deletions(-) diff --git a/param-docs/parameter-pages/Alignment/FlipImageSize.md b/param-docs/parameter-pages/Alignment/FlipImageSize.md index 547d10507..98960cc10 100644 --- a/param-docs/parameter-pages/Alignment/FlipImageSize.md +++ b/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) diff --git a/param-docs/parameter-pages/Alignment/InitialMirror.md b/param-docs/parameter-pages/Alignment/InitialMirror.md index 764b14c56..d54aeebab 100644 --- a/param-docs/parameter-pages/Alignment/InitialMirror.md +++ b/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. diff --git a/param-docs/parameter-pages/Alignment/InitialRotate.md b/param-docs/parameter-pages/Alignment/InitialRotate.md index fec2e570f..93eb10d2b 100644 --- a/param-docs/parameter-pages/Alignment/InitialRotate.md +++ b/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`) diff --git a/param-docs/parameter-pages/TakeImage/Aec2.md b/param-docs/parameter-pages/TakeImage/Aec2.md index 08816c256..5f3079d88 100644 --- 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. diff --git a/param-docs/parameter-pages/TakeImage/AutoExposureLevel.md b/param-docs/parameter-pages/TakeImage/AutoExposureLevel.md index c2724db6d..9cbe5a6a6 100644 --- 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. diff --git a/param-docs/parameter-pages/TakeImage/Brightness.md b/param-docs/parameter-pages/TakeImage/Brightness.md index 165638f6c..c29ce5b98 100644 --- 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`) diff --git a/param-docs/parameter-pages/TakeImage/Contrast.md b/param-docs/parameter-pages/TakeImage/Contrast.md index 633e0fba8..3f0404687 100644 --- 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`) diff --git a/param-docs/parameter-pages/TakeImage/FixedExposure.md b/param-docs/parameter-pages/TakeImage/FixedExposure.md index 2491e062f..68f02505b 100644 --- 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. diff --git a/param-docs/parameter-pages/TakeImage/Grayscale.md b/param-docs/parameter-pages/TakeImage/Grayscale.md index b5b442ac3..84eee544c 100644 --- 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. diff --git a/param-docs/parameter-pages/TakeImage/LEDIntensity.md b/param-docs/parameter-pages/TakeImage/LEDIntensity.md index 9ce5d5c66..f26d767de 100644 --- 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`) diff --git a/param-docs/parameter-pages/TakeImage/Negative.md b/param-docs/parameter-pages/TakeImage/Negative.md index 3d5a2c971..b416ead46 100644 --- 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. diff --git a/param-docs/parameter-pages/TakeImage/Saturation.md b/param-docs/parameter-pages/TakeImage/Saturation.md index a3b0868fc..877029f95 100644 --- 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`) diff --git a/param-docs/parameter-pages/TakeImage/Sharpness.md b/param-docs/parameter-pages/TakeImage/Sharpness.md index 670af9561..0acc4c4b8 100644 --- 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. diff --git a/param-docs/parameter-pages/TakeImage/Zoom.md b/param-docs/parameter-pages/TakeImage/Zoom.md index fe8c59a18..b3521aff3 100644 --- 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. diff --git a/param-docs/parameter-pages/TakeImage/ZoomMode.md b/param-docs/parameter-pages/TakeImage/ZoomMode.md index dd9a12f96..56124d163 100644 --- 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. diff --git a/param-docs/parameter-pages/TakeImage/ZoomOffsetX.md b/param-docs/parameter-pages/TakeImage/ZoomOffsetX.md index 486ed658c..6aeb48c0d 100644 --- 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. diff --git a/param-docs/parameter-pages/TakeImage/ZoomOffsetY.md b/param-docs/parameter-pages/TakeImage/ZoomOffsetY.md index 3ca29b8e2..f605b1aa9 100644 --- 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.