From cb3f0822183983526ee2ecb56a39aa8ec6e1c5c1 Mon Sep 17 00:00:00 2001 From: michael Date: Mon, 19 Aug 2024 00:42:33 +0200 Subject: [PATCH] CamParameter documentation update https://github.com/jomjol/AI-on-the-edge-device/issues/3185 --- .../parameter-pages/TakeImage/CamAeLevel.md | 7 ++++--- param-docs/parameter-pages/TakeImage/CamAec.md | 9 ++++++--- param-docs/parameter-pages/TakeImage/CamAec2.md | 11 +++++++---- .../parameter-pages/TakeImage/CamAecValue.md | 9 +++++---- param-docs/parameter-pages/TakeImage/CamAgc.md | 7 +++++-- .../parameter-pages/TakeImage/CamAgcGain.md | 11 +++++++---- .../parameter-pages/TakeImage/CamAutoSharpness.md | 12 ++++++++---- param-docs/parameter-pages/TakeImage/CamAwb.md | 11 +++++++---- .../parameter-pages/TakeImage/CamAwbGain.md | 5 +++-- param-docs/parameter-pages/TakeImage/CamBpc.md | 5 +++-- .../parameter-pages/TakeImage/CamBrightness.md | 12 ++++++++---- .../parameter-pages/TakeImage/CamColorbar.md | 8 ++++++-- .../parameter-pages/TakeImage/CamContrast.md | 9 ++++++--- param-docs/parameter-pages/TakeImage/CamDcw.md | 13 +++++++++---- .../parameter-pages/TakeImage/CamDenoise.md | 7 +++---- .../parameter-pages/TakeImage/CamGainceiling.md | 15 +++++++++++---- .../parameter-pages/TakeImage/CamHmirror.md | 10 ++++++---- param-docs/parameter-pages/TakeImage/CamLenc.md | 7 +++++-- .../parameter-pages/TakeImage/CamQuality.md | 15 ++++++++++++--- param-docs/parameter-pages/TakeImage/CamRawGma.md | 11 +++++++++-- .../parameter-pages/TakeImage/CamSaturation.md | 9 ++++++--- .../parameter-pages/TakeImage/CamSharpness.md | 13 +++++++++++-- .../parameter-pages/TakeImage/CamSpecialEffect.md | 5 +++-- param-docs/parameter-pages/TakeImage/CamVflip.md | 10 ++++++---- param-docs/parameter-pages/TakeImage/CamWbMode.md | 7 +++++-- param-docs/parameter-pages/TakeImage/CamWpc.md | 10 ++++++---- param-docs/parameter-pages/TakeImage/CamZoom.md | 9 ++++++--- .../parameter-pages/TakeImage/CamZoomOffsetX.md | 12 ++++++++---- .../parameter-pages/TakeImage/CamZoomOffsetY.md | 12 ++++++++---- .../parameter-pages/TakeImage/CamZoomSize.md | 7 ++++--- 30 files changed, 193 insertions(+), 95 deletions(-) diff --git a/param-docs/parameter-pages/TakeImage/CamAeLevel.md b/param-docs/parameter-pages/TakeImage/CamAeLevel.md index 8f562828..4c235b9f 100644 --- a/param-docs/parameter-pages/TakeImage/CamAeLevel.md +++ b/param-docs/parameter-pages/TakeImage/CamAeLevel.md @@ -4,12 +4,13 @@ Default Value: `0` !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! + After changing this parameter you need to update your reference image and alignment markers! + !!! 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! +**Auto Exposure Level** -Auto-Exposure Compensation. Lower values produce darker image. +The exposure offset for automatic exposure, lower values produce darker image. Range (`-2` .. `2`) diff --git a/param-docs/parameter-pages/TakeImage/CamAec.md b/param-docs/parameter-pages/TakeImage/CamAec.md index b6e4712b..3db9f192 100644 --- a/param-docs/parameter-pages/TakeImage/CamAec.md +++ b/param-docs/parameter-pages/TakeImage/CamAec.md @@ -3,11 +3,14 @@ Default Value: `true` !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! + + After changing this parameter you need to update your reference image and alignment markers! !!! 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! +**Auto-Exposure Control** -Auto-Exposure Control Algorithm +When **true**, the camera attempts to automatically control the exposure. + +When **false**, the **CamAecValue** setting is used instead. diff --git a/param-docs/parameter-pages/TakeImage/CamAec2.md b/param-docs/parameter-pages/TakeImage/CamAec2.md index c6b402fb..0d7c929f 100644 --- a/param-docs/parameter-pages/TakeImage/CamAec2.md +++ b/param-docs/parameter-pages/TakeImage/CamAec2.md @@ -1,13 +1,16 @@ # Parameter `CamAec2` -Default Value: `false` +Default Value: `true` !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! + + After changing this parameter you need to update your reference image and alignment markers! !!! 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! +**Auto-Exposure Control 2** -Switch to "Auto-Exposure Control 2" Algorithm. This may resolve some over-exposure and under-exposure issues. +When **true**, the sensor’s "night mode" is enabled, extending the range of automatic gain control. + +This may resolve some over-exposure and under-exposure issues. diff --git a/param-docs/parameter-pages/TakeImage/CamAecValue.md b/param-docs/parameter-pages/TakeImage/CamAecValue.md index e03c3b65..b96d36e7 100644 --- a/param-docs/parameter-pages/TakeImage/CamAecValue.md +++ b/param-docs/parameter-pages/TakeImage/CamAecValue.md @@ -1,15 +1,16 @@ # Parameter `CamAecValue` -Default Value: `0` +Default Value: `160` !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! + + After changing this parameter you need to update your reference image and alignment markers! !!! 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! +**Auto Exposure Value** -set Manuall-Exposure Control Value +Access the exposure value of the camera, higher values produce brighter images. Range (`0` .. `1200`) diff --git a/param-docs/parameter-pages/TakeImage/CamAgc.md b/param-docs/parameter-pages/TakeImage/CamAgc.md index e6c48769..79d21a5d 100644 --- a/param-docs/parameter-pages/TakeImage/CamAgc.md +++ b/param-docs/parameter-pages/TakeImage/CamAgc.md @@ -4,7 +4,10 @@ Default Value: `true` !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! -!!! Note After changing this parameter you need to update your reference image and alignment markers! -This sets the Automatic Gain Control, how the camera responds to the overall level of light in the image. +**Auto Gain** + +When **true**, the camera attempts to automatically control the sensor gain, up to the value in the **CamGainceiling** property. + +When **false**, the **CamAgcGain** setting is used instead. diff --git a/param-docs/parameter-pages/TakeImage/CamAgcGain.md b/param-docs/parameter-pages/TakeImage/CamAgcGain.md index b383dc1e..c43db927 100644 --- a/param-docs/parameter-pages/TakeImage/CamAgcGain.md +++ b/param-docs/parameter-pages/TakeImage/CamAgcGain.md @@ -1,13 +1,16 @@ # Parameter `CamAgcGain` -Default Value: ` ` +Default Value: `15` !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! -!!! Note - After changing this parameter you need to update your reference image and alignment markers! + After changing this parameter you need to update your reference image and alignment markers! !!! Note - This is visible when AGC is off. Gain is an amplification of the values read from the image sensor. + This is used when **CamAgc** is off. + +**Gain Manuall Value** + +Access the gain level of the sensor, higher values produce brighter images. Range (`0` .. `30`) diff --git a/param-docs/parameter-pages/TakeImage/CamAutoSharpness.md b/param-docs/parameter-pages/TakeImage/CamAutoSharpness.md index 48ebfd7b..3b6435c5 100644 --- a/param-docs/parameter-pages/TakeImage/CamAutoSharpness.md +++ b/param-docs/parameter-pages/TakeImage/CamAutoSharpness.md @@ -3,11 +3,15 @@ Default Value: `false` !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! - + + After changing this parameter you need to update your reference image and alignment markers! + !!! 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! - -AutoSharpness + The OV2640 does not officially support auto sharpness, this is an experimental parameter! + +**AutoSharpness** + +When **true**, the camera attempts to automatically adjusts the sharpness. diff --git a/param-docs/parameter-pages/TakeImage/CamAwb.md b/param-docs/parameter-pages/TakeImage/CamAwb.md index 9a5a4143..a85c50af 100644 --- a/param-docs/parameter-pages/TakeImage/CamAwb.md +++ b/param-docs/parameter-pages/TakeImage/CamAwb.md @@ -1,10 +1,13 @@ # Parameter `CamAwb` -Default Value: ` ` +Default Value: `true` !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! -!!! Note - After changing this parameter you need to update your reference image and alignment markers! + After changing this parameter you need to update your reference image and alignment markers! -Auto White Balance +**Auto White Balance** + +When **true**, the camera attempts to automatically control white balance. + +When **false**, the **CamWbMode** setting is used instead. diff --git a/param-docs/parameter-pages/TakeImage/CamAwbGain.md b/param-docs/parameter-pages/TakeImage/CamAwbGain.md index 86e9bb83..4afd4f1a 100644 --- a/param-docs/parameter-pages/TakeImage/CamAwbGain.md +++ b/param-docs/parameter-pages/TakeImage/CamAwbGain.md @@ -4,7 +4,8 @@ Default Value: ` ` !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! -!!! Note After changing this parameter you need to update your reference image and alignment markers! -Auto White Balance Gain +**Auto White Balance Gain** + +Access the **CamAwbGain** property of the camera sensor. diff --git a/param-docs/parameter-pages/TakeImage/CamBpc.md b/param-docs/parameter-pages/TakeImage/CamBpc.md index 1cef3c07..6fc5e582 100644 --- a/param-docs/parameter-pages/TakeImage/CamBpc.md +++ b/param-docs/parameter-pages/TakeImage/CamBpc.md @@ -4,7 +4,8 @@ Default Value: `true` !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! -!!! Note After changing this parameter you need to update your reference image and alignment markers! -Black Pixel Correction +**Black Pixel Correction** + +Enable/Disable **black point compensation**, this can make black parts of the image darker. diff --git a/param-docs/parameter-pages/TakeImage/CamBrightness.md b/param-docs/parameter-pages/TakeImage/CamBrightness.md index 41e6a9d9..955c2b66 100644 --- a/param-docs/parameter-pages/TakeImage/CamBrightness.md +++ b/param-docs/parameter-pages/TakeImage/CamBrightness.md @@ -1,10 +1,14 @@ # Parameter `CamBrightness` Default Value: `0` - + +!!! Warning + After changing this parameter you need to update your reference image and alignment markers! + !!! 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! +**Brightness** -Image Brightness (`-2` .. `2`) +Positive values increase brightness, negative values lower it. + +Range (`-2` .. `2`) diff --git a/param-docs/parameter-pages/TakeImage/CamColorbar.md b/param-docs/parameter-pages/TakeImage/CamColorbar.md index 619e3f70..4658086c 100644 --- a/param-docs/parameter-pages/TakeImage/CamColorbar.md +++ b/param-docs/parameter-pages/TakeImage/CamColorbar.md @@ -1,5 +1,9 @@ # Parameter `CamColorbar` Default Value: `false` -!!! Note - This parameter can also be set on the Reference Image configuration page! +!!! Warning + This is an **Expert Parameter**! Only change it if you understand what it does! + +**Colorbar** + +currently not implemented. diff --git a/param-docs/parameter-pages/TakeImage/CamContrast.md b/param-docs/parameter-pages/TakeImage/CamContrast.md index 941be46a..ddf9b4cc 100644 --- a/param-docs/parameter-pages/TakeImage/CamContrast.md +++ b/param-docs/parameter-pages/TakeImage/CamContrast.md @@ -1,11 +1,14 @@ # Parameter `CamContrast` Default Value: `0` +!!! Warning + After changing this parameter you need to update your reference image and alignment markers! + !!! 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! +**Contrast** -Image Contrast (`-2` .. `2`) +Positive values increase contrast, negative values lower it. +Range (`-2` .. `2`) diff --git a/param-docs/parameter-pages/TakeImage/CamDcw.md b/param-docs/parameter-pages/TakeImage/CamDcw.md index 550380c7..62c27e1b 100644 --- a/param-docs/parameter-pages/TakeImage/CamDcw.md +++ b/param-docs/parameter-pages/TakeImage/CamDcw.md @@ -4,10 +4,15 @@ Default Value: `true` !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! -!!! Note After changing this parameter you need to update your reference image and alignment markers! + + If **CamZoom** is used, this must be activated. !!! Note - When DCW is on, the image that you receive will be the size that you requested (VGA, QQVGA, etc). - When DCW is off, the image that you receive will be one of UXGA, SVGA, or CIF. In other words, literally the actual image size as read from the sensor without any scaling. - Note that if DCW is off, and you pick a different image size, this implicitly turns DCW back on again (although this isn't reflected in the options). + When **CamDcw** is on, the image that you receive will be the size that you requested (VGA, QQVGA, etc). + When **CamDcw** is off, the image that you receive will be one of UXGA, SVGA, or CIF. In other words, literally the actual image size as read from the sensor without any scaling. + Note that if **CamDcw** is off, and you pick a different image size, this implicitly turns **CamDcw** back on again (although this isn't reflected in the options). + +**Downsize** + +Enable/Disable camera image scaling. diff --git a/param-docs/parameter-pages/TakeImage/CamDenoise.md b/param-docs/parameter-pages/TakeImage/CamDenoise.md index 36c0a573..8a454ef1 100644 --- a/param-docs/parameter-pages/TakeImage/CamDenoise.md +++ b/param-docs/parameter-pages/TakeImage/CamDenoise.md @@ -1,10 +1,9 @@ # Parameter `CamDenoise` -Default Value: ` ` +Default Value: `true` !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! -!!! Note - After changing this parameter you need to update your reference image and alignment markers! +**Denoise** -Denoise Image (not supported) +Denoise Image (not supported and not implemented). diff --git a/param-docs/parameter-pages/TakeImage/CamGainceiling.md b/param-docs/parameter-pages/TakeImage/CamGainceiling.md index 479f746f..e715fc6d 100644 --- a/param-docs/parameter-pages/TakeImage/CamGainceiling.md +++ b/param-docs/parameter-pages/TakeImage/CamGainceiling.md @@ -1,14 +1,21 @@ # Parameter `CamGainceiling` -Default Value: `x2` - +Default Value: `x4` + !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! -!!! Note After changing this parameter you need to update your reference image and alignment markers! !!! Note - This is visible when AGC is on. + This is used when **CamAgc** is on. + +**CamGainceiling** + +The **Gain** is an analog multiplier applied to the raw sensor data. + +The **Ceiling** is the maximum gain value that the sensor will use. + +A higher gain means that the sensor has a greater response to light, but also makes sensor noise more visible. Available options: diff --git a/param-docs/parameter-pages/TakeImage/CamHmirror.md b/param-docs/parameter-pages/TakeImage/CamHmirror.md index f8001678..75df11ef 100644 --- a/param-docs/parameter-pages/TakeImage/CamHmirror.md +++ b/param-docs/parameter-pages/TakeImage/CamHmirror.md @@ -1,10 +1,12 @@ # Parameter `CamHmirror` Default Value: `false` - + +!!! Warning + After changing this parameter you need to update your reference image and alignment markers! + !!! 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! +**Mirror Image** -Option for initially mirroring the image on the original x-axis. +When **true**, the camera image is mirrored left-to-right. diff --git a/param-docs/parameter-pages/TakeImage/CamLenc.md b/param-docs/parameter-pages/TakeImage/CamLenc.md index c1f32db5..243c2e6c 100644 --- a/param-docs/parameter-pages/TakeImage/CamLenc.md +++ b/param-docs/parameter-pages/TakeImage/CamLenc.md @@ -4,7 +4,10 @@ Default Value: `true` !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! -!!! Note After changing this parameter you need to update your reference image and alignment markers! -Lens Correction +**Lens Correction** + +Enable/Disable lens correction. + +This can help compensate for light fall-off at the edge of the sensor area. diff --git a/param-docs/parameter-pages/TakeImage/CamQuality.md b/param-docs/parameter-pages/TakeImage/CamQuality.md index 757800ad..b143bc70 100644 --- a/param-docs/parameter-pages/TakeImage/CamQuality.md +++ b/param-docs/parameter-pages/TakeImage/CamQuality.md @@ -1,10 +1,19 @@ # Parameter `CamQuality` -Default Value: `12` +Default Value: `10` !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! -Quality index for pictures: `8` (highest quality) ... `63` (lowest quality) + After changing this parameter you need to update your reference image and alignment markers! !!! Warning - Value below 12 could result in system instabilities! + Value below 10 could result in system instabilities! + +!!! Note + Quality index for pictures: `8` (highest quality) ... `63` (lowest quality) + +**Image Quality** + +The **CamQuality** setting when capturing JPEG images. + +This is similar to the quality setting when exporting a jpeg image from photo editing software. diff --git a/param-docs/parameter-pages/TakeImage/CamRawGma.md b/param-docs/parameter-pages/TakeImage/CamRawGma.md index f98d1ff9..0d3a401f 100644 --- a/param-docs/parameter-pages/TakeImage/CamRawGma.md +++ b/param-docs/parameter-pages/TakeImage/CamRawGma.md @@ -4,7 +4,14 @@ Default Value: ` ` !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! -!!! Note After changing this parameter you need to update your reference image and alignment markers! -RawGma +!!! Note + The main purpose of the Gamma (GMA) function is to compensate for the non-linear characteristics of the sensor. GMA + converts the pixel values according to the Gamma curve to compensate the sensor output under different light strengths. + The non-linear gamma curve is approximately constructed with different linear functions. Raw gamma compensates the + image in the RAW domain. + +**Raw Gamma** + +Enable/Disable raw gamma mode. diff --git a/param-docs/parameter-pages/TakeImage/CamSaturation.md b/param-docs/parameter-pages/TakeImage/CamSaturation.md index ac8511c9..3380e0c5 100644 --- a/param-docs/parameter-pages/TakeImage/CamSaturation.md +++ b/param-docs/parameter-pages/TakeImage/CamSaturation.md @@ -1,11 +1,14 @@ # Parameter `CamSaturation` Default Value: `0` +!!! Warning + After changing this parameter you need to update your reference image and alignment markers! + !!! 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! +**Saturation** -Image Saturation (`-2` .. `2`) +Positive values increase saturation (more vibrant colors), negative values lower it (more muted colors). +Range (`-2` .. `2`) diff --git a/param-docs/parameter-pages/TakeImage/CamSharpness.md b/param-docs/parameter-pages/TakeImage/CamSharpness.md index 290d931b..c590132c 100644 --- a/param-docs/parameter-pages/TakeImage/CamSharpness.md +++ b/param-docs/parameter-pages/TakeImage/CamSharpness.md @@ -3,11 +3,20 @@ Default Value: `0` !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! - + + After changing this parameter you need to update your reference image and alignment markers! + !!! 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! + The OV2640 does not officially support sharpness, this is an experimental parameter! + +!!! Note + This is used when **CamAutoSharpness** is off. + +**Sharpness** + +Positive values increase sharpness (more defined edges), negative values lower it (softer edges). Range (`-2` .. `2`) diff --git a/param-docs/parameter-pages/TakeImage/CamSpecialEffect.md b/param-docs/parameter-pages/TakeImage/CamSpecialEffect.md index 2e48fb02..eb9c992b 100644 --- a/param-docs/parameter-pages/TakeImage/CamSpecialEffect.md +++ b/param-docs/parameter-pages/TakeImage/CamSpecialEffect.md @@ -3,12 +3,13 @@ Default Value: `no_effect` !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! + + After changing this parameter you need to update your reference image and alignment markers! !!! 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! +**SpecialEffect** Available options: diff --git a/param-docs/parameter-pages/TakeImage/CamVflip.md b/param-docs/parameter-pages/TakeImage/CamVflip.md index fccb3022..4b1b2960 100644 --- a/param-docs/parameter-pages/TakeImage/CamVflip.md +++ b/param-docs/parameter-pages/TakeImage/CamVflip.md @@ -1,10 +1,12 @@ # Parameter `CamVflip` Default Value: `false` - + +!!! Warning + After changing this parameter you need to update your reference image and alignment markers! + !!! 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! +**Flip Image** -Option for initially flip the image on the original y-axis. +When **true**, the camera image is flipped top-to-bottom. diff --git a/param-docs/parameter-pages/TakeImage/CamWbMode.md b/param-docs/parameter-pages/TakeImage/CamWbMode.md index a29eae44..64a2a779 100644 --- a/param-docs/parameter-pages/TakeImage/CamWbMode.md +++ b/param-docs/parameter-pages/TakeImage/CamWbMode.md @@ -1,13 +1,16 @@ # Parameter `CamWbMode` Default Value: `auto` +!!! Warning + After changing this parameter you need to update your reference image and alignment markers! + !!! 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! + This is used when **CamAwb** is off. -White Balance Mode +**White Balance Mode** Available options: diff --git a/param-docs/parameter-pages/TakeImage/CamWpc.md b/param-docs/parameter-pages/TakeImage/CamWpc.md index bf1d5741..93e0d769 100644 --- a/param-docs/parameter-pages/TakeImage/CamWpc.md +++ b/param-docs/parameter-pages/TakeImage/CamWpc.md @@ -1,10 +1,12 @@ # Parameter `CamWpc` Default Value: `true` - + +!!! Warning + After changing this parameter you need to update your reference image and alignment markers! + !!! 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! +**White Pixel Correction** -White Pixel Correction +Enable/Disable **white point compensation**, his can make white parts of the image whiter. diff --git a/param-docs/parameter-pages/TakeImage/CamZoom.md b/param-docs/parameter-pages/TakeImage/CamZoom.md index 4f41f4a0..f53009a5 100644 --- a/param-docs/parameter-pages/TakeImage/CamZoom.md +++ b/param-docs/parameter-pages/TakeImage/CamZoom.md @@ -4,10 +4,13 @@ Default Value: `false` !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! + After changing this parameter you need to update your reference image and alignment markers! + !!! 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! +**Zoom** -Crop the camera sensor frame to `ImageSize` resolution instead of scaling it down. +Enable/Disable digital zoom. + +It is always zoomed into the center of the image, if **CamZoomOffsetX** and **CamZoomOffsetY** are zero. diff --git a/param-docs/parameter-pages/TakeImage/CamZoomOffsetX.md b/param-docs/parameter-pages/TakeImage/CamZoomOffsetX.md index 1d8d4605..dc1d0f7b 100644 --- a/param-docs/parameter-pages/TakeImage/CamZoomOffsetX.md +++ b/param-docs/parameter-pages/TakeImage/CamZoomOffsetX.md @@ -4,11 +4,15 @@ Default Value: `0` !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! + After changing this parameter you need to update your reference image and alignment markers! + !!! 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! +**Zoom Offset X** -`ZoomOffsetX` only applies when `Zoom` is enabled. -X coordinate of the crop location within the camera sensor frame. +X displacement of the image from the center. + +Positive values ​​shift the image to the right, negative values ​​to the left. + +The maximum possible offset depends on the value of the **CamZoomSize**. diff --git a/param-docs/parameter-pages/TakeImage/CamZoomOffsetY.md b/param-docs/parameter-pages/TakeImage/CamZoomOffsetY.md index 6ea68809..b5745f86 100644 --- a/param-docs/parameter-pages/TakeImage/CamZoomOffsetY.md +++ b/param-docs/parameter-pages/TakeImage/CamZoomOffsetY.md @@ -4,11 +4,15 @@ Default Value: `0` !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! + After changing this parameter you need to update your reference image and alignment markers! + !!! 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! +**Zoom Offset Y** -`ZoomOffsetY` only applies when `Zoom` is enabled. -Y coordinate of the crop location within the camera sensor frame. +Y displacement of the image from the center. + +Positive values ​​move the image up, negative values ​​move the image down. + +The maximum possible offset depends on the value of the **CamZoomSize**. diff --git a/param-docs/parameter-pages/TakeImage/CamZoomSize.md b/param-docs/parameter-pages/TakeImage/CamZoomSize.md index 809e59b2..d86f051c 100644 --- a/param-docs/parameter-pages/TakeImage/CamZoomSize.md +++ b/param-docs/parameter-pages/TakeImage/CamZoomSize.md @@ -4,10 +4,11 @@ Default Value: `0` !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! + After changing this parameter you need to update your reference image and alignment markers! + !!! 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! +**Zoom Size** -`CamZoomSize` only applies when `Zoom` is enabled. +Zoom factor/level of the digital zoom, the larger the value, the more it zooms in.