Add Gaussian filtering tutorial

README.md

@@ -1,5 +1,5 @@
-# diptorch
-
+diptorch
+================
 
 <!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
 
@@ -8,3 +8,66 @@
 ``` sh
 pip install diptorch
 ```
+
+## Hello, World!
+
+``` python
+import matplotlib.pyplot as plt
+
+from diptorch.filters import gaussian_filter
+from diptorch.utils import astronaut
+```
+
+``` python
+# Zero-th order Gaussian filter (smoothing)
+img = astronaut()
+img_filtered = gaussian_filter(img, sigma=2.5)
+
+plt.figure(figsize=(6, 3))
+plt.subplot(121)
+plt.imshow(img.squeeze(), cmap="gray")
+plt.axis("off")
+plt.subplot(122)
+plt.imshow(img_filtered.squeeze(), cmap="gray")
+plt.axis("off")
+plt.tight_layout()
+plt.show()
+```
+
+![](index_files/figure-commonmark/cell-3-output-1.png)
+
+``` python
+# First-order Gaussian filter
+img = astronaut()
+img_filtered = gaussian_filter(img, sigma=2.5, order=1)
+
+plt.figure(figsize=(6, 3))
+plt.subplot(121)
+plt.imshow(img.squeeze(), cmap="gray")
+plt.axis("off")
+plt.subplot(122)
+plt.imshow(img_filtered.squeeze(), cmap="gray")
+plt.axis("off")
+plt.tight_layout()
+plt.show()
+```
+
+![](index_files/figure-commonmark/cell-4-output-1.png)
+
+``` python
+# Second-order Gaussian filter on the height dimension (y-axis)
+img = astronaut()
+img_filtered = gaussian_filter(img, sigma=2.5, order=[2, 0])
+
+plt.figure(figsize=(6, 3))
+plt.subplot(121)
+plt.imshow(img.squeeze(), cmap="gray")
+plt.axis("off")
+plt.subplot(122)
+plt.imshow(img_filtered.squeeze(), cmap="gray")
+plt.axis("off")
+plt.tight_layout()
+plt.show()
+```
+
+![](index_files/figure-commonmark/cell-5-output-1.png)