From c62cea89cebf85b5ecddd50e6f4a805eb5252e20 Mon Sep 17 00:00:00 2001 From: Eino-Ville Talvala Date: Thu, 2 Jun 2016 14:21:27 -0700 Subject: Camera2: Update lensShadingMap documentation Revert added language about shading map being the full flat-field correction; it's actually the same correction as applied to camera device-processed data. Also fix a few other wording issues in the lens shading documentation. Bug: 18175853 Change-Id: I27691925e6496afe18f3506084d89f2523b5555d --- .../android/hardware/camera2/CaptureResult.java | 53 ++++++++++++++-------- 1 file changed, 33 insertions(+), 20 deletions(-) diff --git a/core/java/android/hardware/camera2/CaptureResult.java b/core/java/android/hardware/camera2/CaptureResult.java index f9049dbd5fce..23f4b9e6ce06 100644 --- a/core/java/android/hardware/camera2/CaptureResult.java +++ b/core/java/android/hardware/camera2/CaptureResult.java @@ -3547,10 +3547,21 @@ public class CaptureResult extends CameraMetadata> { *

The shading map is a low-resolution floating-point map * that lists the coefficients used to correct for vignetting, for each * Bayer color channel.

- *

The least shaded section of the image should have a gain factor - * of 1; all other sections should have gains above 1.

+ *

The map provided here is the same map that is used by the camera device to + * correct both color shading and vignetting for output non-RAW images.

+ *

When there is no lens shading correction applied to RAW + * output images ({@link CameraCharacteristics#SENSOR_INFO_LENS_SHADING_APPLIED android.sensor.info.lensShadingApplied} == + * false), this map is the complete lens shading correction + * map; when there is some lens shading correction applied to + * the RAW output image ({@link CameraCharacteristics#SENSOR_INFO_LENS_SHADING_APPLIED android.sensor.info.lensShadingApplied}== true), this map reports the remaining lens shading + * correction map that needs to be applied to get shading + * corrected images that match the camera device's output for + * non-RAW formats.

+ *

For a complete shading correction map, the least shaded + * section of the image will have a gain factor of 1; all + * other sections will have gains above 1.

*

When {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} = TRANSFORM_MATRIX, the map - * must take into account the colorCorrection settings.

+ * will take into account the colorCorrection settings.

*

The shading map is for the entire active pixel array, and is not * affected by the crop region specified in the request. Each shading map * entry is the value of the shading compensation map over a specific @@ -3562,8 +3573,8 @@ public class CaptureResult extends CameraMetadata> { *

The channel order is [R, Geven, Godd, B], where Geven is the green * channel for the even rows of a Bayer pattern, and Godd is the odd rows. * The shading map is stored in a fully interleaved format.

- *

The shading map should have on the order of 30-40 rows and columns, - * and must be smaller than 64x64.

+ *

The shading map will generally have on the order of 30-40 rows and columns, + * and will be smaller than 64x64.

*

As an example, given a very small map defined as:

* 
width,height = [ 4, 3 ]
      * values =
@@ -3592,6 +3603,7 @@ public class CaptureResult extends CameraMetadata> {
      *
      * @see CaptureRequest#COLOR_CORRECTION_MODE
      * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
+     * @see CameraCharacteristics#SENSOR_INFO_LENS_SHADING_APPLIED
      */
     @PublicKey
     public static final Key STATISTICS_LENS_SHADING_CORRECTION_MAP =
@@ -3601,20 +3613,21 @@ public class CaptureResult extends CameraMetadata> {
      * 
The shading map is a low-resolution floating-point map
      * that lists the coefficients used to correct for vignetting and color shading,
      * for each Bayer color channel of RAW image data.

-     * 
The lens shading correction is defined as a full shading correction that
-     * corrects both color shading for the output non-RAW images. After the
-     * shading map is applied, the output non-RAW images will be flat-field images
-     * for flat scenes under uniform illumination.

-     * 
When there is no lens shading correction applied to RAW output images
-     * ({@link CameraCharacteristics#SENSOR_INFO_LENS_SHADING_APPLIED android.sensor.info.lensShadingApplied} == false), this map is a full lens
-     * shading correction map; when there is some lens shading correction applied
-     * to the RAW output image ({@link CameraCharacteristics#SENSOR_INFO_LENS_SHADING_APPLIED android.sensor.info.lensShadingApplied} == true),
-     * this map reports the remaining lens shading correction map that needs to be
-     * applied to get fully shading corrected images.

-     * 
For a full shading correction map, the least shaded section of the image
-     * should have a gain factor of 1; all other sections should have gains above 1.

+     * 
The map provided here is the same map that is used by the camera device to
+     * correct both color shading and vignetting for output non-RAW images.

+     * 
When there is no lens shading correction applied to RAW
+     * output images ({@link CameraCharacteristics#SENSOR_INFO_LENS_SHADING_APPLIED android.sensor.info.lensShadingApplied} ==
+     * false), this map is the complete lens shading correction
+     * map; when there is some lens shading correction applied to
+     * the RAW output image ({@link CameraCharacteristics#SENSOR_INFO_LENS_SHADING_APPLIED android.sensor.info.lensShadingApplied}== true), this map reports the remaining lens shading
+     * correction map that needs to be applied to get shading
+     * corrected images that match the camera device's output for
+     * non-RAW formats.

+     * 
For a complete shading correction map, the least shaded
+     * section of the image will have a gain factor of 1; all
+     * other sections will have gains above 1.

      * 
When {@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} = TRANSFORM_MATRIX, the map
-     * must take into account the colorCorrection settings.

+     * will take into account the colorCorrection settings.

      * 
The shading map is for the entire active pixel array, and is not
      * affected by the crop region specified in the request. Each shading map
      * entry is the value of the shading compensation map over a specific
@@ -3627,8 +3640,8 @@ public class CaptureResult extends CameraMetadata> {
      * channel for the even rows of a Bayer pattern, and Godd is the odd rows.
      * The shading map is stored in a fully interleaved format, and its size
      * is provided in the camera static metadata by android.lens.info.shadingMapSize.

-     * 
The shading map should have on the order of 30-40 rows and columns,
-     * and must be smaller than 64x64.

+     * 
The shading map will generally have on the order of 30-40 rows and columns,
+     * and will be smaller than 64x64.

      * 
As an example, given a very small map defined as:

      * 
android.lens.info.shadingMapSize = [ 4, 3 ]
      * android.statistics.lensShadingMap =
-- 
cgit v1.2.3-59-g8ed1b