Update readme

dnjulek · Jul 24, 2022 · 18bf415 · 18bf415
1 parent 6d1db03
commit 18bf415
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -9,8 +9,34 @@ ehist.EqualizeHist(vnode clip)
 ### Parameters:
 
 - clip\
-    A clip to process. 8-bit integer only.
+    A clip to process. 8-16 bit integer only.
 
-### Example
-![src](./assets/src.jpg)
-![equalizehist](./assets/ehist.jpg)
+## CLAHE
+
+[Contrast Limited Adaptive Histogram Equalization](https://docs.opencv.org/5.x/d5/daf/tutorial_py_histogram_equalization.html) for Vapoursynth.\
+This filter uses OpenCV internally because I don't know how to do tiles in VS (please send help).
+
+### Usage
+```python
+ehist.CLAHE(vnode clip[, float limit=7, int tile=3])
+```
+### Parameters:
+
+- clip\
+    A clip to process. 8-16 bit integer only.
+- limit\
+    Threshold for contrast limiting.\
+    For the 16 bit clip to have the same result as the 8 bit clip you have to multiply the limit by 256.
+- tile\
+    Tile size for histogram equalization.
+
+## Example
+
+### Luma 16 bit
+![src](./assets/luma-16bit.jpg)
+
+### EqualizeHist 16 bit
+![equalizehist](./assets/EqualizeHist-16bit.jpg)
+
+### CLAHE(limit=15.0, tile=3) 16 bit
+![CLAHE](./assets/CLAHE-16bit.jpg)
diff --git a/assets/CLAHE-16bit.jpg b/assets/CLAHE-16bit.jpg
diff --git a/assets/EqualizeHist-16bit.jpg b/assets/EqualizeHist-16bit.jpg
diff --git a/assets/ehist.jpg b/assets/ehist.jpg
diff --git a/assets/luma-16bit.jpg b/assets/luma-16bit.jpg
diff --git a/assets/src.jpg b/assets/src.jpg