CamParameter documentation update

https://github.com/jomjol/AI-on-the-edge-device/issues/3185
This commit is contained in:
michael
2024-08-19 00:42:33 +02:00
committed by GitHub
parent 20980b2bcd
commit cb3f082218
30 changed files with 193 additions and 95 deletions

View File

@@ -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`)

View File

@@ -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.

View File

@@ -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 sensors "night mode" is enabled, extending the range of automatic gain control.
This may resolve some over-exposure and under-exposure issues.

View File

@@ -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`)

View File

@@ -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.

View File

@@ -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`)

View File

@@ -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.

View File

@@ -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.

View File

@@ -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.

View File

@@ -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.

View File

@@ -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`)

View File

@@ -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.

View File

@@ -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`)

View File

@@ -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.

View File

@@ -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).

View File

@@ -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:

View File

@@ -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.

View File

@@ -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.

View File

@@ -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.

View File

@@ -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.

View File

@@ -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`)

View File

@@ -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`)

View File

@@ -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:

View File

@@ -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.

View File

@@ -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:

View File

@@ -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.

View File

@@ -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.

View File

@@ -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**.

View File

@@ -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**.

View File

@@ -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.