improve README.md

valgur · Mar 29, 2020 · c4c11c5 · c4c11c5
1 parent d7a6b18
commit c4c11c5
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -14,9 +14,10 @@ python setup.py install
 
 ## Usage
 
-Takes a depth image with pixel values as depth in meters
-(the format used by the [KITTI depth completion dataset](http://www.cvlibs.net/datasets/kitti/eval_depth.php?benchmark=depth_completion))
+Takes a depth image (such as the ones provided with the [KITTI depth completion dataset](http://www.cvlibs.net/datasets/kitti/eval_depth.php?benchmark=depth_completion))
 as input and outputs estimated normals as an RGB image.
+The scale of the input depth does not matter because
+the `max_rel_depth_diff` threshold applied to exclude distant neighboring pixels uses relative depth values.
 
 ```python
 from surface_normal import normals_from_depth
@@ -32,6 +33,13 @@ normals_from_depth("depth.png", "normals.png",
 )
 ```
 
+### Depth input
+
+![depth](depth.png)
+
+### Normals output
+![normals](normals.png)
+
 ## Citation
 If you use our code or method in your work, please cite the following:  
 ```

diff --git a/depth.png b/depth.png
diff --git a/normals.png b/normals.png