updated readme and comments

shengtanmao · Dec 20, 2020 · de15dbe · de15dbe
1 parent 93888c9
commit de15dbe
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -8,11 +8,10 @@
 A Python library that provides algorithms for upscaling images.
 
 ## Features
-This library provides numerous super-sampling algorithm:
-  - grid algorithm in uniform distribution
-
-This library provides numerous filtering algorithm:
-  - (to be added)
+This library provides image scaling algorithm:
+  - Nearest-neighbor interpolation
+  - Bilinear interpolation
+  - Bicubic interpolation
 
 ## Installation
 1. Download the repository.

diff --git a/antialiasing/src/supersampling/uniform_grid.py b/antialiasing/src/supersampling/uniform_grid.py
@@ -10,6 +10,7 @@ def unif_grid(array, factor):
     Scales an image by a factor using uniform using the grid algorithm in
     uniform distribution.
     Note: the result is significantly worse for non-integer factors.
+    (Nearest-neighbor interpolation)
 
     :param array: a numpy array representing the image
     :type file: ndarray

diff --git a/antialiasing/src/supersampling/uniform_grid_2.py b/antialiasing/src/supersampling/uniform_grid_2.py
@@ -10,6 +10,7 @@ def unif_grid_2(array, factor):
     """
     Scales an image by a factor using uniform using the grid algorithm in
     uniform distribution.
+    (Bilinear interpolation)
 
     :param array: a numpy array representing the image
     :type file: ndarray