CameraITS: Correct an out-of-date doc comment in its.image.
The comment (which is visible as docs when running pydoc) was
stale and no longer correct.
Bug: 18401417
Change-Id: Ie47aaef3a09d73be9296ddbce62870f4bbd65246
diff --git a/apps/CameraITS/pymodules/its/image.py b/apps/CameraITS/pymodules/its/image.py
index f2425e1..e2d521a 100644
--- a/apps/CameraITS/pymodules/its/image.py
+++ b/apps/CameraITS/pymodules/its/image.py
@@ -561,22 +561,19 @@
* Standard color checker chart with standard-sized black borders.
The values returned are in the coordinate system of the chart; that is,
- the "origin" patch is the brown patch that is in the chart's top-left
- corner when it is in the normal upright/horizontal orientation. (The chart
- may be any of the four main orientations in the image.)
-
- The chart is 6x4 patches in the normal upright orientation. The return
- values of this function are the center coordinate of the top-left patch,
- and the displacement vectors to the next patches to the right and below
- the top-left patch. From these pieces of data, the center coordinates of
- any of the patches can be computed.
+ patch (0,0) is the brown patch that is in the chart's top-left corner when
+ it is in the normal upright/horizontal orientation. (The chart may be any
+ of the four main orientations in the image.)
Args:
img: Input image, as a numpy array with pixels in [0,1].
debug_fname_prefix: If not None, the (string) name of a file prefix to
use to save a number of debug images for visualizing the output of
this function; can be used to see if the patches are being found
- successfully.
+ successfully. If this argument is provided, then some of the sanity
+ check assertions will be disabled to allow the function to provide
+ useful debugging information, meaning that garbage data may be
+ returned.
Returns:
6x4 list of lists of integer (x,y) coords of the center of each patch,
