Update readme.

bukalapak · Aug 23, 2018 · 1af61a7 · 1af61a7
1 parent cbd40ef
commit 1af61a7
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -9,9 +9,34 @@ The package is in PyPI so you can install it simply by this command:
 
 ```pip install --process-dependency-links pybrisque```
 
+## Usage
+Initialize once:
+```
+brisq = BRISQUE()
+```
+and get the BRISQUE feature or score many times:
+```
+brisq.get_feature('/path')
+brisq.get_feature('/image_path')
+```
+
+
 ## Limitations
 This implementation is heavily adopted from the original Matlab 
 implementation in [here](https://github.com/dsoellinger/blind_image_quality_toolbox/tree/master/%2Bbrisque). There is one catch though, the bicubic interpolation when resizing image in 
 Matlab and OpenCV is a bit different as explained in [here](https://stackoverflow.com/questions/26823140/imresize-trying-to-understand-the-bicubic-interpolation). For now, it uses ```nearest``` interpolation 
 which gives the most similar output with the original implementation.
 
+Comparing with Matlab original implementation on reference images of TID 2008: 
+
+![Comparison](examples/comparison.png)
+
+And the absolute differences' stat is as follows: 
+```
+{'min': 0.17222238726479588,
+ 'max': 16.544924728934404,
+ 'mean': 3.9994322498322754,
+ 'std': 3.0715344507521416}
+```
+
+
diff --git a/REQUIREMENTS.txt b/REQUIREMENTS.txt
@@ -1,4 +1,4 @@
 numpy
 scipy
-opencv-python
+opencv-python-headless
 -e git+https://github.com/Salinger/libsvm-python.git#egg=libsvm-python
diff --git a/examples/comparison.png b/examples/comparison.png