From 8b1c65a38afaa49aaa4e118258880d01b3c8176e Mon Sep 17 00:00:00 2001 From: Joo Aun Saw Date: Sun, 4 Feb 2024 17:38:44 +1100 Subject: [PATCH] add documentation for new TakeImage options --- param-docs/parameter-pages/TakeImage/Aec2.md | 10 ++++++++++ .../parameter-pages/TakeImage/AutoExposureLevel.md | 10 ++++++++++ param-docs/parameter-pages/TakeImage/Grayscale.md | 10 ++++++++++ param-docs/parameter-pages/TakeImage/Negative.md | 10 ++++++++++ param-docs/parameter-pages/TakeImage/Sharpness.md | 10 ++++++++++ param-docs/parameter-pages/TakeImage/Zoom.md | 10 ++++++++++ param-docs/parameter-pages/TakeImage/ZoomMode.md | 12 ++++++++++++ param-docs/parameter-pages/TakeImage/ZoomOffsetX.md | 11 +++++++++++ param-docs/parameter-pages/TakeImage/ZoomOffsetY.md | 11 +++++++++++ 9 files changed, 94 insertions(+) create mode 100644 param-docs/parameter-pages/TakeImage/Aec2.md create mode 100644 param-docs/parameter-pages/TakeImage/AutoExposureLevel.md create mode 100644 param-docs/parameter-pages/TakeImage/Grayscale.md create mode 100644 param-docs/parameter-pages/TakeImage/Negative.md create mode 100644 param-docs/parameter-pages/TakeImage/Sharpness.md create mode 100644 param-docs/parameter-pages/TakeImage/Zoom.md create mode 100644 param-docs/parameter-pages/TakeImage/ZoomMode.md create mode 100644 param-docs/parameter-pages/TakeImage/ZoomOffsetX.md create mode 100644 param-docs/parameter-pages/TakeImage/ZoomOffsetY.md diff --git a/param-docs/parameter-pages/TakeImage/Aec2.md b/param-docs/parameter-pages/TakeImage/Aec2.md new file mode 100644 index 00000000..08816c25 --- /dev/null +++ b/param-docs/parameter-pages/TakeImage/Aec2.md @@ -0,0 +1,10 @@ +# Parameter `Aec2` +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. + +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 new file mode 100644 index 00000000..6eb68982 --- /dev/null +++ b/param-docs/parameter-pages/TakeImage/AutoExposureLevel.md @@ -0,0 +1,10 @@ +# Parameter `AutoExposureLevel` +Default Value: `0` + +!!! 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. + +Exposure compensation. Lower values produce darker image. Range (`-2` .. `2`) diff --git a/param-docs/parameter-pages/TakeImage/Grayscale.md b/param-docs/parameter-pages/TakeImage/Grayscale.md new file mode 100644 index 00000000..b5b442ac --- /dev/null +++ b/param-docs/parameter-pages/TakeImage/Grayscale.md @@ -0,0 +1,10 @@ +# Parameter `Grayscale` +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. + +Produces black and white image. diff --git a/param-docs/parameter-pages/TakeImage/Negative.md b/param-docs/parameter-pages/TakeImage/Negative.md new file mode 100644 index 00000000..3d5a2c97 --- /dev/null +++ b/param-docs/parameter-pages/TakeImage/Negative.md @@ -0,0 +1,10 @@ +# Parameter `Negative` +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. + +Inverts the colors. diff --git a/param-docs/parameter-pages/TakeImage/Sharpness.md b/param-docs/parameter-pages/TakeImage/Sharpness.md new file mode 100644 index 00000000..da6bafc0 --- /dev/null +++ b/param-docs/parameter-pages/TakeImage/Sharpness.md @@ -0,0 +1,10 @@ +# Parameter `Sharpness` +Default Value: `0` + +!!! 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. + +Changes the sharpness of the image. Set to -4 for auto-sharpness. Range (`-4` .. `3`) diff --git a/param-docs/parameter-pages/TakeImage/Zoom.md b/param-docs/parameter-pages/TakeImage/Zoom.md new file mode 100644 index 00000000..eadbf356 --- /dev/null +++ b/param-docs/parameter-pages/TakeImage/Zoom.md @@ -0,0 +1,10 @@ +# Parameter `Zoom` +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. + +Crop the camera sensor frame to the selected `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 new file mode 100644 index 00000000..dd9a12f9 --- /dev/null +++ b/param-docs/parameter-pages/TakeImage/ZoomMode.md @@ -0,0 +1,12 @@ +# Parameter `ZoomMode` +Default Value: `0` + +!!! 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. + +`ZoomMode` only applies when `Zoom` is enabled. +Value 0: Crop the camera sensor frame to `ImageSize` resolution. +Value 1: Scale the camera sensor frame to 800 x 600 pixels then crop it to `ImageSize` resolution. diff --git a/param-docs/parameter-pages/TakeImage/ZoomOffsetX.md b/param-docs/parameter-pages/TakeImage/ZoomOffsetX.md new file mode 100644 index 00000000..486ed658 --- /dev/null +++ b/param-docs/parameter-pages/TakeImage/ZoomOffsetX.md @@ -0,0 +1,11 @@ +# Parameter `ZoomOffsetX` +Default Value: `0` + +!!! 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. + +`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 new file mode 100644 index 00000000..3ca29b8e --- /dev/null +++ b/param-docs/parameter-pages/TakeImage/ZoomOffsetY.md @@ -0,0 +1,11 @@ +# Parameter `ZoomOffsetY` +Default Value: `0` + +!!! 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. + +`ZoomOffsetY` only applies when `Zoom` is enabled. +Y coordinate of the crop location within the camera sensor frame.